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

A THEOplayer video component for react-native.

/**
 * Latency metrics for HESP pipeline
 *
 * @category THEOlive
 * @public
 */

export interface HespLatencies {
  /**
   * The latency introduced by processing the ingested stream in the engine on the server.
   */
  engineLatency?: number;

  /**
   * The latency introduced by distributing the processed frames towards the clients.
   */
  distributionLatency?: number;

  /**
   * The latency introduced by the player to process, buffer and display the downloaded frames.
   */
  playerLatency?: number;

  /**
   * The total latency introduced by the THEOlive pipeline: from frame ingested till displayed on screen.
   */
  theoliveLatency?: number
}

/**
 * The THEOlive API.
 *
 * @since React Native THEOplayer SDK v9.8.0.
 *
 * @category THEOlive
 * @public
 */
export interface TheoLiveAPI {
  /**
   * The latency measured for the playing THEOlive channel
   */
  currentLatency: Promise<number>;

  /**
   * A set of latency metrics, measured at different parts of the HESP pipeline.
   */
  latencies: Promise<HespLatencies>;

  /**
   * The authentication token used when requesting THEOlive manifests or segments.
   */
  authToken?: string;
}