@flowplayer/player 3.19.0 → 3.20.0-rc.6

package/plugins/preview.d.ts

@@ -1,7 +1,11 @@
 /// <reference types="node" />
 
 import type { BitrateInfo } from 'dashjs';
+import type { Get } from 'type-fest';
+import type { Level } from 'hls.js';
 import type { MediaKeyFunc } from 'hls.js';
+import type { SetFieldType } from 'type-fest';
+import type { TupleToUnion } from 'type-fest';
 
 /* Excluded from this release type: AnyLoader */
 
@@ -79,6 +83,26 @@ declare const /**
  */
 CLICK = "click";
 
+/**
+ * For plugins that add new properties to all source types, combine their src-mixins into one SourceObject
+ * @example
+ * ```
+ * type Combined = CombineGlobalSrcExtensions<DRMPlugin, PluginWithFooFieldInSrc> // Combined = SourceObject<DRMConfig & FooFieldConfig>
+ * ```
+ */
+declare type CombineGlobalSrcExtensions<PluginSrcs extends unknown[]> = HasGlobalSrcExtensios<PluginSrcs> extends false ? SourceObj : SourceObj & ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
+
+/**
+ * For plugins that define a new src type, make a union of all new src.type declarations
+ * @example
+ * ```
+ * type Combined = CombineNewSourceTypes<RTSPlugin, SSAIPlugin> // Combined = DRMConfig | FooFieldConfig
+ * ```
+ */
+declare type CombineNewSourceTypes<PluginSrcs extends unknown[]> = TupleToUnion<FilterNewSourceTypes<PluginSrcs>>;
+
+declare type CombineSrc<PluginSrcs extends unknown[]> = UnsafeSource<CombineGlobalSrcExtensions<PluginSrcs> | (CombineNewSourceTypes<PluginSrcs> & CombineGlobalSrcExtensions<PluginSrcs>)>;
+
 /* Excluded from this release type: Component */
 
 /* Excluded from this release type: Components */
