react-native-theoplayer/src/api/pip/PiPConfiguration.ts

A THEOplayer video component for react-native.

/**
 * Describes the configuration of the picture-in-picture feature.
 *
 * @public
 */
export interface PiPConfiguration {
  /**
   * Whether Picture in Picture should be allowed to start automatically from inline, when transitioning to background.
   *
   * @defaultValue `false`
   */
  readonly startsAutomatically?: boolean;

  /**
   * Whether Picture in Picture should reparent player to the root.
   *
   * @defaultValue `false`
   *
   * @platform android
   */
  readonly reparentPip?: boolean;

  /**
   * Whether Picture in Picture should remain active when setting a new (non-undefined) source.
   *
   * @defaultValue `false`
   *
   * @platform ios
   */
  readonly retainPipOnSourceChange?: boolean;
}