@flowplayer/player 3.16.0-rc → 3.16.0-rc.2

package/plugins/id3.d.ts

@@ -401,6 +401,12 @@ declare namespace events {
     }
 }
 
+declare namespace events_2 {
+    export {
+        ID3_2 as ID3
+    }
+}
+
 declare type ExtractPureAPI<T> = T extends PlayerWith<infer PureAPI> ? PureAPI : never;
 
 /**
@@ -550,10 +556,70 @@ declare const HOVERED = "is-hovered";
 
 /**
  * @public
+ * This plugin adds support for ID3 metadata tags.
+ * See {@link https://developer.wowza.com/docs/wowza-flowplayer/plugins/id3-metadata/ | Official documentation}
  */
-declare const ID3: PluginCtor<Config, Player>;
+declare const ID3: PluginCtor<Config, ID3Player> & ID3API;
 export default ID3;
 
+declare const ID3_2 = "ID3";
+
+/**
+ * @public
+ */
+export declare type ID3API = {
+    events: ID3Events;
+};
+
+/**
+ * @public
+ */
+export declare type ID3Cue = TextTrackCue & {
+    /**
+     * ID3 Metadata
+     */
+    value: ID3Info;
+};
+
+/**
+ * @public
+ **/
+export declare type ID3EventDetail = {
+    /**
+     * ID3 cue
+     **/
+    cue: ID3Cue;
+};
+
+/**
+ * @public
+ */
+export declare type ID3Events = typeof events_2;
+
+/**
+ * @public
+ */
+export declare type ID3Info = {
+    info: string;
+    key: string;
+    /**
+     * Raw ID3 data
+     */
+    data: ArrayBuffer;
+};
+
+/**
+ * @public
+ */
+export declare type ID3Player = PlayerWith<{
+    /**
+     * Event that is fired every time new ID3 metadata is available
+     * @param event - "ID3"
+     * @param handler - Event with ID3 metadata
+     */
+    on(event: ID3Events["ID3"], handler: (e: FPEvent<ID3EventDetail>) => void): Player;
+}>;
+
 declare const IN_VIEWPORT = "is-in-viewport";
 
 /* Excluded from this release type: INTERSECTIONCHANGE */
@@ -768,6 +834,8 @@ declare const NO_CONTROLS = "no-controls";
 
 declare const NO_DVR = "no-timeline";
 
+declare type NoInfer_2<T> = [T][T extends any ? 0 : never];
+
 /* Excluded from this release type: NON_RECOVERABLE_ERROR */
 
 /* Excluded from this release type: NonRecoverableErrorEventDetail */
@@ -908,7 +976,6 @@ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
     disabled: boolean;
     /* Excluded from this release type: started */
     /* Excluded from this release type: token */
-    tracks?: VideoTrack[];
     /* Excluded from this release type: _customElements */
     /* Excluded from this release type: _storage */
 };
