react-native-theoplayer/src/api/media/MediaControlConfiguration.ts

A THEOplayer video component for react-native.

/**
 * Describes the configuration of media controls and media sessions across platforms.
 *
 * For Android, this applies to the {@link https://developer.android.com/guide/topics/media-apps/working-with-a-media-session Media Session}
 * functionality, providing the platform with a uniform way of interacting with the player, and the
 * {@link https://developer.android.com/develop/ui/views/notifications Notification} to display information on the media currently playing.
 *
 * For Web, this applies to the {@link https://www.w3.org/TR/mediasession/ Media Session} API for customizing media notifications and access to
 * platform media keys.
 *
 * For iOS, this applies to the {@link https://developer.apple.com/documentation/mediaplayer/mpnowplayinginfocenter Now Playing} functionality for
 * setting information on the media that is currently playing, and the
 * {@link https://developer.apple.com/documentation/mediaplayer/mpremotecommandcenter Remote Command Center} responds to remote control events sent
 * by external accessories and system controls.
 */
export interface MediaControlConfiguration {
  /**
   * Whether the media session feature is enabled.
   *
   * @defaultValue `true`
   *
   * @platform web,android
   */
  readonly mediaSessionEnabled?: boolean;

  /**
   * The amount of seconds the player will skip forward.
   *
   * @defaultValue 5 on Web and android, 15 on iOS.
   */
  readonly skipForwardInterval?: number;

  /**
   * The amount of seconds the player will skip backward.
   *
   * @defaultValue 5 on Web and android, 15 on iOS.
   */
  readonly skipBackwardInterval?: number;

  /**
   * A flag that allows next/previous track commands to be interpreted as skip
   * forward/backward commands, according to the configured skip intervals.
   *
   * @defaultValue `false`
   *
   * @platform ios,android
   */
  readonly convertSkipToSeek?: boolean;

  /**
   * A flag that indicates whether play/pause controls for live streams are enabled.
   *
   * @defaultValue iOS: `true`, Android: `false`
   *
   * @platform ios,android
   */
  readonly allowLivePlayPause?: boolean;

  /**
   * A flag that controls whether to seek to the live edge when resuming a paused live stream.
   * Note that {@link allowLivePlayPause} needs to be enabled for this property to have effect.
   *
   * @defaultValue `false`
   *
   * @platform ios,android
   */
  readonly seekToLiveOnResume?: boolean;
}