@theoplayer/extended 3.4.0 → 3.5.0

package/THEOplayer.d.ts

@@ -2,7 +2,7 @@
  * THEOplayer
  * https://www.theoplayer.com
  *
- * Version: 2022.2.1 (3.4.0)
+ * Version: 2022.2.2 (3.5.0)
  */
 
 /**
@@ -2101,6 +2101,10 @@ export declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap>
      * <br/> - Volume is represented by a floating point number between `0.0` and `1.0`.
      */
     volume: number;
+    /**
+     * The latency manager for low latency live playback.
+     */
+    latency: LatencyManager;
     /**
      * The canvas of the player.
      */
@@ -4121,6 +4125,8 @@ export declare interface HespApi extends EventDispatcher<HespApiEventMap> {
     /**
      * Can be set to change the latency of the player.
      * A HespLatencyConfiguration object which gives latency configuration of the player.
+     *
+     * @deprecated use {@link ChromelessPlayer.latency} instead
      */
     latency: HespLatencyConfiguration;
     /**
@@ -5389,6 +5395,84 @@ export declare interface KeySystemConfiguration {
  */
 export declare type KeySystemId = 'widevine' | 'fairplay' | 'playready';
 
+/**
+ * The latency configuration for managing the live offset of the player.
+ *
+ * @public
+ */
+export declare interface LatencyConfiguration {
+    /**
+     * The start of the target live window.
+     * If the live offset becomes smaller than this value, the player will slow down in order to increase the latency.
+     */
+    minimumOffset: number;
+    /**
+     * The end of the target live window.
+     * If the live offset becomes higher than this value, the player will speed down in order to decrease the latency.
+     */
+    maximumOffset: number;
+    /**
+     * The live offset that the player will aim for. When correcting the offset by tuning the playbackRate,
+     * the player will stop correcting when it reaches this value.
+     */
+    targetOffset: number;
+    /**
+     * The live offset at which the player will automatically trigger a live seek.
+     */
+    forceSeekOffset: number;
+    /**
+     * Indicates the minimum playbackRate used to slow down the player.
+     */
+    minimumPlaybackRate: number;
+    /**
+     * Indicates the maximum playbackRate used to speed down the player.
+     */
+    maximumPlaybackRate: number;
+    /**
+     * Updates multiple values of the current configuration.
+     * @param configuration - The partial configuration with the replacement values.
+     */
+    update(configuration: Partial<LatencyConfiguration>): void;
+}
+
+/**
+ * The latency manager, used to control low-latency live playback.
+ *
+ * @public
+ */
+export declare interface LatencyManager {
+    /**
+     * Whether the latency manager is enabled and is chasing live playback.
+     *
+     * @remarks
+     * <br/> - Can only be enabled during live playback.
+     * <br/> - Only available for HESP sources.
+     */
+    enabled: boolean;
+    /**
+     * The current latency.
+     *
+     * @remarks
+     * <br/> - Only available during live playback.
+     */
+    readonly currentLatency: number | undefined;
+    /**
+     * The LatencyConfiguration of the current source, if available.
+     *
+     * @remarks
+     * <br/> - Only available during live playback.
+     */
+    readonly streamConfiguration: Partial<Readonly<LatencyConfiguration>> | undefined;
+    /**
+     * Can be used to set a custom values for chasing live playback.
+     *
+     * @remarks
+     * <br/> - The player might change the set values based on the streamConfiguration.
+     * <br/> - This configuration is reset every time the player source changes.
+     */
+    readonly configuration: LatencyConfiguration;
+}
+
 /**
  * A request for a license.
  * @public
@@ -7885,6 +7969,18 @@ declare interface TextTrack_2 extends Track, EventDispatcher<TextTrackEventMap_2
 }
 export { TextTrack_2 as TextTrack }
 
+/**
+ * Fired when a cue is added to the text track.
+ *
+ * @public
+ */
+export declare interface TextTrackAddCueEvent extends Event_2<'addcue'> {
+    /**
+     * The cue that is added to the text track.
+     */
+    readonly cue: TextTrackCue_2;
+}
+
 /**
  * Represents a cue of a text track.
  *
@@ -7929,6 +8025,30 @@ declare interface TextTrackCue_2 extends EventDispatcher<TextTrackCueEventMap_2>
 }
 export { TextTrackCue_2 as TextTrackCue }
 
+/**
+ * Fired when the displaying cues of the text track has changed.
+ *
+ * @public
+ */
+export declare interface TextTrackCueChangeEvent extends Event_2<'cuechange'> {
+    /**
+     * The text track which displaying cues has changed.
+     */
+    readonly track: TextTrack_2;
+}
+
+/**
+ * Fired when a text track cue is entered.
+ *
+ * @public
+ */
+export declare interface TextTrackCueEnterEvent extends Event_2<'enter'> {
+    /**
+     * The text track cue that is entered.
+     */
+    readonly cue: TextTrackCue_2;
+}
+
 /**
  * The events fired by the {@link TextTrackCue}.
  *
@@ -7938,18 +8058,30 @@ declare interface TextTrackCueEventMap_2 {
     /**
      * Fired when the cue is entered.
      */
-    enter: Event_2<'enter'>;
+    enter: TextTrackCueEnterEvent;
     /**
      * Fired when the cue is exited.
      */
-    exit: Event_2<'exit'>;
+    exit: TextTrackCueExitEvent;
     /**
      * Fired when the cue is updated.
      */
-    update: Event_2<'update'>;
+    update: TextTrackCueUpdateEvent;
 }
 export { TextTrackCueEventMap_2 as TextTrackCueEventMap }
 
