@gcorevideo/player 2.20.1 → 2.20.4

package/dist/player.d.ts

@@ -28,41 +28,63 @@ import { UICorePlugin } from '@clappr/core';
 import { UIObject } from '@clappr/core';
 
 /**
+ * Adds an audio track selector to the media control UI.
  * @beta
  */
 export declare class AudioSelector extends UICorePlugin {
     private selectedTrackId;
     private currentTrack;
     private tracks;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
+    /**
+     * @internal
+     */
     static get version(): string;
-    get template(): any;
+    private static readonly template;
+    /**
+     * @internal
+     */
     get attributes(): {
         class: string;
         'data-track-selector': string;
     };
+    /**
+     * @internal
+     */
     get events(): {
         'click [data-track-selector-select]': string;
         'click [data-track-selector-button]': string;
     };
+    /**
+     * @internal
+     */
     bindEvents(): void;
-    unBindEvents(): void;
+    private unBindEvents;
     private bindPlaybackEvents;
     private setupAudioTrackListeners;
     private onStop;
-    reload(): void;
+    private reload;
     private shouldRender;
+    /**
+     * @internal
+     */
     render(): this;
     private fillTracks;
     private findTrackBy;
     private onTrackSelect;
     private setIndexTrack;
-    onShowLevelSelectMenu(): void;
-    hideSelectTrackMenu(): void;
-    toggleContextMenu(): void;
+    private onShowLevelSelectMenu;
+    private hideSelectTrackMenu;
+    private toggleContextMenu;
     private buttonElement;
     private buttonElementText;
     private trackElement;
@@ -76,6 +98,8 @@ export declare class AudioSelector extends UICorePlugin {
 }
 
 /**
+ * Displays a big mute button over the video when it's muted.
+ * Once pressed, it unmutes the video.
  * @beta
  */
 export declare class BigMuteButton extends UICorePlugin {
@@ -83,17 +107,28 @@ export declare class BigMuteButton extends UICorePlugin {
     private _adIsPlaying;
     private $bigMuteBtnContainer;
     private $bigMuteButton;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
-    get template(): any;
+    private static readonly template;
+    /**
+     * @internal
+     */
     get events(): {
         'click .big-mute-icon': string;
         'click .big-mute-icon-wrapper': string;
     };
+    /**
+     * @internal
+     */
     bindEvents(): void;
-    private unBindEvents;
     private onCoreReady;
     private onContainerVolume;
     private onContainerStart;
@@ -102,6 +137,9 @@ export declare class BigMuteButton extends UICorePlugin {
     private onStartAd;
     private onFinishAd;
     private shouldRender;
+    /**
+     * @internal
+     */
     render(): this;
     private hideBigMuteBtn;
     private showBigMuteBtn;
@@ -109,6 +147,9 @@ export declare class BigMuteButton extends UICorePlugin {
     private handleBigMuteBtnClick;
 }
 
+/**
+ * @beta
+ */
 declare type BitrateTrackRecord = {
     start: number;
     end?: number;
@@ -261,7 +302,10 @@ export declare class ClapprNerdStats extends UICorePlugin {
 }
 
 /**
+ * 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.
  */
 export declare class ClapprStats extends ContainerPlugin {
     private bwMeasureCount;
@@ -276,27 +320,47 @@ export declare class ClapprStats extends ContainerPlugin {
     private updateFn;
     private urisToMeasureBandwidth;
     private uriToMeasureLatency;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
-    get _playbackName(): string;
-    get _playbackType(): any;
+    private get _playbackName();
+    private get _playbackType();
     private _now;
     private _inc;
     private start;
     private _stop;
+    /**
+     * Registers a callback to receive the metrics.
+     * @param updateMetricsFn
+     */
     setUpdateMetrics(updateMetricsFn: MetricsUpdateFn): void;
-    _defaultReport(metrics: Metrics): void;
+    private _defaultReport;
     constructor(container: Container);
+    /**
+     * @internal
+     */
     bindEvents(): void;
+    /**
+     * @internal
+     */
     destroy(): void;
+    /**
+     * Returns the collected metrics.
+     * @returns The collected metrics
+     */
     exportMetrics(): Metrics;
     onBitrate(newBitrate: QualityLevel): void;
-    stopReporting(): void;
-    startTimers(): void;
-    onFirstPlaying(): void;
-    playAfterPause(): void;
+    private stopReporting;
+    private startTimers;
+    private onFirstPlaying;
+    private playAfterPause;
     private onPlay;
     private onPause;
     private onSeek;
@@ -307,7 +371,7 @@ export declare class ClapprStats extends ContainerPlugin {
     private onProgress;
     private _newMetrics;
     private _onCompletion;
-    _buildReport(): void;
+    private _buildReport;
     private _fetchFPS;
     private _calculateBitrates;
     private _calculatePercentages;
@@ -316,14 +380,26 @@ export declare class ClapprStats extends ContainerPlugin {
     private _measureBandwidth;
 }
 
+/**
+ * Adds a behavior of toggling the playback state on click over the container
+ * @beta
+ */
 export declare class ClickToPause extends ContainerPlugin {
     private pointerEnabled;
     private timer;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
-    get config(): any;
+    /**
+     * @internal
+     */
     bindEvents(): void;
     private click;
     private settingsUpdate;
@@ -331,30 +407,63 @@ export declare class ClickToPause extends ContainerPlugin {
     private clearTimer;
 }
 
+/**
+ * Adds a behavior of showing a text over the seekbar to indicate the current clip.
+ * @beta
+ * @remarks
+ * Depends on:
+ *
+ * - {@link MediaControl}
+ *
+ * Configuration options - {@link ClipsPluginSettings}
+ */
 export declare class ClipsPlugin extends UICorePlugin {
     private clips;
     private duration;
     private durationGetting;
     private _oldContainer;
     private svgMask;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get attributes(): {
         class: string;
     };
+    /**
+     * @internal
+     */
     bindEvents(): void;
     private _onCoreReady;
-    unbindEvents(): void;
     private _onMediaControlContainerChanged;
     private playerResize;
     private _bindContainerEvents;
     private onTimeUpdate;
     private parseClips;
+    /**
+     * Returns the text of the current clip.
+     * @param time - The current time of the player.
+     * @returns The text of the current clip.
+     */
     getText(time: number): string;
-    makeSvg(duration: number): void;
+    private makeSvg;
     private setSVGMask;
     private setClipText;
 }
 
+/**
+ * Configuration options
+ */
+export declare interface ClipsPluginSettings {
+    /**
+     * The text to display over the seekbar.
+     */
+    text: string;
+}
+
 /**
  * Dimensions of the player container DOM element.
  * @beta
@@ -364,38 +473,70 @@ export declare type ContainerSize = {
     height: number;
 };
 
-export declare class ContextMenu extends UICorePlugin {
+/**
+ * Displays a small context menu when clicked on the player container.
+ * @beta
+ * @remarks
+ * Configuration options - {@link ContextMenuPluginSettings}
+ */
+export declare class ContextMenu extends UIContainerPlugin {
     private _label;
     private _url;
-    private container;
     private menuOptions;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
+    /**
+     * @internal
+     */
     get attributes(): {
         class: string;
     };
-    get mediaControl(): any;
-    get template(): any;
-    get label(): string;
-    get url(): string;
-    get exposeVersion(): {
-        label: string;
-        name: string;
-    };
+    private static readonly template;
+    private get label();
+    private get url();
+    private get exposeVersion();
+    /**
+     * @internal
+     */
     get events(): {
         'click [data-version]': string;
     };
-    constructor(core: Core);
+    constructor(container: Container);
+    /**
+     * @internal
+     */
     bindEvents(): void;
+    /**
+     * @internal
+     */
     destroy(): UIObject;
-    private containerChanged;
     private toggleContextMenu;
     private show;
     private hide;
     private onOpenMainPage;
+    /**
+     * @internal
+     */
     render(): this;
+    private hideOnBodyClick;
+}
+
+/**
+ * The plugin adds a context menu to the player.
+ * @beta
+ */
+export declare interface ContextMenuPluginSettings {
+    label?: string;
+    url?: string;
+    preventShowContextMenu?: boolean;
 }
 
 /**
@@ -405,20 +546,6 @@ export declare class ContextMenu extends UICorePlugin {
  */
 export declare type DashSettings = Record<string, unknown>;
 
-export declare class DisableControls extends UICorePlugin {
-    get name(): string;
-    get container(): any;
-    get supportedVersion(): {
-        min: string;
-    };
-    bindEvents(): void;
-    unbindEvents(): void;
-    private setDisableStyles;
-    private onCoreReady;
-    private enableControls;
-    private disableAllControls;
-}
-
 /**
  * Adds the DVR controls to the media control UI
  * @beta
@@ -426,7 +553,7 @@ export declare class DisableControls extends UICorePlugin {
  * @remarks
  * Depends on:
  *
- * - {@link MediaControl | media_control}
+ * - {@link MediaControl}
  *
  * The plugin renders the live stream indicator and the DVR seek bar, if DVR is enabled, in the media control UI.
  */
@@ -460,9 +587,7 @@ export declare class DvrControls extends UICorePlugin {
      * @internal
      */
     bindEvents(): void;
-    private bindCoreEvents;
     private bindContainerEvents;
-    private containerChanged;
     private dvrChanged;
     private click;
     private settingsUpdate;
@@ -482,7 +607,6 @@ export declare type ErrorLevel = 'FATAL' | 'WARN' | 'INFO';
 /**
  * Displays a descriptive error in the overlay on top of the player.
  * @beta
- * TODO
  */
 export declare class ErrorScreen extends UICorePlugin {
     private _retry;
@@ -518,6 +642,10 @@ export declare class ErrorScreen extends UICorePlugin {
     render(): this;
 }
 
+/**
+ * The plugin adds custom favicon to the player's tab.
+ * @beta
+ */
 export declare class Favicon extends CorePlugin {
     private _container;
     private oldIcon;
@@ -543,6 +671,7 @@ export declare class Favicon extends CorePlugin {
 
 /**
  * Custom events emitted by the plugin
+ * @beta
  */
 export declare enum GearEvents {
     /**
@@ -557,6 +686,10 @@ export declare enum GearEvents {
  */
 export declare type GearItemElement = 'quality' | 'rate' | 'nerd';
 
+/**
+ * An example Google Analytics integration plugin
+ * @beta
+ */
 export declare class GoogleAnalytics extends ContainerPlugin {
     private account;
     private trackerName;
@@ -586,6 +719,10 @@ export declare class GoogleAnalytics extends ContainerPlugin {
     push(array: string[]): void;
 }
 
+/**
+ * Telemetry init event data
+ * @beta
+ */
 export declare interface InitEventData {
     event: TelemetryEvent.Init;
 }
@@ -722,6 +859,10 @@ export declare class LevelSelector extends UICorePlugin {
 
 export { Logger }
 
+/**
+ * The plugin adds custom logo to the player.
+ * @beta
+ */
 export declare class Logo extends UIContainerPlugin {
     private hasStartedPlaying;
     private $logoContainer;
@@ -1016,7 +1157,7 @@ export declare class MediaControl extends UICorePlugin {
  * Media control elements, mount points for additional plugins
  * @beta
  */
-export declare type MediaControlElement = 'bottomGear' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'subtitlesSelector';
+export declare type MediaControlElement = 'audioTracksSelector' | 'bottomGear' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'subtitlesSelector';
 
 declare type MediaSourceInfo = {
     live: boolean;
@@ -1032,6 +1173,9 @@ declare type MediaSourceInfo = {
  */
 export declare type MediaTransport = 'dash' | 'hls';
 
+/**
+ * @beta
+ */
 declare type Metrics = {
     counters: {
         play: number;
@@ -1071,8 +1215,15 @@ declare type Metrics = {
     custom: Record<string, unknown>;
 };
 
+/**
+ * @beta
+ */
 declare type MetricsUpdateFn = (metrics: Metrics) => void;
 
+/**
+ * The plugin adds support for loading multiple streams and switching between them using the media control UI.
+ * @beta
+ */
 export declare class MultiCamera extends UICorePlugin {
     private currentCamera;
     private currentTime;
@@ -1840,6 +1991,10 @@ export declare interface QualityLevel {
 
 export { reportError_2 as reportError }
 
+/**
+ * The plugin adds a seek time indicator to the media control UI.
+ * @beta
+ */
 export declare class SeekTime extends UICorePlugin {
     get name(): string;
     get supportedVersion(): {
@@ -1880,6 +2035,9 @@ export { SentryTracer }
 
 export { setTracer }
 
+/**
+ * The plugin adds a share button to the media control UI.
+ */
 export declare class Share extends UICorePlugin {
     private hide;
     private container;
@@ -1916,6 +2074,9 @@ export declare class Share extends UICorePlugin {
     onShareEmbedClick(): void;
 }
 
+/**
+ * The plugin adds skip controls to the media control UI.
+ */
 export declare class SkipTime extends UICorePlugin {
     get name(): string;
     get supportedVersion(): {
@@ -2052,6 +2213,7 @@ export declare class SpinnerThreeBounce extends UIContainerPlugin {
 
 /**
  * Playback stall event data
+ * @beta
  */
 export declare interface StallEventData {
     event: TelemetryEvent.Stall;
@@ -2069,6 +2231,10 @@ export declare interface StallEventData {
     time: number;
 }
 
+/**
+ * Telemetry start event data
+ * @beta
+ */
 export declare interface StartEventData {
     event: TelemetryEvent.Start;
 }
@@ -2254,6 +2420,7 @@ export declare class Telemetry extends ContainerPlugin {
 
 /**
  * Telemetry event type
+ * @beta
  */
 export declare enum TelemetryEvent {
     Init = 1,
@@ -2264,11 +2431,13 @@ export declare enum TelemetryEvent {
 
 /**
  * Telemetry event data
+ * @beta
  */
 export declare type TelemetryEventData = StallEventData | InitEventData | StartEventData | WatchEventData;
 
 /**
  * Plugin settings
+ * @beta
  */
 export declare interface TelemetryPluginSettings {
     /**
@@ -2280,6 +2449,7 @@ export declare interface TelemetryPluginSettings {
 
 /**
  * Telemetry record
+ * @beta
  */
 export declare type TelemetryRecord = {
     type: PlaybackType;
@@ -2288,9 +2458,32 @@ export declare type TelemetryRecord = {
 /**
  * Callback to send the telemetry record to the storage.
  * @param data - The telemetry record to send.
+ * @beta
  */
 declare type TelemetrySendFn = (data: TelemetryRecord) => void;
 
+/**
+ * Displays the thumbnails of the video when available.
+ * @beta
+ * @example
+ * ```ts
+ * import { Thumbnails } from '@gcorevideo/player'
+ *
+ * Player.registerPlugin(Thumbnails)
+ *
+ * new Player({
+ *   thumbnails: {
+ *     backdropHeight: 200,
+ *     backdropMinOpacity: 0.9,
+ *     backdropMaxOpacity: 0.99,
+ *     spotlightHeight: 100,
+ *     vtt: '1\n00:00:00,000 --> 00:00:10,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,0,100,56\n\n2\n00:00:10,000 --> 00:00:20,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,0,100,56\n\n3\n00:00:20,000 --> 00:00:30,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,0,100,56\n\n4\n00:00:30,000 --> 00:00:40,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,0,100,56\n\n5\n00:00:40,000 --> 00:00:50,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,0,100,56\n\n6\n00:00:50,000 --> 00:01:00,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,0,100,56\n\n7\n00:01:00,000 --> 00:01:10,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,0,100,56\n\n8\n00:01:10,000 --> 00:01:20,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,56,100,56\n\n9\n00:01:20,000 --> 00:01:30,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,56,100,56\n\n10\n00:01:30,000 --> 00:01:40,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,56,100,56\n\n11\n00:01:40,000 --> 00:01:50,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,56,100,56\n\n12\n00:01:50,000 --> 00:02:00,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,56,100,56\n\n13\n00:02:00,000 --> 00:02:10,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,56,100,56\n\n14\n00:02:10,000 --> 00:02:20,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,56,100,56\n\n15\n00:02:20,000 --> 00:02:30,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,112,100,56\n\n16\n00:02:30,000 --> 00:02:40,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,112,100,56\n\n17\n00:02:40,000 --> 00:02:50,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,112,100,56\n\n18\n00:02:50,000 --> 00:03:00,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,112,100,56\n\n19\n00:03:00,000 --> 00:03:10,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,112,100,56\n\n20\n00:03:10,000 --> 00:03:20,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,112,100,56\n\n21\n00:03:20,000 --> 00:03:30,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,112,100,56\n\n22\n00:03:30,000 --> 00:03:40,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,168,100,56\n\n23\n00:03:40,000 --> 00:03:50,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,168,100,56\n\n24\n00:03:50,000 --> 00:04:00,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,168,100,56\n\n25\n00:04:00,000 --> 00:04:10,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,168,100,56\n\n26\n00:04:10,000 --> 00:04:20,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,168,100,56\n\n27\n00:04:20,000 --> 00:04:30,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,168,100,56\n\n28\n00:04:30,000 --> 00:04:40,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,168,100,56\n\n29\n00:04:40,000 --> 00:04:50,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,224,100,56\n\n30\n00:04:50,000 --> 00:05:00,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,224,100,56\n\n31\n00:05:00,000 --> 00:05:10,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,224,100,56\n\n32\n00:05:10,000 --> 00:05:20,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,224,100,56\n\n33\n00:05:20,000 --> 00:05:30,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,224,100,56\n\n34\n00:05:30,000 --> 00:05:40,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,224,100,56\n\n35\n00:05:40,000 --> 00:05:50,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,224,100,56\n\n36\n00:05:50,000 --> 00:06:00,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,280,100,56\n\n37\n00:06:00,000 --> 00:06:10,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,280,100,56\n\n38\n00:06:10,000 --> 00:06:20,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,280,100,56\n\n39\n00:06:20,000 --> 00:06:30,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,280,100,56\n\n40\n00:06:30,000 --> 00:06:40,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,280,100,56\n\n41\n00:06:40,000 --> 00:06:50,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,280,100,56\n\n42\n00:06:50,000 --> 00:07:00,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,280,100,56\n\n43\n00:07:00,000 --> 00:07:10,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,336,100,56\n\n44\n00:07:10,000 --> 00:07:20,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,336,100,56\n\n45\n00:07:20,000 --> 00:07:30,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,336,100,56\n\n46\n00:07:30,000 --> 00:07:40,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,336,100,56\n\n47\n00:07:40,000 --> 00:07:50,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,336,100,56\n\n48\n00:07:50,000 --> 00:08:00,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,336,100,56\n\n49\n00:08:00,000 --> 00:08:10,000\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,336,100,56\n',
+ *     sprite:
+ *      'https://static.gvideo.co/videoplatform/sprites/2675/2452164_3dk4NsRt6vWsffEr.mp4_sprite.jpg',
+ *   },
+ * })
+ * ```
+ */
 export declare class Thumbnails extends UICorePlugin {
     private _$spotlight;
     private _$backdrop;
@@ -2305,15 +2498,27 @@ export declare class Thumbnails extends UICorePlugin {
     private _thumbsLoaded;
     private _oldContainer;
     private _thumbs;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
+    /**
+     * @internal
+     */
     get attributes(): {
         class: string;
     };
-    get template(): any;
+    private static readonly template;
     private buildSpriteConfig;
+    /**
+     * @internal
+     */
     bindEvents(): void;
     private _bindContainerEvents;
     private _onCoreReady;
@@ -2327,7 +2532,7 @@ export declare class Thumbnails extends UICorePlugin {
     private _calculateHoverPosition;
     private _buildImg;
     private _loadBackdrop;
-    setText(time: TimeValue): void;
+    private setText;
     private _updateCarousel;
     private _updateSpotlightThumb;
     private _getThumbIndexForTime;
@@ -2335,6 +2540,19 @@ export declare class Thumbnails extends UICorePlugin {
     private _createElements;
 }
 
+/**
+ * Plugin configuration options for the thumbnails plugin.
+ * @beta
+ */
+export declare type ThumbnailsPluginSettings = {
+    backdropHeight: number;
+    backdropMaxOpacity: number;
+    backdropMinOpacity: number;
+    spotlightHeight: number;
+    sprite: string;
+    vtt: string;
+};
+
 /**
  * Current playback time and total duration of the media.
  * @beta
@@ -2431,6 +2649,7 @@ export declare function version(): {
 };
 
 /**
+ * Applies fade effect to the player's volume change.
  * @beta
  */
 export declare class VolumeFade extends UICorePlugin {
@@ -2456,15 +2675,24 @@ export declare class VolumeFade extends UICorePlugin {
     private onLeave;
 }
 
+/**
+ * Events emitted by the VolumeFade plugin.
+ * @beta
+ */
 export declare enum VolumeFadeEvents {
     FADE = "core:volume:fade"
 }
 
+/**
+ * Telemetry watch event data
+ * @beta
+ */
 export declare interface WatchEventData {
     event: TelemetryEvent.Watch;
 }
 
 /**
+ * {@link https://zeptojs.com/#$() | Zepto query result}
  * @beta
  */
 export declare type ZeptoResult = ReturnType<typeof $>;