@gcorevideo/player 2.20.8 → 2.20.9

package/dist/player.d.ts

@@ -218,13 +218,18 @@ export declare class BottomGear extends UICorePlugin {
      * @internal
      */
     render(): this;
-    private refresh;
+    /**
+     * Re-renders the gear menu.
+     * It fires the {@link MediaControlEvents.MEDIACONTROL_GEAR_RENDERED | MEDIACONTROL_GEAR_RENDERED} event,
+     * which the plugins that attach to the gear menu can listen to to re-render themselves.
+     */
+    refresh(): void;
     private toggleGearMenu;
     private hide;
 }
 
 /**
- * Displays useful network-related statistics.
+ * PLUGIN that displays useful network-related statistics.
  * @beta
  *
  * @remarks
@@ -302,7 +307,7 @@ export declare class ClapprNerdStats extends UICorePlugin {
 }
 
 /**
- * Collects useful statistics about playback performance.
+ * PLIGIN that collects useful statistics about playback performance.
  * @beta
  * @remarks
  * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.
@@ -338,7 +343,7 @@ export declare class ClapprStats extends ContainerPlugin {
     private _stop;
     /**
      * Registers a callback to receive the metrics.
-     * @param updateMetricsFn
+     * @param updateMetricsFn - The callback to receive the metrics
      */
     setUpdateMetrics(updateMetricsFn: MetricsUpdateFn): void;
     private _defaultReport;