+/**
+ * Fired when a text track cue is exited.
+ *
+ * @public
+ */
+export declare interface TextTrackCueExitEvent extends Event_2<'exit'> {
+    /**
+     * The text track cue that is exited.
+     */
+    readonly cue: TextTrackCue_2;
+}
+
 /**
  * List of text track cues.
  *
@@ -7974,6 +8106,18 @@ declare interface TextTrackCueList_2 extends ReadonlyArray<TextTrackCue_2> {
 }
 export { TextTrackCueList_2 as TextTrackCueList }
 
+/**
+ * Fired when a text track cue is updated.
+ *
+ * @public
+ */
+export declare interface TextTrackCueUpdateEvent extends Event_2<'update'> {
+    /**
+     * The text track cue that is updated.
+     */
+    readonly cue: TextTrackCue_2;
+}
+
 /**
  * Describes the configuration of a side-loaded text track.
  *
@@ -8035,6 +8179,18 @@ export declare interface TextTrackDescription {
 
 }
 
+/**
+ * Fired when a cue of the text track has entered.
+ *
+ * @public
+ */
+export declare interface TextTrackEnterCueEvent extends Event_2<'entercue'> {
+    /**
+     * The cue from the text track that has entered.
+     */
+    readonly cue: TextTrackCue_2;
+}
+
 /**
  * An error thrown by a text track.
  *
@@ -8083,31 +8239,31 @@ declare interface TextTrackEventMap_2 extends TrackEventMap {
     /**
      * Fired when a cue is added to the track.
      */
-    addcue: Event_2<'addcue'>;
+    addcue: TextTrackAddCueEvent;
     /**
      * Fired when a cue of the track is removed.
      */
-    removecue: Event_2<'removecue'>;
+    removecue: TextTrackRemoveCueEvent;
     /**
      * Fired when a cue of the track enters.
      */
-    entercue: Event_2<'entercue'>;
+    entercue: TextTrackEnterCueEvent;
     /**
      * Fired when a cue of the track exits.
      */
-    exitcue: Event_2<'exitcue'>;
+    exitcue: TextTrackExitCueEvent;
     /**
-     * Fired when a cue of the track changes.
+     * Fired when the displaying cues of the text track changes.
      */
-    cuechange: Event_2<'cuechange'>;
+    cuechange: TextTrackCueChangeEvent;
     /**
      * Fired when the text track's {@link TextTrack.readyState | ready state} changes.
      */
-    readystatechange: Event_2<'readystatechange'>;
+    readystatechange: TextTrackReadyStateChangeEvent;
     /**
      * Fired when the text track's {@link TextTrack."type" | type} changes.
      */
-    typechange: Event_2<'typechange'>;
+    typechange: TextTrackTypeChangeEvent;
     /**
      * Fired when an error occurred while loading or parsing the track.
      */
@@ -8115,6 +8271,18 @@ declare interface TextTrackEventMap_2 extends TrackEventMap {
 }
 export { TextTrackEventMap_2 as TextTrackEventMap }
 
+/**
+ * Fired when a cue of the text track has exited.
+ *
+ * @public
+ */
+export declare interface TextTrackExitCueEvent extends Event_2<'exitcue'> {
+    /**
+     * The cue from the text track that has exited.
+     */
+    readonly cue: TextTrackCue_2;
+}
+
 /**
  * The ready state of a text track, represented by a value from the following list:
  * <br/> - `0`: Indicates that the text track's cues have not been obtained.
@@ -8126,6 +8294,34 @@ export { TextTrackEventMap_2 as TextTrackEventMap }
  */
 export declare type TextTrackReadyState = 0 | 1 | 2 | 3;
 
+/**
+ * Fired when the {@link TextTrack.readyState | ready state} of the text track has changed.
+ *
+ * @public
+ */
+export declare interface TextTrackReadyStateChangeEvent extends Event_2<'readystatechange'> {
+    /**
+     * The text track which ready state has changed.
+     */
+    readonly track: TextTrack_2;
+    /**
+     * The new {@link TextTrack.readyState | ready state} of the text track.
+     */
+    readonly readyState: TextTrackReadyState;
+}
+
+/**
+ * Fired when a cue is removed from the text track.
+ *
+ * @public
+ */
+export declare interface TextTrackRemoveCueEvent extends Event_2<'removecue'> {
+    /**
+     * The cue that is removed from the text track.
+     */
+    readonly cue: TextTrackCue_2;
+}
+
 /**
  * List of text tracks.
  *
@@ -8241,6 +8437,18 @@ export declare interface TextTrackStyleEventMap {
  */
 export declare type TextTrackType = 'srt' | 'ttml' | 'webvtt' | 'emsg' | 'eventstream' | 'id3' | 'cea608' | 'daterange' | '';
 
+/**
+ * Fired when the {@link TextTrack."type" | type} of the text track has changed.
+ *
+ * @public
+ */
+export declare interface TextTrackTypeChangeEvent extends Event_2<'typechange'> {
+    /**
+     * The text track which type has changed.
+     */
+    readonly track: TextTrack_2;
+}
+
 /**
  * Describes an ad break request.
  *