@@ -992,6 +1059,7 @@ declare type PlayerCustomEventsOverloads = {
      */
     on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
     /* Excluded from this release type: on */
+    /* Excluded from this release type: on */
     /**
      * Listen to this event to create a recommendations grid using the data passed with the event.
      */
@@ -1010,6 +1078,11 @@ declare type PlayerCustomEventsOverloads = {
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
+    /* Excluded from this release type: on */
+    /**
+     * TODO: this is a workaround, since not all event overloads are typed. when all plugin work is finished, remove this
+     * https://wowzamedia.jira.com/browse/PLAY-653
+     */
     on<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
     /* Excluded from this release type: on */
     /**
@@ -1034,9 +1107,12 @@ declare type PlayerCustomEventsOverloads = {
      */
     off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
     /* Excluded from this release type: poll */
+    emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
+    emit(event: never, data?: never): Player;
+    /* Excluded from this release type: emit */
+    /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
-    emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
     /* Excluded from this release type: emit */
 };
 
@@ -1144,6 +1220,17 @@ declare const /**
  */
 PROGRESS = "progress";
 
+/**
+ * @public
+ */
+declare type QselOption = {
+    height: number;
+    level: number;
+    text: string;
+    /* Excluded from this release type: videoCodec */
+    width: number;
+};
+
 /**
  * @public
  * emitted whenever a list of qualities has been made available
@@ -1162,27 +1249,11 @@ QUALITIES = "qualities";
 /**
  * @public
  */
-declare type QualitiesEventDetail = QualityDetail[];
+declare type QualitiesEventDetail = QselOption[];
 
-/**
- * @public
- */
-declare type QualityDetail = {
-    level: number;
-    text: string;
-    width: number;
-    height: number;
-    videoCodec: string;
-} | BitrateInfo | {
-    text: string | number;
-    encodingId: string;
-    spatialLayerId: number;
-    temporalLayerId: number;
-    maxSpatialLayerId: number;
-    maxTemporalLayerId: number;
-    height: number;
-    width: number;
-};
+/* Excluded from this release type: _QualitiesEventDetail */
+
+/* Excluded from this release type: _QualityDetail */
 
 declare enum QualityOpts {
     LOW = 1,
@@ -1354,20 +1425,14 @@ SEEKING_2 = "seeking";
 
 /**
  * @public
- *  allows plugins to listen for forced quality changes
- * it should emit the index of the quality to set
- * -1 is a special idx saying to use ABR if the plugin
- * exposes an ABR implementation
+ * @deprecated please use Qsel.events.SET_QUALITY
  */
 declare const /**
 @public
 * when a new player is inserted into the HTML
 */ /**
  * @public
- *  allows plugins to listen for forced quality changes
- * it should emit the index of the quality to set
- * -1 is a special idx saying to use ABR if the plugin
- * exposes an ABR implementation
+ * @deprecated please use Qsel.events.SET_QUALITY
  */
 SET_QUALITY = "quality:set";
 
@@ -1556,16 +1621,6 @@ declare const /**
  */
 VIDEO_TRACKS = "videoTracks";
 
-/**
- * @public
- */
-declare interface VideoTrack {
-    name: string;
-    /* Excluded from this release type: data */
-    default: boolean;
-    selected: boolean;
-}
-
 /**
  * @public
  * when a player enters the viewpoint

package/plugins/iframe.d.ts

@@ -769,6 +769,8 @@ declare const NO_CONTROLS = "no-controls";
 
 declare const NO_DVR = "no-timeline";
 
+declare type NoInfer_2<T> = [T][T extends any ? 0 : never];
+
 /* Excluded from this release type: NON_RECOVERABLE_ERROR */
 
 /* Excluded from this release type: NonRecoverableErrorEventDetail */
@@ -909,7 +911,6 @@ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
     disabled: boolean;
     /* Excluded from this release type: started */
     /* Excluded from this release type: token */
-    tracks?: VideoTrack[];
     /* Excluded from this release type: _customElements */
     /* Excluded from this release type: _storage */
 };
@@ -993,6 +994,7 @@ declare type PlayerCustomEventsOverloads = {
      */
     on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
     /* Excluded from this release type: on */
+    /* Excluded from this release type: on */
     /**
      * Listen to this event to create a recommendations grid using the data passed with the event.
      */
@@ -1011,6 +1013,11 @@ declare type PlayerCustomEventsOverloads = {
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
+    /* Excluded from this release type: on */
+    /**
+     * TODO: this is a workaround, since not all event overloads are typed. when all plugin work is finished, remove this
+     * https://wowzamedia.jira.com/browse/PLAY-653
+     */
     on<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
     /* Excluded from this release type: on */
     /**
@@ -1035,9 +1042,12 @@ declare type PlayerCustomEventsOverloads = {
      */
     off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
     /* Excluded from this release type: poll */
+    emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
+    emit(event: never, data?: never): Player;
+    /* Excluded from this release type: emit */
+    /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
-    emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
     /* Excluded from this release type: emit */
 };
 
@@ -1145,6 +1155,17 @@ declare const /**
  */
 PROGRESS = "progress";
 
+/**
+ * @public
+ */
+declare type QselOption = {
+    height: number;
+    level: number;
+    text: string;
+    /* Excluded from this release type: videoCodec */
+    width: number;
+};
+
 /**
  * @public
  * emitted whenever a list of qualities has been made available
@@ -1163,27 +1184,11 @@ QUALITIES = "qualities";
 /**
  * @public
  */
-declare type QualitiesEventDetail = QualityDetail[];
+declare type QualitiesEventDetail = QselOption[];
 
-/**
- * @public
- */
-declare type QualityDetail = {
-    level: number;
-    text: string;
-    width: number;
-    height: number;
-    videoCodec: string;
-} | BitrateInfo | {
-    text: string | number;
-    encodingId: string;
-    spatialLayerId: number;
-    temporalLayerId: number;
-    maxSpatialLayerId: number;
-    maxTemporalLayerId: number;
-    height: number;
-    width: number;
-};
+/* Excluded from this release type: _QualitiesEventDetail */
+
+/* Excluded from this release type: _QualityDetail */
 
 declare enum QualityOpts {
     LOW = 1,
@@ -1355,20 +1360,14 @@ SEEKING_2 = "seeking";
 
 /**
  * @public
- *  allows plugins to listen for forced quality changes
- * it should emit the index of the quality to set
- * -1 is a special idx saying to use ABR if the plugin
- * exposes an ABR implementation
+ * @deprecated please use Qsel.events.SET_QUALITY
  */
 declare const /**
 @public
 * when a new player is inserted into the HTML
 */ /**
  * @public
- *  allows plugins to listen for forced quality changes
- * it should emit the index of the quality to set
- * -1 is a special idx saying to use ABR if the plugin
- * exposes an ABR implementation
+ * @deprecated please use Qsel.events.SET_QUALITY
  */
 SET_QUALITY = "quality:set";
 
@@ -1557,16 +1556,6 @@ declare const /**
  */
 VIDEO_TRACKS = "videoTracks";
 
-/**
- * @public
- */
-declare interface VideoTrack {
-    name: string;
-    /* Excluded from this release type: data */
-    default: boolean;
-    selected: boolean;
-}
-
 /**
  * @public
  * when a player enters the viewpoint

package/plugins/keyboard.d.ts

@@ -768,6 +768,8 @@ declare const NO_CONTROLS = "no-controls";
 
 declare const NO_DVR = "no-timeline";
 
+declare type NoInfer_2<T> = [T][T extends any ? 0 : never];
+
 /* Excluded from this release type: NON_RECOVERABLE_ERROR */
 
 /* Excluded from this release type: NonRecoverableErrorEventDetail */
@@ -908,7 +910,6 @@ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
     disabled: boolean;
     /* Excluded from this release type: started */
     /* Excluded from this release type: token */
-    tracks?: VideoTrack[];
     /* Excluded from this release type: _customElements */
     /* Excluded from this release type: _storage */
 };
@@ -992,6 +993,7 @@ declare type PlayerCustomEventsOverloads = {
      */
     on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
     /* Excluded from this release type: on */
+    /* Excluded from this release type: on */
     /**
      * Listen to this event to create a recommendations grid using the data passed with the event.
      */
@@ -1010,6 +1012,11 @@ declare type PlayerCustomEventsOverloads = {
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
+    /* Excluded from this release type: on */
+    /**
+     * TODO: this is a workaround, since not all event overloads are typed. when all plugin work is finished, remove this
+     * https://wowzamedia.jira.com/browse/PLAY-653
+     */
     on<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
     /* Excluded from this release type: on */
     /**
@@ -1034,9 +1041,12 @@ declare type PlayerCustomEventsOverloads = {
      */
     off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
     /* Excluded from this release type: poll */
+    emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
+    emit(event: never, data?: never): Player;
+    /* Excluded from this release type: emit */
+    /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
-    emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
     /* Excluded from this release type: emit */
 };
 
@@ -1144,6 +1154,17 @@ declare const /**
  */
 PROGRESS = "progress";
 
+/**
+ * @public
+ */
+declare type QselOption = {
+    height: number;
+    level: number;
+    text: string;
+    /* Excluded from this release type: videoCodec */
+    width: number;
+};
+
 /**
  * @public
  * emitted whenever a list of qualities has been made available
@@ -1162,27 +1183,11 @@ QUALITIES = "qualities";
 /**
  * @public
  */
-declare type QualitiesEventDetail = QualityDetail[];
+declare type QualitiesEventDetail = QselOption[];
 
-/**
- * @public
- */
-declare type QualityDetail = {
-    level: number;
-    text: string;
-    width: number;
-    height: number;
-    videoCodec: string;
-} | BitrateInfo | {
-    text: string | number;
-    encodingId: string;
-    spatialLayerId: number;
-    temporalLayerId: number;
-    maxSpatialLayerId: number;
-    maxTemporalLayerId: number;
-    height: number;
-    width: number;
-};
+/* Excluded from this release type: _QualitiesEventDetail */
+
+/* Excluded from this release type: _QualityDetail */
 
 declare enum QualityOpts {
     LOW = 1,
@@ -1354,20 +1359,14 @@ SEEKING_2 = "seeking";
 
 /**
  * @public
- *  allows plugins to listen for forced quality changes
- * it should emit the index of the quality to set
- * -1 is a special idx saying to use ABR if the plugin
- * exposes an ABR implementation
+ * @deprecated please use Qsel.events.SET_QUALITY
  */
 declare const /**
 @public
 * when a new player is inserted into the HTML
 */ /**
  * @public
- *  allows plugins to listen for forced quality changes
- * it should emit the index of the quality to set
- * -1 is a special idx saying to use ABR if the plugin
- * exposes an ABR implementation
+ * @deprecated please use Qsel.events.SET_QUALITY
  */
 SET_QUALITY = "quality:set";
 
@@ -1556,16 +1555,6 @@ declare const /**
  */
 VIDEO_TRACKS = "videoTracks";
 
-/**
- * @public
- */
-declare interface VideoTrack {
-    name: string;
-    /* Excluded from this release type: data */
-    default: boolean;
-    selected: boolean;
-}
-
 /**
  * @public
  * when a player enters the viewpoint

package/plugins/media-session.d.ts

@@ -768,6 +768,8 @@ declare const NO_CONTROLS = "no-controls";
 
 declare const NO_DVR = "no-timeline";
 
+declare type NoInfer_2<T> = [T][T extends any ? 0 : never];
+
 /* Excluded from this release type: NON_RECOVERABLE_ERROR */
 
 /* Excluded from this release type: NonRecoverableErrorEventDetail */
@@ -908,7 +910,6 @@ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
     disabled: boolean;
     /* Excluded from this release type: started */
     /* Excluded from this release type: token */
-    tracks?: VideoTrack[];
     /* Excluded from this release type: _customElements */
     /* Excluded from this release type: _storage */
 };
@@ -992,6 +993,7 @@ declare type PlayerCustomEventsOverloads = {
      */
     on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
     /* Excluded from this release type: on */
+    /* Excluded from this release type: on */
     /**
      * Listen to this event to create a recommendations grid using the data passed with the event.
      */
@@ -1010,6 +1012,11 @@ declare type PlayerCustomEventsOverloads = {
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
+    /* Excluded from this release type: on */
+    /**
+     * TODO: this is a workaround, since not all event overloads are typed. when all plugin work is finished, remove this
+     * https://wowzamedia.jira.com/browse/PLAY-653
+     */
     on<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
     /* Excluded from this release type: on */
     /**
@@ -1034,9 +1041,12 @@ declare type PlayerCustomEventsOverloads = {
      */
     off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
     /* Excluded from this release type: poll */
+    emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
+    emit(event: never, data?: never): Player;
+    /* Excluded from this release type: emit */
+    /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
-    emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
     /* Excluded from this release type: emit */
 };
 
@@ -1144,6 +1154,17 @@ declare const /**
  */
 PROGRESS = "progress";
 
+/**
+ * @public
+ */
+declare type QselOption = {
+    height: number;
+    level: number;
+    text: string;
+    /* Excluded from this release type: videoCodec */
+    width: number;
+};
+
 /**
  * @public
  * emitted whenever a list of qualities has been made available
@@ -1162,27 +1183,11 @@ QUALITIES = "qualities";
 /**
  * @public
  */
-declare type QualitiesEventDetail = QualityDetail[];
+declare type QualitiesEventDetail = QselOption[];
 
-/**
- * @public
- */
-declare type QualityDetail = {
-    level: number;
-    text: string;
-    width: number;
-    height: number;
-    videoCodec: string;
-} | BitrateInfo | {
-    text: string | number;
-    encodingId: string;
-    spatialLayerId: number;
-    temporalLayerId: number;
-    maxSpatialLayerId: number;
-    maxTemporalLayerId: number;
-    height: number;
-    width: number;
-};
+/* Excluded from this release type: _QualitiesEventDetail */
+
+/* Excluded from this release type: _QualityDetail */
 
 declare enum QualityOpts {
     LOW = 1,
@@ -1354,20 +1359,14 @@ SEEKING_2 = "seeking";
 
 /**
  * @public
- *  allows plugins to listen for forced quality changes
- * it should emit the index of the quality to set
- * -1 is a special idx saying to use ABR if the plugin
- * exposes an ABR implementation
+ * @deprecated please use Qsel.events.SET_QUALITY
  */
 declare const /**
 @public
 * when a new player is inserted into the HTML
 */ /**
  * @public
- *  allows plugins to listen for forced quality changes
- * it should emit the index of the quality to set
- * -1 is a special idx saying to use ABR if the plugin
- * exposes an ABR implementation
+ * @deprecated please use Qsel.events.SET_QUALITY
  */
 SET_QUALITY = "quality:set";
 
@@ -1556,16 +1555,6 @@ declare const /**
  */
 VIDEO_TRACKS = "videoTracks";
 
-/**
- * @public
- */
-declare interface VideoTrack {
-    name: string;
-    /* Excluded from this release type: data */
-    default: boolean;
-    selected: boolean;
-}
-
 /**
  * @public
  * when a player enters the viewpoint