@@ -353,10 +358,10 @@ export declare class ClapprStats extends ContainerPlugin {
     destroy(): void;
     /**
      * Returns the collected metrics.
-     * @returns The collected metrics
+     * @returns Currently collected metrics
      */
     exportMetrics(): Metrics;
-    onBitrate(newBitrate: QualityLevel): void;
+    private onBitrate;
     private stopReporting;
     private startTimers;
     private onFirstPlaying;
@@ -408,7 +413,7 @@ export declare class ClickToPause extends ContainerPlugin {
 }
 
 /**
- * Adds a behavior of showing a text over the seekbar to indicate the current clip.
+ * PLUGIN that shows text over the seekbar to indicate the current clip.
  * @beta
  * @remarks
  * Depends on:
@@ -455,7 +460,8 @@ export declare class ClipsPlugin extends UICorePlugin {
 }
 
 /**
- * Configuration options
+ * Configuration options for the {@link ClipsPlugin | clips} plugin.
+ * @beta
  */
 export declare interface ClipsPluginSettings {
     /**
@@ -464,6 +470,13 @@ export declare interface ClipsPluginSettings {
     text: string;
 }
 
+/**
+ * @beta
+ */
+export declare type ContainerPluginConstructor = ((container: unknown) => PlayerPlugin) & {
+    type: 'container';
+};
+
 /**
  * Dimensions of the player container DOM element.
  * @beta
@@ -539,6 +552,13 @@ export declare interface ContextMenuPluginSettings {
     preventShowContextMenu?: boolean;
 }
 
+/**
+ * @beta
+ */
+export declare type CorePluginConstructor = ((core: unknown) => PlayerPlugin) & {
+    type: 'core';
+};
+
 /**
  * A plain JS object that must conform to the DASH.js settings schema.
  * @beta
@@ -588,7 +608,7 @@ export declare class DvrControls extends UICorePlugin {
      */
     bindEvents(): void;
     private bindContainerEvents;
-    private dvrChanged;
+    private onDvrChanged;
     private click;
     private settingsUpdate;
     private shouldRender;
@@ -598,6 +618,24 @@ export declare class DvrControls extends UICorePlugin {
     render(): this;
 }
 
+/**
+ * An error fired in the player and plugins code to be handled in the UI
+ * @beta
+ */
+export declare type ErrorDesc = {
+    description: string;
+    level: string;
+    code: string;
+    origin: string;
+    scope: string;
+    raw?: string;
+    UI?: {
+        icon?: string;
+        title: string;
+        message: string;
+    };
+};
+
 /**
  * Levels of severity of errors. Non-fatal errors usually can be ignored.
  * @beta
@@ -605,43 +643,61 @@ export declare class DvrControls extends UICorePlugin {
 export declare type ErrorLevel = 'FATAL' | 'WARN' | 'INFO';
 
 /**
- * Displays a descriptive error in the overlay on top of the player.
+ * PLUGIN that displays errors nicely in the overlay on top of the player.
  * @beta
  */
 export declare class ErrorScreen extends UICorePlugin {
-    private _retry;
     private err;
-    private hideValue;
-    private timeout;
-    private reloadButton;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
-    get template(): any;
-    get container(): any;
+    private static readonly template;
+    /**
+     * @internal
+     */
     get attributes(): {
         class: string;
         'data-error-screen': string;
     };
+    /**
+     * @internal
+     */
     bindEvents(): void;
-    private onCoreReady;
     private onPlay;
-    private destroyError;
-    unBindEvents(): void;
-    private bindReload;
+    private unmount;
+    /**
+     * @internal
+     */
+    get events(): {
+        'click .player-error-screen__reload': string;
+    };
     private reload;
-    private unbindReload;
-    private onContainerChanged;
-    private onStartAd;
-    private onFinishAd;
+    private onActiveContainerChanged;
     private onError;
-    private drying;
-    show(err?: PresentationalError): void;
-    hide(): void;
+    /**
+     * @internal
+     */
     render(): this;
 }
 
+/**
+ * Configuration options for the {@link ErrorScreen | error screen} plugin.
+ * @beta
+ */
+export declare type ErrorScreenPluginSettings = {
+    /**
+     * Whether to hide the reload button.
+     */
+    noReload?: boolean;
+};
+
 /**
  * The plugin adds custom favicon to the player's tab.
  * @beta
@@ -669,17 +725,6 @@ export declare class Favicon extends CorePlugin {
     private changeIcon;
 }
 
-/**
- * Custom events emitted by the plugin
- * @beta
- */
-export declare enum GearEvents {
-    /**
-     * Emitted when the gear menu is rendered
-     */
-    MEDIACONTROL_GEAR_RENDERED = "mediacontrol:gear:rendered"
-}
-
 /**
  * An element inside the gear menu
  * @beta
@@ -727,31 +772,6 @@ export declare interface InitEventData {
     event: TelemetryEvent.Init;
 }
 
-declare type KeyboardEventHandler = (e: KeyboardEvent) => boolean | undefined;
-
-/**
- * @internal
- */
-export declare class Kibo {
-    private element;
-    private lastKeyCode;
-    private lastModifiers;
-    private keysDown;
-    private keysUp;
-    private downHandler;
-    private upHandler;
-    constructor(element?: Document | Element);
-    private handler;
-    private registerKeys;
-    private unregisterKeys;
-    off(keys: string | string[]): Kibo;
-    delegate(upOrDown: UpDown, keys: string | string[], func?: KeyboardEventHandler | null): Kibo;
-    down(keys: string | string[], func?: KeyboardEventHandler | null): Kibo;
-    up(keys: string | string[], func?: KeyboardEventHandler | null): Kibo;
-    lastKey(modifier?: string): string | boolean;
-    lastModifiersAndKey(): string;
-}
-
 /**
  * An ISO 639-1 language code.
  * @example `pt`
@@ -760,7 +780,7 @@ export declare class Kibo {
 export declare type LangTag = string;
 
 /**
- * A {@link MediaControl | media control} plugin that provides a UI to control the quality level of the playback.
+ * PLUGIN that provides a UI to select the desired quality level of the playback.
  * @beta
  *
  * @remarks
@@ -770,15 +790,9 @@ export declare type LangTag = string;
  *
  * - {@link BottomGear}
  *
- * The plugin is rendered as an item in the gear menu.
- *
- * When clicked, it shows a list of quality levels to choose from.
+ * The plugin is rendered as an item in the gear menu, which, when clicked, shows a list of quality levels to choose from.
  *
- * Configuration options:
- *
- * - `labels`: The labels to show in the level selector. [video resolution]: string
- *
- * - `restrictResolution`: The maximum resolution to allow in the level selector.
+ * Configuration options - {@link LevelSelectorPluginSettings}
  *
  * @example
  * ```ts
@@ -830,6 +844,8 @@ export declare class LevelSelector extends UICorePlugin {
      * @internal
      */
     bindEvents(): void;
+    private onCoreReady;
+    private onGearRendered;
     private bindPlaybackEvents;
     private onStop;
     private shouldRender;
@@ -857,6 +873,25 @@ export declare class LevelSelector extends UICorePlugin {
     private deferRender;
 }
 
+/**
+ * Configuration options for the {@link LevelSelector | level selector} plugin.
+ * @beta
+ */
+export declare interface LevelSelectorPluginSettings {
+    /**
+     * The maximum resolution to allow in the level selector.
+     */
+    restrictResolution?: number;
+    /**
+     * The labels to show in the level selector.
+     * @example
+     * ```ts
+     * { 360: 'SD', 720: 'HD' }
+     * ```
+     */
+    labels?: Record<number, string>;
+}
+
 export { Logger }
 
 /**
@@ -893,7 +928,7 @@ export declare class Logo extends UIContainerPlugin {
 export { LogTracer }
 
 /**
- * The MediaControl provides a foundation for developing custom media controls UI.
+ * PLUGIN that provides a foundation for developing custom media controls UI.
  * @beta
  * @remarks
  * The methods exposed are to be used by the other plugins that extend the media control UI.
@@ -970,12 +1005,12 @@ export declare class MediaControl extends UICorePlugin {
     private get disabled();
     /**
      * @internal
-     * @deprecated
+     * @deprecated Use core.activeContainer directly
      */
     get container(): any;
     /**
      * @internal
-     * @deprecated
+     * @deprecated Use core.activePlayback directly
      */
     get playback(): any;
     /**
@@ -1015,6 +1050,7 @@ export declare class MediaControl extends UICorePlugin {
         'mouseenter .media-control-layer[data-controls]': string;
         'mouseleave .media-control-layer[data-controls]': string;
     };
+    get currentSeekPos(): number;
     /**
      * Current volume [0..100]
      */
@@ -1037,7 +1073,7 @@ export declare class MediaControl extends UICorePlugin {
     bindEvents(): void;
     private bindContainerEvents;
     /**
-     * Disables the plugin and unmounts its UI
+     * Hides the media control UI
      */
     disable(): void;
     /**
@@ -1159,13 +1195,16 @@ export declare class MediaControl extends UICorePlugin {
  */
 export declare type MediaControlElement = 'audioTracksSelector' | 'bottomGear' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'subtitlesSelector';
 
-declare type MediaSourceInfo = {
-    live: boolean;
-    source: string;
-    id: number;
-    dvr: boolean;
-    projection: string | null;
-};
+/**
+ * Custom events emitted by the plugins to communicate with one another
+ * @beta
+ */
+export declare enum MediaControlEvents {
+    /**
+     * Emitted when the gear menu is rendered
+     */
+    MEDIACONTROL_GEAR_RENDERED = "mediacontrol:gear:rendered"
+}
 
 /**
  * Media delivery protocol
@@ -1221,7 +1260,7 @@ declare type Metrics = {
 declare type MetricsUpdateFn = (metrics: Metrics) => void;
 
 /**
- * The plugin adds support for loading multiple streams and switching between them using the media control UI.
+ * PLUGIN that adds support for loading multiple streams and switching between them using the media control UI.
  * @beta
  */
 export declare class MultiCamera extends UICorePlugin {
@@ -1262,8 +1301,8 @@ export declare class MultiCamera extends UICorePlugin {
     private showError;
     private hideError;
     private changeById;
-    getCamerasList(): MediaSourceInfo[];
-    getCurrentCamera(): MediaSourceInfo | null;
+    private getCamerasList;
+    private getCurrentCamera;
     private findElementById;
     private findIndexById;
     private onShowLevelSelectMenu;
@@ -1352,6 +1391,13 @@ export declare interface PlaybackError {
      * Component subsystem of the error origin
      */
     scope: PlayerComponentType;
+    /**
+     * UI description of the error.
+     */
+    UI?: {
+        title: string;
+        message: string;
+    };
 }
 
 /**
@@ -1362,15 +1408,15 @@ export declare enum PlaybackErrorCode {
     /**
      * An unknown or uncategorised error.
      */
-    Generic = 0,
+    Generic = "GENERIC_ERROR",
     /**
      * The media source is not available. Typically a network error.
      */
-    MediaSourceUnavailable = 1,
+    MediaSourceUnavailable = "MEDIA_SOURCE_UNAVAILABLE",
     /**
      * The media source is not accessible due to some protection policy.
      */
-    MediaSourceAccessDenied = 3
+    MediaSourceAccessDenied = "MEDIA_SOURCE_ACCESS_DENIED"
 }
 
 /**
@@ -1380,7 +1426,7 @@ export declare enum PlaybackErrorCode {
 export declare type PlaybackModule = 'dash' | 'hls' | 'html5_video';
 
 /**
- * Allows changing the playback speed of the video.
+ * PLUGIN that allows changing the playback speed of the video.
  * @beta
  *
  * @remarks
@@ -1390,12 +1436,12 @@ export declare type PlaybackModule = 'dash' | 'hls' | 'html5_video';
  *
  * - {@link BottomGear | bottom_gear}
  *
- * It renders a button in the gear menu, which opens a dropdown with the available playback rates.
+ * It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate.
  */
 export declare class PlaybackRate extends UICorePlugin {
-    private currentPlayback;
     private playbackRates;
     private prevSelectedRate;
+    private rendered;
     private selectedRate;
     /**
      * @internal
@@ -1407,9 +1453,9 @@ export declare class PlaybackRate extends UICorePlugin {
     get supportedVersion(): {
         min: string;
     };
-    private static readonly template;
     private static readonly buttonTemplate;
     private static readonly listTemplate;
+    constructor(core: Core);
     /**
      * @internal
      */
@@ -1429,12 +1475,13 @@ export declare class PlaybackRate extends UICorePlugin {
      * @internal
      */
     bindEvents(): void;
-    private unBindEvents;
+    private onCoreReady;
+    private onActiveContainerChange;
+    private onGearRendered;
+    private onDvrStateChanged;
     private allRateElements;
     private rateElement;
-    private onDashRateChange;
-    private updateLiveStatus;
-    private reload;
+    private onPlaybackRateChange;
     private shouldRender;
     /**
      * @internal
@@ -1443,11 +1490,11 @@ export declare class PlaybackRate extends UICorePlugin {
     private onStartAd;
     private onFinishAd;
     private onPlay;
+    private resetPlaybackRate;
     private onStop;
     private onRateSelect;
     private onShowMenu;
     private goBack;
-    private updatePlaybackRate;
     private setSelectedRate;
     private getTitle;
     private highlightCurrentRate;
@@ -1626,12 +1673,14 @@ export declare class Player {
      * Player.registerPlugin(MyPlugin)
      * ```
      */
-    static registerPlugin(plugin: PlayerPlugin): void;
+    static registerPlugin(plugin: PlayerPluginConstructor): void;
+    private static getRegisteredPlugins;
+    private static corePlugins;
     /**
      * Unregisters a plugin registered earlier with {@link Player.registerPlugin}.
      * @param plugin - a plugin class
      */
-    static unregisterPlugin(plugin: PlayerPlugin): void;
+    static unregisterPlugin(plugin: PlayerPluginConstructor): void;
     private setConfig;
     private initPlayer;
     private tuneIn;
@@ -1857,13 +1906,19 @@ export declare interface PlayerMediaSourceDesc {
 
 /**
  * @beta
- * @see {@link https://clappr.github.io/classes/UIContainerPlugin.html}, {@link https://clappr.github.io/classes/ContainerPlugin.html}
+ * @see {@link https://clappr.github.io/classes/UIContainerPlugin.html},
+ * {@link https://clappr.github.io/classes/ContainerPlugin.html}
  */
 export declare type PlayerPlugin = {
     new (...args: any[]): unknown;
     name: string;
 };
 
+/**
+ * @beta
+ */
+export declare type PlayerPluginConstructor = CorePluginConstructor | ContainerPluginConstructor;
+
 /**
  * Displays a poster image in the background and a big play button on top when playback is stopped
  * @beta
@@ -1958,14 +2013,6 @@ export declare class Poster extends UIContainerPlugin {
     destroy(): this;
 }
 
-declare type PresentationalError = {
-    title: string;
-    message: string;
-    code: string;
-    icon: string;
-    reloadIcon: string;
-};
-
 /**
  * A level of quality within a media source.
  * @beta
@@ -2036,7 +2083,8 @@ export { SentryTracer }
 export { setTracer }
 
 /**
- * The plugin adds a share button to the media control UI.
+ * PLUGIN that adds a share button to the media control UI.
+ * @beta
  */
 export declare class Share extends UICorePlugin {
     private hide;
@@ -2075,7 +2123,8 @@ export declare class Share extends UICorePlugin {
 }
 
 /**
- * The plugin adds skip controls to the media control UI.
+ * PLUGIN that adds skip controls to the media control UI.
+ * @beta
  */
 export declare class SkipTime extends UICorePlugin {
     get name(): string;
@@ -2125,6 +2174,7 @@ export declare class SourceController extends CorePlugin {
     private currentSourceIndex;
     private sourcesDelay;
     private active;
+    private switching;
     private sync;
     /**
      * @internal
@@ -2141,7 +2191,8 @@ export declare class SourceController extends CorePlugin {
      * @internal
      */
     bindEvents(): void;
-    private onReady;
+    private onCoreReady;
+    private onActiveContainerChanged;
     private bindContainerEventListeners;
     private reset;
     private retryPlayback;
@@ -2154,6 +2205,7 @@ export declare class SourceController extends CorePlugin {
 
 /**
  * Custom events emitted by the plugin
+ * @beta
  */
 export declare enum SpinnerEvents {
     /**
@@ -2164,12 +2216,15 @@ export declare enum SpinnerEvents {
 }
 
 /**
- * Shows a pending operation indicator when playback is buffering or in other appropriate cases
+ * PLUGIN that shows a pending operation indicator when playback is buffering or in a similar state
  * @beta
  * @remarks
- * The plugin emits
+ * Events emitted- {@link SpinnerEvents}
+ * Other plugins can use {@link SpinnerThreeBounce.show | show} and {@link SpinnerThreeBounce.hide | hide} methods to
+ * implement custom pending/progress indication scenarios.
  */
 export declare class SpinnerThreeBounce extends UIContainerPlugin {
+    private userShown;
     /**
      * @internal
      */
@@ -2198,13 +2253,17 @@ export declare class SpinnerThreeBounce extends UIContainerPlugin {
     private onStop;
     private onError;
     /**
-     * Shows the spinner
+     * Shows the spinner.
+     *
+     * When called, the spinner will not hide (due to its built-in logic) until {@link SpinnerThreeBounce.hide} is called
      */
-    show(): void;
+    show(delay?: number): void;
     /**
-     * Hides the spinner
+     * Hides the spinner.
      */
     hide(): void;
+    private _show;
+    private _hide;
     /**
      * @internal
      */
@@ -2348,7 +2407,7 @@ export declare class Subtitles extends UICorePlugin {
 }
 
 /**
- * Collects and reports the performance statistics.
+ * PLUGIN that collects and reports the performance statistics.
  * @beta
  * @remarks
  * This plugin is experimental and its API is likely to change.
@@ -2460,7 +2519,7 @@ export declare type TelemetryRecord = {
  * @param data - The telemetry record to send.
  * @beta
  */
-declare type TelemetrySendFn = (data: TelemetryRecord) => void;
+export declare type TelemetrySendFn = (data: TelemetryRecord) => void;
 
 /**
  * Displays the thumbnails of the video when available.
@@ -2576,11 +2635,6 @@ export declare type TimeProgress = TimePosition & {
     start: number;
 };
 
-/**
- * @internal
- */
-export declare type TimerId = ReturnType<typeof setTimeout>;
-
 /**
  * For the plugin development
  * @beta
@@ -2634,8 +2688,6 @@ export declare type TranslationSettings = Partial<Record<LangTag, Record<Transla
  */
 export declare type TransportPreference = MediaTransport;
 
-declare type UpDown = 'up' | 'down';
-
 /**
  * Version information about the gplayer and its main dependencies
  * @returns Version information about the gplayer and its main dependencies