expo-video/src/VideoView.types.ts

A cross-platform, performant video component for React Native and Expo with Web support

import type { ViewProps } from 'react-native';

import type { VideoPlayer } from './VideoPlayer.types';

/**
 * Describes how a video should be scaled to fit in a container.
 * - `contain`: The video maintains its aspect ratio and fits inside the container, with possible letterboxing/pillarboxing.
 * - `cover`: The video maintains its aspect ratio and covers the entire container, potentially cropping some portions.
 * - `fill`: The video stretches/squeezes to completely fill the container, potentially causing distortion.
 */
export type VideoContentFit = 'contain' | 'cover' | 'fill';

/**
 * Describes the type of the surface used to render the video.
 * - `surfaceView`: Uses the `SurfaceView` to render the video. This value should be used in the majority of cases. Provides significantly lower power consumption, better performance, and more features.
 * - `textureView`: Uses the `TextureView` to render the video. Should be used in cases where the SurfaceView is not supported or causes issues (for example, overlapping video views).
 *
 * You can learn more about surface types in the official [ExoPlayer documentation](https://developer.android.com/media/media3/ui/playerview#surfacetype).
 * @platform android
 */
export type SurfaceType = 'textureView' | 'surfaceView';

export interface VideoViewProps extends ViewProps {
  /**
   * A video player instance. Use [`useVideoPlayer()`](#usevideoplayersource-setup) hook to create one.
   */
  player?: VideoPlayer | null;

  /**
   * Determines whether native controls should be displayed or not.
   *
   * > **Note**: Due to platform limitations, the native controls are always enabled in fullscreen mode.
   * @default true
   */
  nativeControls?: boolean;

  /**
   * Describes how the video should be scaled to fit in the container.
   * Options are `'contain'`, `'cover'`, and `'fill'`.
   * @default 'contain'
   */
  contentFit?: VideoContentFit;

  /**
   * Determines the fullscreen mode options.
   */
  fullscreenOptions?: FullscreenOptions;

  /**
   * Determines whether the timecodes should be displayed or not.
   * @default true
   * @platform ios
   */
  showsTimecodes?: boolean;

  /**
   * Determines whether the player allows the user to skip media content.
   * @default false
   * @platform android
   * @platform ios
   */
  requiresLinearPlayback?: boolean;

  /**
   * Configuration for controlling the visibility of player control buttons.
   * @platform android
   */
  buttonOptions?: ButtonOptions;

  /**
   * Determines the type of the surface used to render the video.
   * > This prop should not be changed at runtime.
   * @default 'surfaceView'
   * @platform android
   */
  surfaceType?: SurfaceType;

  /**
   * Determines the position offset of the video inside the container.
   * @default { dx: 0, dy: 0 }
   * @platform ios
   */
  contentPosition?: { dx?: number; dy?: number };

  /**
   * A callback to call after the video player enters Picture in Picture (PiP) mode.
   * @platform android
   * @platform ios
   * @platform web
   */
  onPictureInPictureStart?: () => void;

  /**
   * A callback to call after the video player exits Picture in Picture (PiP) mode.
   * @platform android
   * @platform ios
   * @platform web
   */
  onPictureInPictureStop?: () => void;

  /**
   * Determines whether the player allows Picture in Picture (PiP) mode.
   * > **Note:** The `supportsPictureInPicture` property of the [config plugin](#configuration-in-app-config)
   * > has to be configured for the PiP to work.
   * @platform android
   * @platform ios
   * @platform web
   */
  allowsPictureInPicture?: boolean;

  /**
   * Determines whether a video should be played "inline", that is, within the element's playback area.
   * @platform web
   */
  playsInline?: boolean;

  /**
   * Determines whether the player should start Picture in Picture (PiP) automatically when the app is in the background.
   * > **Note:** Only one player can be in Picture in Picture (PiP) mode at a time.
   *
   * > **Note:** The `supportsPictureInPicture` property of the [config plugin](#configuration-in-app-config)
   * > has to be configured for the PiP to work.
   *
   * @default false
   * @platform android 12+
   * @platform ios
   */
  startsPictureInPictureAutomatically?: boolean;

  /**
   * Specifies whether to perform video frame analysis (Live Text in videos).
   * Check official [Apple documentation](https://developer.apple.com/documentation/avkit/avplayerviewcontroller/allowsvideoframeanalysis) for more details.
   * @default true
   * @platform ios 16.0+
   */
  allowsVideoFrameAnalysis?: boolean;

  /**
   * A callback to call after the video player enters fullscreen mode.
   */
  onFullscreenEnter?: () => void;

  /**
   * A callback to call after the video player exits fullscreen mode.
   */
  onFullscreenExit?: () => void;

  /**
   * A callback to call after the mounted `VideoPlayer` has rendered the first frame into the `VideoView`.
   * This event can be used to hide any cover images that conceal the initial loading of the player.
   * > **Note:** This event may also be called during playback when the current video track changes (for example when the player switches video quality).
   */
  onFirstFrameRender?: () => void;

  /**
   * Determines whether the player should use the default ExoPlayer shutter that covers the `VideoView` before the first video frame is rendered.
   * Setting this property to `false` makes the Android behavior the same as iOS.
   *
   * @platform android
   * @default false
   */
  useExoShutter?: boolean;

