Skip to main content
Version: v7 Alpha

Interface: VideoViewProps

Defined in: video-view/VideoView.tsx:15

Extends​

Properties​

autoEnterPictureInPicture?​

optional autoEnterPictureInPicture: boolean;

Defined in: video-view/VideoView.tsx:35

Whether to automatically enter picture in picture mode when the video is playing. Defaults to false.

controls?​

optional controls: boolean;

Defined in: video-view/VideoView.tsx:27

Whether to show the controls. Defaults to false.

keepScreenAwake?​

optional keepScreenAwake: boolean;

Defined in: video-view/VideoView.tsx:47

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:110

Called when the video view's fullscreen state changes.

Parameters​

ParameterTypeDescription
fullscreenbooleanWhether the video view is in fullscreen mode.

Returns​

void

Inherited from​

Partial.onFullscreenChange

onPictureInPictureChange()?​

optional onPictureInPictureChange: (isInPictureInPicture) => void;

Defined in: types/Events.ts:105

Called when the video view's picture in picture state changes.

Parameters​

ParameterTypeDescription
isInPictureInPicturebooleanWhether the video view is in picture in picture mode.

Returns​

void

Inherited from​

Partial.onPictureInPictureChange

pictureInPicture?​

optional pictureInPicture: boolean;

Defined in: video-view/VideoView.tsx:31

Whether to enable & show the picture in picture button in native controls. Defaults to false.

player​

player: VideoPlayer;

Defined in: video-view/VideoView.tsx:19

The player to play the video - VideoPlayer

resizeMode?​

optional resizeMode: ResizeMode;

Defined in: video-view/VideoView.tsx:43

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/VideoView.tsx:23

The style of the video view - ViewStyle

Overrides​

ViewProps.style

surfaceType?​

optional surfaceType: SurfaceType;

Defined in: video-view/VideoView.tsx:59

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:114

Called when the video view will enter fullscreen mode.

Returns​

void

Inherited from​

Partial.willEnterFullscreen

willEnterPictureInPicture()?​

optional willEnterPictureInPicture: () => void;

Defined in: types/Events.ts:122

Called when the video view will enter picture in picture mode.

Returns​

void

Inherited from​

Partial.willEnterPictureInPicture

willExitFullscreen()?​

optional willExitFullscreen: () => void;

Defined in: types/Events.ts:118

Called when the video view will exit fullscreen mode.

Returns​

void

Inherited from​

Partial.willExitFullscreen

willExitPictureInPicture()?​

optional willExitPictureInPicture: () => void;

Defined in: types/Events.ts:126

Called when the video view will exit picture in picture mode.

Returns​

void

Inherited from​

Partial.willExitPictureInPicture
We are TheWidlarzGroupPremium support →
We are TheWidlarzGroupPremium support →