@gcorevideo/player 2.19.14 → 2.19.15

package/dist/player.d.ts

@@ -121,6 +121,10 @@ declare type BitrateTrackRecord = {
  * @beta
  * @remarks
  * The plugins provides a base for attaching custom settings UI in the gear menu
+ *
+ * Depends on:
+ *
+ * - {@link MediaControl | media_control}
  */
 export declare class BottomGear extends UICorePlugin {
     private isHd;
@@ -156,6 +160,16 @@ export declare class BottomGear extends UICorePlugin {
      * @internal
      */
     bindEvents(): void;
+    /**
+     * @param name - Name of a gear menu placeholder item to attach custom UI
+     * @returns Zepto result of the element
+     */
+    getElement(name: GearItemElement): ZeptoResult | null;
+    /**
+     * Replaces the content of the gear menu
+     * @param content - Zepto result of the element
+     */
+    setContent(content: ZeptoResult): void;
     private onActiveContainerChanged;
     private bindContainerEvents;
     private highDefinitionUpdate;
@@ -199,7 +213,7 @@ export declare class ClapprNerdStats extends UICorePlugin {
     constructor(core: Core);
     bindEvents(): void;
     private init;
-    private showOrHide;
+    private toggle;
     private show;
     private hide;
     private onPlayerResize;
@@ -486,6 +500,22 @@ export declare class Favicon extends CorePlugin {
     private changeIcon;
 }
 
+/**
+ * Custom events emitted by the plugin
+ */
+export declare enum GearEvents {
+    /**
+     * Emitted when the gear menu is rendered
+     */
+    MEDIACONTROL_GEAR_RENDERED = "mediacontrol:gear:rendered"
+}
+
+/**
+ * An element inside the gear menu
+ * @beta
+ */
+export declare type GearItemElement = 'quality' | 'rate' | 'nerd';
+
 export declare class GoogleAnalytics extends ContainerPlugin {
     private account;
     private trackerName;
@@ -552,7 +582,14 @@ export declare type LangTag = string;
  * @beta
  *
  * @remarks
- * The plugin is rendered as a button in the {@link BottomGear | gear menu}.
+ * Depends on:
+ *
+ * - {@link MediaControl}
+ *
+ * - {@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.
  *
  * Configuration options:
@@ -577,8 +614,8 @@ export declare class LevelSelector extends UICorePlugin {
     private removeAuto;
     private isHd;
     private isOpen;
-    private buttonTemplate;
-    private listTemplate;
+    private static readonly buttonTemplate;
+    private static readonly listTemplate;
     /**
      * @internal
      */
@@ -869,7 +906,6 @@ export declare class MediaControl extends UICorePlugin {
     private hide;
     private updateCursorStyle;
     private settingsUpdate;
-    private getSettings;
     private highDefinitionUpdate;
     private createCachedElements;
     /**
@@ -891,6 +927,11 @@ export declare class MediaControl extends UICorePlugin {
      * ```
      */
     getElement(name: MediaControlElement): ZeptoResult | null;
+    /**
+     * Get the right panel area to append custom elements to
+     * @returns  ZeptoSelector of the right panel element
+     */
+    getRightPanel(): any;
     private resetIndicators;
     private initializeIcons;
     private setSeekPercentage;
@@ -930,7 +971,7 @@ export declare class MediaControl extends UICorePlugin {
  * Media control elements, mount points for additional plugins
  * @beta
  */
-export declare type MediaControlElement = 'bottomGear' | 'clipText' | 'pip' | 'playbackRate' | 'seekBarContainer';
+export declare type MediaControlElement = 'bottomGear' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'subtitlesSelector';
 
 declare type MediaSourceInfo = {
     live: boolean;
@@ -1827,7 +1868,13 @@ export declare class SourceController extends CorePlugin {
     private sourcesDelay;
     private active;
     private sync;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
@@ -1841,14 +1888,43 @@ export declare class SourceController extends CorePlugin {
     private reset;
     private retryPlayback;
     private getNextMediaSource;
+    /**
+     * @internal
+     */
     static get version(): string;
 }
 
+/**
+ * Custom events emitted by the plugin
+ */
+export declare enum SpinnerEvents {
+    /**
+     * Emitted at the end of the spinner animation cycle to facilitate smooth UI updates,
+     * e.g. {@link SourceController} listens to this event to reload the source when the spinner is hidden
+     */
+    SYNC = "plugins:spinner:sync"
+}
+
+/**
+ * Shows a pending operation indicator when playback is buffering or in other appropriate cases
+ * @beta
+ * @remarks
+ * The plugin emits
+ */
 export declare class SpinnerThreeBounce extends UIContainerPlugin {
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
+    /**
+     * @internal
+     */
     get attributes(): {
         'data-spinner': string;
         class: string;
@@ -1863,8 +1939,17 @@ export declare class SpinnerThreeBounce extends UIContainerPlugin {
     private onPlay;
     private onStop;
     private onError;
-    show(immediate?: boolean): void;
+    /**
+     * Shows the spinner
+     */
+    show(): void;
+    /**
+     * Hides the spinner
+     */
     hide(): void;
+    /**
+     * @internal
+     */
     render(): this;
 }
 
@@ -1912,45 +1997,95 @@ declare type StatisticsRecord = {
     type: PlaybackType;
 } & StatisticsEventData;
 
+/**
+ * A {@link MediaControl | media control} plugin that provides a UI to select the subtitles when available.
+ * @beta
+ *
+ * @remarks
+ * Depends on:
+ *
+ * - {@link MediaControl}
+ *
+ * Configuration options:
+ *
+ * - subtitles.language - The language of the subtitles to select by default.
+ *
+ * @example
+ * ```ts
+ * import { Subtitles } from '@gcorevideo/player'
+ *
+ * Player.registerPlugin(Subtitles)
+ *
+ * new Player({
+ *   ...
+ *   subtitles: {
+ *     language: 'en',
+ *   },
+ * })
+ * ```
+ */
 export declare class Subtitles extends UICorePlugin {
-    private currentContainer;
     private currentLevel;
-    private currentPlayback;
+    private isPreselectedApplied;
     private isShowing;
+    private track;
     private tracks;
     private $string;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
+    /**
+     * @internal
+     */
     static get version(): string;
-    get template(): any;
-    get templateString(): any;
+    private static readonly template;
+    private static readonly templateString;
+    /**
+     * @internal
+     */
     get attributes(): {
         class: string;
         'data-subtitles': string;
     };
+    /**
+     * @internal
+     */
     get events(): {
         'click [data-subtitles-select]': string;
         'click [data-subtitles-button]': string;
     };
-    private isPreselectedApplied;
-    private track;
-    get preselectedLanguage(): string;
+    private get preselectedLanguage();
+    /**
+     * @internal
+     */
     bindEvents(): void;
-    unBindEvents(): void;
     private bindPlaybackEvents;
     private getTracks;
     private onStartAd;
     private onFinishAd;
-    reload(): void;
     private playerResize;
+    /**
+     * Hides the subtitles menu and the subtitles.
+     */
     hide(): void;
+    /**
+     * Shows the subtitles menu and the subtitles.
+     */
     show(): void;
     private shouldRender;
     private resizeFont;
+    /**
+     * @internal
+     */
     render(): this;
-    private fillLevels;
+    private setTracks;
     private findLevelBy;
     private selectLevel;
     private onLevelSelect;
@@ -1958,11 +2093,11 @@ export declare class Subtitles extends UICorePlugin {
     private onShowLevelSelectMenu;
     private hideSelectLevelMenu;
     private toggleContextMenu;
-    buttonElement(): ZeptoResult;
-    levelElement(id?: string): ZeptoResult;
-    startLevelSwitch(): void;
-    stopLevelSwitch(): void;
-    selectSubtitles(): void;
+    private buttonElement;
+    private levelElement;
+    private startLevelSwitch;
+    private stopLevelSwitch;
+    private selectSubtitles;
     private setSubtitleText;
     private clearSubtitleText;
     private updateCurrentLevel;