  /**
   * Determines the [cross origin policy](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/crossorigin) used by the underlying native view on web.
   * If `undefined` (default), does not use CORS at all. If set to `'anonymous'`, the video will be loaded with CORS enabled.
   * Note that some videos may not play if CORS is enabled, depending on the CDN settings.
   * If you encounter issues, consider adjusting the `crossOrigin` property.
   *
   *
   * @platform web
   * @default undefined
   */
  crossOrigin?: 'anonymous' | 'use-credentials';

  /**
   * Use Audio Nodes for sound playback. When the same player is playing in multiple video views the audio won't increase in volume
   * as the number of players increases.
   *
   * > **Note**: This property is experimental, when enabled it is known to break audio for some sources. Do not change this property at runtime.
   *
   * @experimental
   * @default false
   * @platform web
   */
  useAudioNodePlayback?: boolean;
}

/**
 * Configuration for controlling the visibility of player control buttons.
 *
 * > The fullscreen button should be controlled with [`fullscreenOptions.enable`](#fullscreenoptions).
 *
 * @platform android
 */
export type ButtonOptions = {
  /**
   * Whether to show the next button.
   * @default false
   */
  showNext?: boolean;
  /**
   * Whether to show the previous button.
   * @default false
   */
  showPrevious?: boolean;
  /**
   * Whether to show the seek forward button.
   * @default true
   */
  showSeekForward?: boolean;
  /**
   * Whether to show the seek backward button.
   * @default true
   */
  showSeekBackward?: boolean;
  /**
   * Whether to show the subtitles button.
   * - `true`: Button is always visible
   * - `false`: Button is never visible
   * - `undefined`: Button is visible only when subtitles are available (default behavior)
   * @default undefined
   */
  showSubtitles?: boolean | null;
  /**
   * Whether to show the settings button.
   * @default true
   */
  showSettings?: boolean;
  /**
   * Whether to show the play/pause button.
   * @default true
   */
  showPlayPause?: boolean;
  /**
   * Whether to show the bottom control bar (containing time, progress bar, and buttons).
   * When set to `false`, the entire bottom bar including the progress bar will be hidden.
   *
   * > **Note**: The bottom bar is always visible in fullscreen mode to allow users to exit fullscreen.
   *
   * @default true
   */
  showBottomBar?: boolean;
};

/**
 * Describes the orientation of the video in fullscreen mode. Available values are:
 * - `default`: The video is displayed in any of the available device rotations.
 * - `portrait`: The video is displayed in one of two available portrait orientations and rotates between them.
 * - `portraitUp`: The video is displayed in the portrait orientation - the notch of the phone points upwards.
 * - `portraitDown`: The video is displayed in the portrait orientation - the notch of the phone points downwards.
 * - `landscape`: The video is displayed in one of two available landscape orientations and rotates between them.
 * - `landscapeLeft`: The video is displayed in the left landscape orientation - the notch of the phone is in the left palm of the user.
 * - `landscapeRight`: The video is displayed in the right landscape orientation - the notch of the phone is in the right palm of the user.
 */
export type FullscreenOrientation =
  | 'default'
  | 'portrait'
  | 'portraitUp'
  | 'portraitDown'
  | 'landscape'
  | 'landscapeLeft'
  | 'landscapeRight';

/**
 * Determines whether the player keeps fullscreen when Picture in Picture (PiP) stops.
 * Only has an effect if the player was in fullscreen when PiP started.
 * - `'always'`: Always re-enter fullscreen when PiP stops.
 * - `'autoEnter'`: Re-enter fullscreen only when PiP was started automatically by the app going to the background.
 * - `'never'`: Do not re-enter fullscreen when PiP stops.
 */
export type KeepFullscreenOnPiPStopBehavior = 'always' | 'autoEnter' | 'never';

/**
 * Describes the options for fullscreen video mode.
 */
export type FullscreenOptions = {
  /**
   * Specifies whether the fullscreen mode should be available to the user. When `false`, the fullscreen button will be hidden in the player.
   * @default true
   */
  enable: boolean;
  /**
   * Specifies the orientation of the video in fullscreen mode.
   * @default 'default'
   * @platform android
   * @platform ios
   */
  orientation?: FullscreenOrientation;
  /**
   * Specifies whether the app should exit fullscreen mode when the device is rotated to a different orientation than the one specified in the `orientation` prop.
   * For example, if the `orientation` prop is set to `landscape` and the device is rotated to `portrait`, the app will exit fullscreen mode.
   *
   * > This prop will have no effect if the `orientation` prop is set to `default`.
   * > The `VideoView` will never auto-exit fullscreen when the device auto-rotate feature has been disabled in settings.
   *
   * @default false
   * @platform android
   * @platform ios
   */
  autoExitOnRotate?: boolean;

  /**
   * Determines whether the player keeps fullscreen when Picture in Picture (PiP) stops.
   * Only has an effect if the player was in fullscreen when PiP started.
   *
   * @default 'autoEnter'
   * @platform ios
   */
  keepFullscreenOnPiPStop?: KeepFullscreenOnPiPStopBehavior;
};