@@ -139,6 +163,10 @@ declare interface Config {
  */
 declare type ConfigWith<T> = Config & T;
 
+declare type ConfigWithSourceExtensions<PluginBareConfigs extends unknown[]> = Omit<ConfigWith<ArrayToIntersection<PluginBareConfigs>>, "src"> & {
+    src?: CombineSrc<PickSrcExtensions<PluginBareConfigs>>;
+};
+
 /* Excluded from this release type: CONTENT_REAL_LOAD_START */
 
 /**
@@ -382,6 +410,7 @@ declare namespace events {
         SOURCE,
         REAP,
         QUALITIES,
+        QUALITY_CHANGE,
         VIDEO_TRACKS,
         SET_QUALITY,
         VIDEO_TRACK_SELECT,
@@ -397,8 +426,20 @@ declare namespace events {
     }
 }
 
+declare type ExtractBareConfig<Plugins extends PluginCtor> = Plugins extends PluginCtor<ConfigWith<infer ConfigType>> ? ConfigType : never;
+
+declare type ExtractPluginPlayerExtension<Plugin extends PluginCtor> = Plugin extends PluginCtor<infer _uConfigType, PlayerWith<infer PluginPlayer>> ? PluginPlayer : never;
+
 declare type ExtractPureAPI<T> = T extends PlayerWith<infer PureAPI> ? PureAPI : never;
 
+declare type ExtractSrcExtension<PluginBareConfig> = Get<PluginBareConfig, "src"> extends UnsafeSource<infer SrcMixinType> ? SrcMixinType : never;
+
+declare type FilterNewSourceTypes<PluginSrcs extends unknown[]> = {
+    [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
+        type: string;
+    } ? PluginSrcs[Index] : never;
+};
+
 /**
  * @public
  */
@@ -441,7 +482,7 @@ declare interface FlowplayerUMD extends FlowplayerUMDBase {
      * Register plugins in flowplayer
      * @returns flowplayer instance with registered plugins
      */
-    <PluginCtors extends PluginCtor[]>(...plugins: PluginCtors): FlowplayerUMDWithPlugins<ConfigWith<MergeConfigs<PluginCtors>>, PlayerWith<MergePlayerAPIExtensions<PluginCtors>>>;
+    <PluginCtors extends PluginCtor[]>(...plugins: PluginCtors): FlowplayerUMDWithPlugins<MergeConfigs<PluginCtors>, PlayerWith<MergePlayerExtensions<PluginCtors>>>;
 }
 
 declare interface FlowplayerUMDBase {
@@ -542,6 +583,10 @@ declare const GRABBING = "is-grabbing";
 
 declare const HAS_POSTER = "has-poster";
 
+declare type HasGlobalSrcExtensios<PluginSrcs extends unknown[]> = ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
+
+declare type HasSrcExtensions<PluginBareConfigs extends unknown[]> = TupleToUnion<PickSrcExtensions<PluginBareConfigs>> extends never ? false : true;
+
 declare const HOVERED = "is-hovered";
 
 declare const IN_VIEWPORT = "is-in-viewport";
@@ -651,19 +696,24 @@ PluginPlayer extends PlayerWith<_AttachedEventCheck>> extends Plugin_2<PluginOwn
 
 declare const LOADING = "is-loading";
 
-declare type MapToConfigs<Arr extends PluginCtor[]> = {
-    [PluginType in keyof Arr]: Arr[PluginType] extends PluginCtor<ConfigWith<infer ConfigType>> ? ConfigType : never;
+declare type MapToBareConfigs<Plugins extends PluginCtor[]> = {
+    [PluginType in keyof Plugins]: ExtractBareConfig<Plugins[PluginType]>;
 };
 
-declare type MapToPlayerApiExtensions<Arr extends PluginCtor[]> = {
-    [PluginType in keyof Arr]: Arr[PluginType] extends PluginCtor<infer _uConfigType, PlayerWith<infer PlayerAPIExtension>> ? PlayerAPIExtension : never;
+declare type MapToPlayerExtensions<Plugins extends PluginCtor[]> = {
+    [PluginIndex in keyof Plugins]: ExtractPluginPlayerExtension<Plugins[PluginIndex]>;
 };
 
 declare const MENU_OPENED = "has-menu-opened";
 
-declare type MergeConfigs<Arr extends PluginCtor[]> = ArrayToIntersection<MapToConfigs<Arr>>;
+/**
+ * Combines plugin config and returns a type derived from Config
+ */
+declare type MergeConfigs<Plugins extends PluginCtor[]> = MergePluginConfigs<MapToBareConfigs<Plugins>>;
+
+declare type MergePlayerExtensions<Plugins extends PluginCtor[]> = ArrayToIntersection<MapToPlayerExtensions<Plugins>>;
 
-declare type MergePlayerAPIExtensions<Arr extends PluginCtor[]> = ArrayToIntersection<MapToPlayerApiExtensions<Arr>>;
+declare type MergePluginConfigs<PluginBareConfigs extends unknown[]> = HasSrcExtensions<PluginBareConfigs> extends true ? ConfigWithSourceExtensions<PluginBareConfigs> : ConfigWith<ArrayToIntersection<PluginBareConfigs>>;
 
 /**
  * @public
@@ -770,8 +820,6 @@ 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 */
@@ -790,6 +838,7 @@ declare type OVPMetadata = {
     category_name?: string;
     duration?: number;
     tags?: string;
+    playlist_title?: string;
 };
 
 /**
@@ -805,6 +854,26 @@ PAUSE = "pause";
 
 declare const PAUSED = "is-paused";
 
+declare type PickGlobalSrcExtension<PluginSrcs extends unknown[]> = {
+    [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
+        type: string;
+    } ? unknown : PluginSrcs[Index];
+};
+
+/**
+ * Maps incoming array to the src extension type
+ * @example
+ * ```
+ * PickSrcExtensions<[
+ *    {configProp: boolean, src: UnsafeSource<{srcProp: boolean}>},
+ *    {}
+ * ]> // = [{srcProp: boolean}, never]
+ * ```
+ */
+declare type PickSrcExtensions<PluginBareConfigs extends unknown[]> = {
+    [PluginType in keyof PluginBareConfigs]: ExtractSrcExtension<PluginBareConfigs[PluginType]>;
+};
+
 /**
  * @public
  */
@@ -926,6 +995,8 @@ declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap
     [DVR]: DvrEventDetail;
     [RETRY]: RetryEventDetail;
     [RECOVER]: RecoverEventDetail;
+    [QUALITIES]: QualitiesEventDetail;
+    [QUALITY_CHANGE]: QualityChangeEventDetail;
     /* Excluded from this release type: audioonlysource */
     /* Excluded from this release type: renderplugin */
     /* Excluded from this release type: "seek:queued" */
@@ -982,7 +1053,10 @@ declare type PlayerCustomEventsOverloads = {
      * Emitted when the set of underlying qualities has changed.
      */
     on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
-    /* Excluded from this release type: on */
+    /**
+     * Emitted when the media changes quality.
+     */
+    on(event: typeof QUALITY_CHANGE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITY_CHANGE]>) => void): Player;
     /* Excluded from this release type: on */
     /**
      * Listen to this event to create a recommendations grid using the data passed with the event.
@@ -1037,7 +1111,6 @@ declare type PlayerCustomEventsOverloads = {
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
-    /* Excluded from this release type: emit */
 };
 
 declare type PlayerEmittableCustomEventsDetailMap = {
@@ -1045,7 +1118,6 @@ declare type PlayerEmittableCustomEventsDetailMap = {
     [CONTEXT_MENU]: ContextMenuEventDetail;
     [VIEW_ENTER]: ViewEnterEventDetail;
     [VIEW_LEAVE]: ViewLeaveEventDetail;
-    [QUALITIES]: QualitiesEventDetail;
     [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
 };
 
@@ -1138,7 +1210,7 @@ PORTRAIT = "portrait";
  * The Animated Previews plugin adds an animated image showing a preview snippet of the VOD content.
  * See {@link https://developer.wowza.com/docs/wowza-flowplayer/plugins/animated-previews/| Official Documentation}
  */
-declare const Preview: PluginCtor<PreviewConfig, Player> & PreviewAPI;
+declare const Preview: PluginCtor<NoInfer<PreviewConfig>, NoInfer<Player>> & NoInfer<PreviewAPI>;
 export default Preview;
 
 /**
@@ -1217,11 +1289,16 @@ PROGRESS = "progress";
 /**
  * @public
  */
-declare type QselOption = {
-    height: number;
+declare type QselOption = (Level & {
     level: number;
-    text: string;
-    /* Excluded from this release type: videoCodec */
+}) | BitrateInfo | {
+    name: string | number;
+    encodingId: string;
+    spatialLayerId: number;
+    temporalLayerId: number;
+    maxSpatialLayerId: number;
+    maxTemporalLayerId: number;
+    height: number;
     width: number;
 };
 
@@ -1245,9 +1322,29 @@ QUALITIES = "qualities";
  */
 declare type QualitiesEventDetail = QselOption[];
 
-/* Excluded from this release type: _QualitiesEventDetail */
+/**
+ * @public
+ * emitted whenever the media changes quality
+ */
+declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted whenever the media changes quality
+ */
+QUALITY_CHANGE = "qualitychange";
 
-/* Excluded from this release type: _QualityDetail */
+/**
+ * @public
+ */
+declare type QualityChangeEventDetail = {
+    before: Level | BitrateInfo;
+    after: Level | BitrateInfo;
+    plugin: string;
+    automatic: boolean;
+    downscale: boolean;
+};
 
 declare enum QualityOpts {
     LOW = 1,
@@ -1453,14 +1550,14 @@ declare type SourceEventDetail = SourceObj;
 /**
  * @public
  */
-declare type SourceObj = {
+declare type SourceObj<T = unknown> = {
     src?: SourceStr;
     /**
      *  the MIME type (example `video/mp4` or `application/x-mpegurl`)
      */
     type?: string;
     drm?: DRMSourceConfiguration;
-};
+} & T;
 
 /**
  * @public
@@ -1595,7 +1692,7 @@ declare const TV = "is-tv";
 /**
  * @public
  */
-declare type UnsafeSource = SourceStr | SourceObj | Array<SourceStr | SourceObj>;
+declare type UnsafeSource<SrcMixin = unknown> = SourceStr | SourceObj<SrcMixin> | Array<SourceStr | SourceObj<SrcMixin>>;
 
 /**
  * @public
@@ -1697,9 +1794,6 @@ declare const WILL_PLAY = "will-play";
 
 declare const WILL_SEEK = "will-seek";
 
-declare type WithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = PluginPlayer & {
-    opts: PluginConfig;
-    setOpts(config: PluginConfig): void;
-};
+declare type WithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = SetFieldType<SetFieldType<PluginPlayer, "opts", PluginConfig>, "setOpts", (config: PluginConfig) => void>;
 
 export { }

package/plugins/qsel.d.ts

@@ -1,7 +1,11 @@
 /// <reference types="node" />
 
 import type { BitrateInfo } from 'dashjs';
+import type { Get } from 'type-fest';
+import type { Level } from 'hls.js';
 import type { MediaKeyFunc } from 'hls.js';
+import type { SetFieldType } from 'type-fest';
+import type { TupleToUnion } from 'type-fest';
 
 /* Excluded from this release type: AnyLoader */
 
@@ -79,6 +83,26 @@ declare const /**
  */
 CLICK = "click";
 
+/**
+ * For plugins that add new properties to all source types, combine their src-mixins into one SourceObject
+ * @example
+ * ```
+ * type Combined = CombineGlobalSrcExtensions<DRMPlugin, PluginWithFooFieldInSrc> // Combined = SourceObject<DRMConfig & FooFieldConfig>
+ * ```
+ */
+declare type CombineGlobalSrcExtensions<PluginSrcs extends unknown[]> = HasGlobalSrcExtensios<PluginSrcs> extends false ? SourceObj : SourceObj & ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
+
+/**
+ * For plugins that define a new src type, make a union of all new src.type declarations
+ * @example
+ * ```
+ * type Combined = CombineNewSourceTypes<RTSPlugin, SSAIPlugin> // Combined = DRMConfig | FooFieldConfig
+ * ```
+ */
+declare type CombineNewSourceTypes<PluginSrcs extends unknown[]> = TupleToUnion<FilterNewSourceTypes<PluginSrcs>>;
+
+declare type CombineSrc<PluginSrcs extends unknown[]> = UnsafeSource<CombineGlobalSrcExtensions<PluginSrcs> | (CombineNewSourceTypes<PluginSrcs> & CombineGlobalSrcExtensions<PluginSrcs>)>;
+
 /* Excluded from this release type: Component */
 
 /* Excluded from this release type: Components */
@@ -139,6 +163,10 @@ declare interface Config {
  */
 declare type ConfigWith<T> = Config & T;
 
+declare type ConfigWithSourceExtensions<PluginBareConfigs extends unknown[]> = Omit<ConfigWith<ArrayToIntersection<PluginBareConfigs>>, "src"> & {
+    src?: CombineSrc<PickSrcExtensions<PluginBareConfigs>>;
+};
+
 /* Excluded from this release type: CONTENT_REAL_LOAD_START */
 
 /**
@@ -382,6 +410,7 @@ declare namespace events {
         SOURCE,
         REAP,
         QUALITIES,
+        QUALITY_CHANGE,
         VIDEO_TRACKS,
         SET_QUALITY,
         VIDEO_TRACK_SELECT,
@@ -404,8 +433,20 @@ declare namespace events_2 {
     }
 }
 
+declare type ExtractBareConfig<Plugins extends PluginCtor> = Plugins extends PluginCtor<ConfigWith<infer ConfigType>> ? ConfigType : never;
+
+declare type ExtractPluginPlayerExtension<Plugin extends PluginCtor> = Plugin extends PluginCtor<infer _uConfigType, PlayerWith<infer PluginPlayer>> ? PluginPlayer : never;
+
 declare type ExtractPureAPI<T> = T extends PlayerWith<infer PureAPI> ? PureAPI : never;
 
+declare type ExtractSrcExtension<PluginBareConfig> = Get<PluginBareConfig, "src"> extends UnsafeSource<infer SrcMixinType> ? SrcMixinType : never;
+
+declare type FilterNewSourceTypes<PluginSrcs extends unknown[]> = {
+    [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
+        type: string;
+    } ? PluginSrcs[Index] : never;
+};
+
 /**
  * @public
  */
@@ -448,7 +489,7 @@ declare interface FlowplayerUMD extends FlowplayerUMDBase {
      * Register plugins in flowplayer
      * @returns flowplayer instance with registered plugins
      */
-    <PluginCtors extends PluginCtor[]>(...plugins: PluginCtors): FlowplayerUMDWithPlugins<ConfigWith<MergeConfigs<PluginCtors>>, PlayerWith<MergePlayerAPIExtensions<PluginCtors>>>;
+    <PluginCtors extends PluginCtor[]>(...plugins: PluginCtors): FlowplayerUMDWithPlugins<MergeConfigs<PluginCtors>, PlayerWith<MergePlayerExtensions<PluginCtors>>>;
 }
 
 declare interface FlowplayerUMDBase {
@@ -549,6 +590,10 @@ declare const GRABBING = "is-grabbing";
 
 declare const HAS_POSTER = "has-poster";
 
+declare type HasGlobalSrcExtensios<PluginSrcs extends unknown[]> = ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
+
+declare type HasSrcExtensions<PluginBareConfigs extends unknown[]> = TupleToUnion<PickSrcExtensions<PluginBareConfigs>> extends never ? false : true;
+
 declare const HOVERED = "is-hovered";
 
 declare const IN_VIEWPORT = "is-in-viewport";
@@ -658,19 +703,24 @@ PluginPlayer extends PlayerWith<_AttachedEventCheck>> extends Plugin_2<PluginOwn
 
 declare const LOADING = "is-loading";
 
-declare type MapToConfigs<Arr extends PluginCtor[]> = {
-    [PluginType in keyof Arr]: Arr[PluginType] extends PluginCtor<ConfigWith<infer ConfigType>> ? ConfigType : never;
+declare type MapToBareConfigs<Plugins extends PluginCtor[]> = {
+    [PluginType in keyof Plugins]: ExtractBareConfig<Plugins[PluginType]>;
 };
 
-declare type MapToPlayerApiExtensions<Arr extends PluginCtor[]> = {
-    [PluginType in keyof Arr]: Arr[PluginType] extends PluginCtor<infer _uConfigType, PlayerWith<infer PlayerAPIExtension>> ? PlayerAPIExtension : never;
+declare type MapToPlayerExtensions<Plugins extends PluginCtor[]> = {
+    [PluginIndex in keyof Plugins]: ExtractPluginPlayerExtension<Plugins[PluginIndex]>;
 };
 
 declare const MENU_OPENED = "has-menu-opened";
 
-declare type MergeConfigs<Arr extends PluginCtor[]> = ArrayToIntersection<MapToConfigs<Arr>>;
+/**
+ * Combines plugin config and returns a type derived from Config
+ */
+declare type MergeConfigs<Plugins extends PluginCtor[]> = MergePluginConfigs<MapToBareConfigs<Plugins>>;
+
+declare type MergePlayerExtensions<Plugins extends PluginCtor[]> = ArrayToIntersection<MapToPlayerExtensions<Plugins>>;
 
-declare type MergePlayerAPIExtensions<Arr extends PluginCtor[]> = ArrayToIntersection<MapToPlayerApiExtensions<Arr>>;
+declare type MergePluginConfigs<PluginBareConfigs extends unknown[]> = HasSrcExtensions<PluginBareConfigs> extends true ? ConfigWithSourceExtensions<PluginBareConfigs> : ConfigWith<ArrayToIntersection<PluginBareConfigs>>;
 
 /**
  * @public
@@ -765,8 +815,6 @@ 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 */
@@ -785,6 +833,7 @@ declare type OVPMetadata = {
     category_name?: string;
     duration?: number;
     tags?: string;
+    playlist_title?: string;
 };
 
 /**
@@ -800,6 +849,26 @@ PAUSE = "pause";
 
 declare const PAUSED = "is-paused";
 
+declare type PickGlobalSrcExtension<PluginSrcs extends unknown[]> = {
+    [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
+        type: string;
+    } ? unknown : PluginSrcs[Index];
+};
+
+/**
+ * Maps incoming array to the src extension type
+ * @example
+ * ```
+ * PickSrcExtensions<[
+ *    {configProp: boolean, src: UnsafeSource<{srcProp: boolean}>},
+ *    {}
+ * ]> // = [{srcProp: boolean}, never]
+ * ```
+ */
+declare type PickSrcExtensions<PluginBareConfigs extends unknown[]> = {
+    [PluginType in keyof PluginBareConfigs]: ExtractSrcExtension<PluginBareConfigs[PluginType]>;
+};
+
 /**
  * @public
  */
@@ -921,6 +990,8 @@ declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap
     [DVR]: DvrEventDetail;
     [RETRY]: RetryEventDetail;
     [RECOVER]: RecoverEventDetail;
+    [QUALITIES]: QualitiesEventDetail;
+    [QUALITY_CHANGE]: QualityChangeEventDetail;
     /* Excluded from this release type: audioonlysource */
     /* Excluded from this release type: renderplugin */
     /* Excluded from this release type: "seek:queued" */
@@ -977,7 +1048,10 @@ declare type PlayerCustomEventsOverloads = {
      * Emitted when the set of underlying qualities has changed.
      */
     on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
-    /* Excluded from this release type: on */
+    /**
+     * Emitted when the media changes quality.
+     */
+    on(event: typeof QUALITY_CHANGE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITY_CHANGE]>) => void): Player;
     /* Excluded from this release type: on */
     /**
      * Listen to this event to create a recommendations grid using the data passed with the event.
@@ -1032,7 +1106,6 @@ declare type PlayerCustomEventsOverloads = {
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
-    /* Excluded from this release type: emit */
 };
 
 declare type PlayerEmittableCustomEventsDetailMap = {
@@ -1040,7 +1113,6 @@ declare type PlayerEmittableCustomEventsDetailMap = {
     [CONTEXT_MENU]: ContextMenuEventDetail;
     [VIEW_ENTER]: ViewEnterEventDetail;
     [VIEW_LEAVE]: ViewLeaveEventDetail;
-    [QUALITIES]: QualitiesEventDetail;
     [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
 };
 
@@ -1144,7 +1216,7 @@ PROGRESS = "progress";
  * This plugin implements a selection menu for the different quality levels of a multi-rendition stream. This plugin can be used with HLS, MPEG-DASH, and Real-Time Streaming (RTS).
  * See {@link https://developer.wowza.com/docs/wowza-flowplayer/plugins/quality-selection/ |Official Documentation}
  */
-declare const Qsel: PluginCtor<QselConfig, QselPlayer> & QselAPI;
+declare const Qsel: PluginCtor<NoInfer<QselConfig>, NoInfer<QselPlayer>> & NoInfer<QselAPI>;
 export default Qsel;
 
 /**
@@ -1177,11 +1249,16 @@ export declare type QselEvents = typeof events_2;
 /**
  * @public
  */
-declare type QselOption = {
-    height: number;
+declare type QselOption = (Level & {
     level: number;
-    text: string;
-    /* Excluded from this release type: videoCodec */
+}) | BitrateInfo | {
+    name: string | number;
+    encodingId: string;
+    spatialLayerId: number;
+    temporalLayerId: number;
+    maxSpatialLayerId: number;
+    maxTemporalLayerId: number;
+    height: number;
     width: number;
 };
 
@@ -1219,9 +1296,29 @@ QUALITIES = "qualities";
  */
 declare type QualitiesEventDetail = QselOption[];
 
-/* Excluded from this release type: _QualitiesEventDetail */
+/**
+ * @public
+ * emitted whenever the media changes quality
+ */
+declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted whenever the media changes quality
+ */
+QUALITY_CHANGE = "qualitychange";
 
-/* Excluded from this release type: _QualityDetail */
+/**
+ * @public
+ */
+declare type QualityChangeEventDetail = {
+    before: Level | BitrateInfo;
+    after: Level | BitrateInfo;
+    plugin: string;
+    automatic: boolean;
+    downscale: boolean;
+};
 
 declare enum QualityOpts {
     LOW = 1,
@@ -1448,14 +1545,14 @@ declare type SourceEventDetail = SourceObj;
 /**
  * @public
  */
-declare type SourceObj = {
+declare type SourceObj<T = unknown> = {
     src?: SourceStr;
     /**
      *  the MIME type (example `video/mp4` or `application/x-mpegurl`)
      */
     type?: string;
     drm?: DRMSourceConfiguration;
-};
+} & T;
 
 /**
  * @public
@@ -1586,7 +1683,7 @@ declare const TV = "is-tv";
 /**
  * @public
  */
-declare type UnsafeSource = SourceStr | SourceObj | Array<SourceStr | SourceObj>;
+declare type UnsafeSource<SrcMixin = unknown> = SourceStr | SourceObj<SrcMixin> | Array<SourceStr | SourceObj<SrcMixin>>;
 
 /**
  * @public
@@ -1682,9 +1779,6 @@ declare const WILL_PLAY = "will-play";
 
 declare const WILL_SEEK = "will-seek";
 
-declare type WithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = PluginPlayer & {
-    opts: PluginConfig;
-    setOpts(config: PluginConfig): void;
-};
+declare type WithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = SetFieldType<SetFieldType<PluginPlayer, "opts", PluginConfig>, "setOpts", (config: PluginConfig) => void>;
 
 export { }

package/plugins/qsel.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):((e="undefined"!=typeof globalThis?globalThis:e||self).flowplayer=e.flowplayer||{},e.flowplayer.qsel=t())}(this,(function(){"use strict";function e(e,t,n){const s=function(e){return Array.isArray(e)?e.slice(0):e.split(".")}(t);for(;s.length;){if(null==e)return n;const t=s.shift();if("string"!=typeof t)return n;e=e[t]}return null==e?n:e}const t=(e,t)=>new(((e,t)=>{const n=e.get(t);if(!n)throw new Error(`no flowplayer component with the name ${t} exists`);const s=window.customElements.get(t);if(!s)throw new Error(`no default flowplayer component with the name ${t} exists`);const i=window.customElements.get(n);return"function"!=typeof i?s:i})(e._customElements,t))(e);class FlowplayerComponent extends HTMLElement{constructor(e){super(),this.player=e}}const n="fp-on",s="fp-invis";class FlowplayerMenu extends FlowplayerComponent{constructor(e){super(e),this.player=e,this.menuContainer=document.createElement("details"),this.summaryEle=document.createElement("summary"),this.menuHeader=document.createElement("div"),this.menuTitle=document.createElement("h3"),this.olEle=document.createElement("ol"),this.olEle.id=o(),this.menu=document.createElement("div"),this.closeEle=document.createElement("span"),this.menuHeader.classList.add("fp-menu-header"),this.menuHeader.append(this.menuTitle,this.closeEle),this.menu.classList.add("fp-menu"),this.menu.append(this.menuHeader,this.olEle),this.closeEle.classList.add("fp-close"),this.closeEle.textContent="×",this.menuContainer.classList.add("fp-menu-container"),this.menuContainer.append(this.summaryEle,this.menu),this.menuContainer.addEventListener("click",t=>{if(t.defaultPrevented)return;t.preventDefault();const n=this.menuContainer.open;n||(i(),document.active_menu=this.menuContainer),this.menuContainer.open=!n,e.root.classList.toggle("has-menu-opened",!n),this.summaryEle.setAttribute("aria-expanded",n?"false":"true")}),this.addEventListener("focusin",e=>{const t=e.target;t instanceof HTMLLIElement&&t.setAttribute("aria-selected","true")}),this.addEventListener("focusout",e=>{const t=e.target;t instanceof HTMLLIElement&&t.setAttribute("aria-selected","false")}),this.append(this.menuContainer),this.olEle.setAttribute("aria-labelledby",this.summaryEle.id),this.olEle.setAttribute("role","menu"),this.summaryEle.setAttribute("aria-haspopup","true"),this.summaryEle.setAttribute("aria-controls",this.olEle.id),this.summaryEle.setAttribute("tabindex","0"),this.summaryEle.setAttribute("aria-expanded","false"),this.summaryEle.setAttribute("role","button")}get options(){return this.olEle.querySelectorAll("li")}setMenuAttrs(e){if(this.className=e.class,this.toggle_visibility(!0),this.summaryEle.id||(this.summaryEle.id=e.id||o()),this.summaryEle.setAttribute("aria-label",e.menuTitle||"Menu"),e.summaryTitle&&(this.summaryEle.textContent=e.summaryTitle),e.summaryIcon){const n=t(this.player,e.summaryIcon);n.setAttribute("tabindex",""),this.summaryEle.append(n)}e.menuTitle&&(this.menuTitle.textContent=e.menuTitle),this.menu.classList.toggle("fp-icons",!!e.icons),this.addEventListener(e.options_event,e=>{this.render(e.data)}),e.item_selected_event&&this.addEventListener(e.item_selected_event,e=>{void 0!==e.data&&this.select_item(e.data.selected_index)})}render(e){this.olEle&&(this.olEle.innerHTML="",e&&e.forEach(this.menuOption,this),this.toggle_visibility(!(null==e?void 0:e.length)))}menuOption(e,t){const n=document.createElement("li");n.setAttribute("role","menuitem"),n.setAttribute("aria-selected","false"),n.setAttribute("tabindex","0"),e.icon&&n.append(e.icon);const s=document.createElement("span");s.textContent=e.text,n.append(s),n.addEventListener("click",()=>{this.select_item(t),"function"==typeof e.onclick&&e.onclick()}),this.olEle.appendChild(n),e.selected&&this.select_item(t)}select_item(e){this.options.forEach((t,s)=>{t.classList.toggle(n,s===e)})}unselect_item(){this.options.forEach(e=>{e.classList.remove(n)})}toggle_visibility(e){this.classList.toggle(s,e),this.menu.style.setProperty("display",e?"none":"flex")}}function i(){Array.from(document.querySelectorAll(".fp-engine")).forEach(e=>{var t;const n=e.root.querySelector("details[open].fp-menu-container");n&&(n.open=!1,null===(t=n.querySelector("summary"))||void 0===t||t.removeAttribute("aria-expanded"),e.root.classList.toggle("has-menu-opened",!1))})}function o(){return Math.random().toString(36).replace(/[^a-z]+/g,"").substr(0,5)}function l(e,t,n){const s=function(e,t){const n=new CustomEvent(e,{detail:t,cancelable:!0});return t&&Object.defineProperty(n,"data",{get:()=>t}),n}(t,n);return e.dispatchEvent(s),e}document.addEventListener("click",(function(e){this.active_menu&&!e.composedPath().includes(this.active_menu)&&(i(),this.active_menu=void 0)})),function(){let e=!1;try{const t=Object.defineProperty({},"passive",{get:function(){e=!0}});window.addEventListener("testPassive",null,t),window.removeEventListener("testPassive",null,t)}catch(e){}}();var r,a=Object.freeze({__proto__:null,SET_QUALITY:"quality:set",TRACKS:"quality:tracks",SWITCH:"quality:update",QUALITIES:"qualities"});const u=((r=class Qsel{constructor(e){((e,t,n)=>{window.customElements.get(t)||window.customElements.define(t,n),e.customElements.get(t)||e.customElements.set(t,t)})(e,"flowplayer-quality-menu",FlowplayerMenu)}init(n,s,i){if(!1===n.qsel)return;const o=t(i,"flowplayer-quality-menu");o instanceof FlowplayerMenu&&o.setMenuAttrs({summaryTitle:"HD",menuTitle:i.i18n("qsel.menu_title"),class:"fp-qsel",options_event:r.events.TRACKS,item_selected_event:r.events.SWITCH}),i.on("mount",(function(){var e;null===(e=function(e,t){const n=e._customElements.get(t);return n&&e.root.querySelector(n)||void 0}(i,i.hasState("is-tv")?"flowplayer-tv-menu":"flowplayer-control"))||void 0===e||e.append(o)})),i.on("qualities",t=>{if(!Array.isArray(t.detail))return;const s=t.detail,a=e(n,"qsel.labels",[]);l(o,r.events.TRACKS,s.flatMap((e,t)=>{if("boolean"==typeof a[t]&&!a[t])return[];let n=e.height?e.height+"p":e.text;return"number"==typeof e.height&&e.height>719&&(n+=" HD"),{text:a[t]||n,onclick:c.bind(0,i,e)}})),o instanceof FlowplayerMenu&&o.toggle_visibility(s.length<2)})}}).events=a,r);function c(e,t){e.emit("quality:set",t)}return function(e,t){if("object"==typeof exports&&"undefined"!=typeof module)return t;if(null===document.currentScript)return t;"flowplayer"in e||(e.flowplayer={extensions:[]});const n=e.flowplayer;return"function"==typeof n?(n(t),t):(Array.isArray(n.extensions)||(n.extensions=[]),~n.extensions.indexOf(t)||n.extensions.push(t),t)}(window,u)}));
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):((e="undefined"!=typeof globalThis?globalThis:e||self).flowplayer=e.flowplayer||{},e.flowplayer.qsel=t())}(this,(function(){"use strict";function e(e,t,n){const s=function(e){return Array.isArray(e)?e.slice(0):e.split(".")}(t);for(;s.length;){if(null==e)return n;const t=s.shift();if("string"!=typeof t)return n;e=e[t]}return null==e?n:e}const t=(e,t)=>new(((e,t)=>{const n=e.get(t);if(!n)throw new Error(`no flowplayer component with the name ${t} exists`);const s=window.customElements.get(t);if(!s)throw new Error(`no default flowplayer component with the name ${t} exists`);const i=window.customElements.get(n);return"function"!=typeof i?s:i})(e._customElements,t))(e);class FlowplayerComponent extends HTMLElement{constructor(e){super(),this.player=e}}const n="fp-on",s="fp-invis";class FlowplayerMenu extends FlowplayerComponent{constructor(e){super(e),this.player=e,this.menuContainer=document.createElement("details"),this.summaryEle=document.createElement("summary"),this.menuHeader=document.createElement("div"),this.menuTitle=document.createElement("h3"),this.olEle=document.createElement("ol"),this.olEle.id=o(),this.menu=document.createElement("div"),this.closeEle=document.createElement("span"),this.menuHeader.classList.add("fp-menu-header"),this.menuHeader.append(this.menuTitle,this.closeEle),this.menu.classList.add("fp-menu"),this.menu.append(this.menuHeader,this.olEle),this.closeEle.classList.add("fp-close"),this.closeEle.textContent="×",this.menuContainer.classList.add("fp-menu-container"),this.menuContainer.append(this.summaryEle,this.menu),this.menuContainer.addEventListener("click",t=>{if(t.defaultPrevented)return;t.preventDefault();const n=this.menuContainer.open;n||(i(),document.active_menu=this.menuContainer),this.menuContainer.open=!n,e.root.classList.toggle("has-menu-opened",!n),this.summaryEle.setAttribute("aria-expanded",n?"false":"true")}),this.addEventListener("focusin",e=>{const t=e.target;t instanceof HTMLLIElement&&t.setAttribute("aria-selected","true")}),this.addEventListener("focusout",e=>{const t=e.target;t instanceof HTMLLIElement&&t.setAttribute("aria-selected","false")}),this.append(this.menuContainer),this.olEle.setAttribute("aria-labelledby",this.summaryEle.id),this.olEle.setAttribute("role","menu"),this.summaryEle.setAttribute("aria-haspopup","true"),this.summaryEle.setAttribute("aria-controls",this.olEle.id),this.summaryEle.setAttribute("tabindex","0"),this.summaryEle.setAttribute("aria-expanded","false"),this.summaryEle.setAttribute("role","button")}get options(){return this.olEle.querySelectorAll("li")}setMenuAttrs(e){if(this.className=e.class,this.toggle_visibility(!0),this.summaryEle.id||(this.summaryEle.id=e.id||o()),this.summaryEle.setAttribute("aria-label",e.menuTitle||"Menu"),e.summaryTitle&&(this.summaryEle.textContent=e.summaryTitle),e.summaryIcon){const n=t(this.player,e.summaryIcon);n.setAttribute("tabindex",""),this.summaryEle.append(n)}e.menuTitle&&(this.menuTitle.textContent=e.menuTitle),this.menu.classList.toggle("fp-icons",!!e.icons),this.addEventListener(e.options_event,e=>{this.render(e.data)}),e.item_selected_event&&this.addEventListener(e.item_selected_event,e=>{void 0!==e.data&&this.select_item(e.data.selected_index)})}render(e){this.olEle&&(this.olEle.innerHTML="",e&&e.forEach(this.menuOption,this),this.toggle_visibility(!(null==e?void 0:e.length)))}menuOption(e,t){const n=document.createElement("li");n.setAttribute("role","menuitem"),n.setAttribute("aria-selected","false"),n.setAttribute("tabindex","0"),e.icon&&n.append(e.icon);const s=document.createElement("span");s.textContent=e.text,n.append(s),n.addEventListener("click",()=>{this.select_item(t),"function"==typeof e.onclick&&e.onclick()}),this.olEle.appendChild(n),e.selected&&this.select_item(t)}select_item(e){this.options.forEach((t,s)=>{t.classList.toggle(n,s===e)})}unselect_item(){this.options.forEach(e=>{e.classList.remove(n)})}toggle_visibility(e){this.classList.toggle(s,e),this.menu.style.setProperty("display",e?"none":"flex")}}function i(){Array.from(document.querySelectorAll(".fp-engine")).forEach(e=>{var t;const n=e.root.querySelector("details[open].fp-menu-container");n&&(n.open=!1,null===(t=n.querySelector("summary"))||void 0===t||t.removeAttribute("aria-expanded"),e.root.classList.toggle("has-menu-opened",!1))})}function o(){return Math.random().toString(36).replace(/[^a-z]+/g,"").substr(0,5)}function l(e,t,n){const s=function(e,t){const n=new CustomEvent(e,{detail:t,cancelable:!0});return t&&Object.defineProperty(n,"data",{get:()=>t}),n}(t,n);return e.dispatchEvent(s),e}document.addEventListener("click",(function(e){this.active_menu&&!e.composedPath().includes(this.active_menu)&&(i(),this.active_menu=void 0)})),function(){let e=!1;try{const t=Object.defineProperty({},"passive",{get:function(){e=!0}});window.addEventListener("testPassive",null,t),window.removeEventListener("testPassive",null,t)}catch(e){}}();var r,a=Object.freeze({__proto__:null,SET_QUALITY:"quality:set",TRACKS:"quality:tracks",SWITCH:"quality:update",QUALITIES:"qualities"});const u=((r=class Qsel{constructor(e){((e,t,n)=>{window.customElements.get(t)||window.customElements.define(t,n),e.customElements.get(t)||e.customElements.set(t,t)})(e,"flowplayer-quality-menu",FlowplayerMenu)}init(n,s,i){if(!1===n.qsel)return;const o=t(i,"flowplayer-quality-menu");o instanceof FlowplayerMenu&&o.setMenuAttrs({summaryTitle:"HD",menuTitle:i.i18n("qsel.menu_title"),class:"fp-qsel",options_event:r.events.TRACKS,item_selected_event:r.events.SWITCH}),i.on("mount",(function(){var e;null===(e=function(e,t){const n=e._customElements.get(t);return n&&e.root.querySelector(n)||void 0}(i,i.hasState("is-tv")?"flowplayer-tv-menu":"flowplayer-control"))||void 0===e||e.append(o)})),i.on("qualities",t=>{if(!Array.isArray(t.detail))return;const s=t.detail,a=e(n,"qsel.labels",[]);l(o,r.events.TRACKS,s.flatMap((e,t)=>"boolean"!=typeof a[t]||a[t]?{text:m(e,a[t]),onclick:c.bind(0,i,e)}:[])),o instanceof FlowplayerMenu&&o.toggle_visibility(s.length<2)})}}).events=a,r);function c(e,t){e.emit("quality:set",t)}function m(e,t){return t||(e.height?`${e.height}p${e.height>719?" HD":""}`:e.width?`${e.width}p${e.height>1279?" HD":""}`:"name"in e&&e.name?e.name:"0p")}return function(e,t){if("object"==typeof exports&&"undefined"!=typeof module)return t;if(null===document.currentScript)return t;"flowplayer"in e||(e.flowplayer={extensions:[]});const n=e.flowplayer;return"function"==typeof n?(n(t),t):(Array.isArray(n.extensions)||(n.extensions=[]),~n.extensions.indexOf(t)||n.extensions.push(t),t)}(window,u)}));