react-native-theoplayer/src/api/theolive/TheoLiveConfiguration.ts

A THEOplayer video component for react-native.

/**
 * The configuration THEOlive playback.
 *
 * @public
 */
export interface TheoLiveConfiguration {
  /**
   * An id used to report usage analytics, if not explicitly given a random UUID is used.
   *
   * @platform web,android
   */
  readonly externalSessionId?: string;

  /**
   * Whether this player should fallback or not when it has a fallback configured.
   *
   * @platform web
   */
  readonly fallbackEnabled?: boolean;

  /**
   * An optional header that can be passed during discovery.
   *
   * @platform web
   */
  readonly discoveryHeader?: string;

  /**
   * Whether THEOlive analytics should be disabled or not.
   *
   * @platform android
   *
   * @defaultValue `false`
   */
  readonly analyticsDisabled?: boolean;


  /**
   * Whether THEOlive uses the new pipeline or stick to the legacy implementation.
   *
   * @remarks
   * <br/> - Available on iOS only.
   * <br/> - When enabled, THEOlive channels will be streamed using the legacy pipeline.
   *
   * @defaultValue `false`
   */
  readonly useLegacyTHEOlive?: boolean;

  /**
   * Override for the discovery URL.
   */
  readonly discoveryUrl?: string;
}