Interface: VideoViewProps
Defined in: video-view/VideoViewProps.ts:8
Extends
Partial<VideoViewEvents>.ViewProps
Properties
autoEnterPictureInPicture?
optional autoEnterPictureInPicture?: boolean;
Defined in: video-view/VideoViewProps.ts:28
Whether to automatically enter picture in picture mode when the video is playing. Defaults to false.
controls?
optional controls?: boolean;
Defined in: video-view/VideoViewProps.ts:20
Whether to show the controls. Defaults to false.
keepScreenAwake?
optional keepScreenAwake?: boolean;
Defined in: video-view/VideoViewProps.ts:40
Whether to keep the screen awake while the video view is mounted. Defaults to true.
onFullscreenChange?
optional onFullscreenChange?: (fullscreen) => void;
Defined in: types/Events.ts:116
Called when the video view's fullscreen state changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
fullscreen | boolean | Whether the video view is in fullscreen mode. |
Returns
void
Inherited from
VideoViewEvents.onFullscreenChange
onPictureInPictureChange?
optional onPictureInPictureChange?: (isInPictureInPicture) => void;
Defined in: types/Events.ts:111
Called when the video view's picture in picture state changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
isInPictureInPicture | boolean | Whether the video view is in picture in picture mode. |
Returns
void
Inherited from
VideoViewEvents.onPictureInPictureChange
pictureInPicture?
optional pictureInPicture?: boolean;
Defined in: video-view/VideoViewProps.ts:24
Whether to enable & show the picture in picture button in native controls. Defaults to false.
player
player: VideoPlayerBase;
Defined in: video-view/VideoViewProps.ts:12
The player to play the video
resizeMode?
optional resizeMode?: ResizeMode;
Defined in: video-view/VideoViewProps.ts:36
How the video should be resized to fit the view. Defaults to 'none'.
- 'contain': Scale the video uniformly (maintain aspect ratio) so that it fits entirely within the view
- 'cover': Scale the video uniformly (maintain aspect ratio) so that it fills the entire view (may crop)
- 'stretch': Scale the video to fill the entire view without maintaining aspect ratio
- 'none': Do not resize the video
style?
optional style?: ViewStyle;
Defined in: video-view/VideoViewProps.ts:16
The style of the video view - ViewStyle
Overrides
ViewProps.style
surfaceType?
optional surfaceType?: SurfaceType;
Defined in: video-view/VideoViewProps.ts:52
The type of underlying native view. Defaults to 'surface'.
- 'surface': Uses a SurfaceView on Android. More performant, but cannot be animated or transformed.
- 'texture': Uses a TextureView on Android. Less performant, but can be animated and transformed.
Only applicable on Android
Default
'surface'
Platform
android
willEnterFullscreen?
optional willEnterFullscreen?: () => void;
Defined in: types/Events.ts:120
Called when the video view will enter fullscreen mode.
Returns
void
Inherited from
VideoViewEvents.willEnterFullscreen
willEnterPictureInPicture?
optional willEnterPictureInPicture?: () => void;
Defined in: types/Events.ts:128
Called when the video view will enter picture in picture mode.
Returns
void
Inherited from
VideoViewEvents.willEnterPictureInPicture
willExitFullscreen?
optional willExitFullscreen?: () => void;
Defined in: types/Events.ts:124
Called when the video view will exit fullscreen mode.
Returns
void
Inherited from
VideoViewEvents.willExitFullscreen
willExitPictureInPicture?
optional willExitPictureInPicture?: () => void;
Defined in: types/Events.ts:132
Called when the video view will exit picture in picture mode.
Returns
void