@gcorevideo/player 2.21.1 → 2.21.4

package/dist/player.d.ts

@@ -6,7 +6,7 @@
  * It is built on top of the {@link https://github.com/clappr/clappr | Clappr} library and provides a framework for building custom integrations.
  * Start with {@link Player} for more information.
  *
- * Various plugins (marked with `PLUGIN` keyword) are available to extend the player with additional features.
+ * Various plugins (marked with `PLUGIN` keyword) are available to extend the core functionality with additional features.
  * @example
  * ```ts
  * import { Player, MediaControl, ErrorScreen } from '@gcorevideo/player'
@@ -74,14 +74,13 @@ export declare class AudioSelector extends UICorePlugin {
      */
     get attributes(): {
         class: string;
-        'data-track-selector': string;
     };
     /**
      * @internal
      */
     get events(): {
-        'click [data-track-selector-select]': string;
-        'click [data-track-selector-button]': string;
+        'click [data-audiotracks-select]': string;
+        'click [data-audiotracks-button]': string;
     };
     /**
      * @internal
@@ -181,7 +180,7 @@ declare type BitrateTrackRecord = {
  *
  * Depends on:
  *
- * - {@link MediaControl | media_control}
+ * - {@link MediaControl}
  */
 export declare class BottomGear extends UICorePlugin {
     private isHd;
@@ -220,7 +219,7 @@ export declare class BottomGear extends UICorePlugin {
      * @param name - Name of a gear menu placeholder item to attach custom UI
      * @returns Zepto result of the element
      */
-    getElement(name: GearItemElement): ZeptoResult | null;
+    getElement(name: GearOptionsItem): ZeptoResult | null;
     /**
      * Replaces the content of the gear menu
      * @param content - Zepto result of the element
@@ -486,6 +485,121 @@ export declare interface ClipsPluginSettings {
     text: string;
 }
 
+/**
+ * `PLUGIN` that provides a UI to select the subtitles when available.
+ * @beta
+ *
+ * @remarks
+ * The plugin is activated when closed captions tracks are provided with the media source.
+ * It shows a familiar "CC" button with a dropdown menu to select the subtitles language.
+ *
+ * Depends on:
+ *
+ * - {@link MediaControl}
+ *
+ * Configuration options -  {@link ClosedCaptionsPluginSettings}
+ * @example
+ * ```ts
+ * import { ClosedCaptions } from '@gcorevideo/player'
+ *
+ * Player.registerPlugin(ClosedCaptions)
+ *
+ * new Player({
+ *   ...
+ *   cc: {
+ *     language: 'en',
+ *   },
+ * })
+ * ```
+ */
+declare class ClosedCaptions extends UICorePlugin {
+    private isPreselectedApplied;
+    private isShowing;
+    private track;
+    private tracks;
+    private $line;
+    /**
+     * @internal
+     */
+    get name(): string;
+    /**
+     * @internal
+     */
+    get supportedVersion(): {
+        min: string;
+    };
+    /**
+     * @internal
+     */
+    static get version(): string;
+    private static readonly template;
+    private static readonly templateString;
+    /**
+     * @internal
+     */
+    get attributes(): {
+        class: string;
+    };
+    /**
+     * @internal
+     */
+    get events(): {
+        'click [data-cc-select]': string;
+        'click [data-cc-button]': string;
+    };
+    private get preselectedLanguage();
+    /**
+     * @internal
+     */
+    bindEvents(): void;
+    private onCoreReady;
+    private onContainerChanged;
+    private onSubtitleAvailable;
+    private onSubtitleChanged;
+    private applyTracks;
+    private onStartAd;
+    private onFinishAd;
+    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 findById;
+    private selectItem;
+    private onItemSelect;
+    private applyPreselectedSubtitles;
+    private hideMenu;
+    private toggleMenu;
+    private itemElement;
+    private allItemElements;
+    private selectSubtitles;
+    private getSubtitleText;
+    private setSubtitleText;
+    private clearSubtitleText;
+    private updateSelection;
+    private highlightCurrentSubtitles;
+    private renderIcon;
+}
+export { ClosedCaptions }
+export { ClosedCaptions as Subtitles }
+
+export declare type ClosedCaptionsPluginSettings = {
+    /**
+     * Initially selected subtitles language
+     */
+    language?: string;
+};
+
 /**
  * @public
  */
@@ -756,11 +870,16 @@ export declare interface FaviconPluginSettings {
     faviconColor?: string;
 }
 
+/**
+ * @deprecated Use {@link GearOptionsItem} instead
+ */
+export declare type GearItemElement = GearOptionsItem;
+
 /**
  * An element inside the gear menu
  * @beta
  */
-export declare type GearItemElement = 'quality' | 'rate' | 'nerd';
+export declare type GearOptionsItem = 'quality' | 'rate' | 'nerd';
 
 /**
  * `PLUGIN` that integrates with Google Analytics
@@ -965,7 +1084,6 @@ export { LogTracer }
  * The methods exposed are to be used by the other plugins that extend the media control UI.
  */
 export declare class MediaControl extends UICorePlugin {
-    private advertisementPlaying;
     private buttonsColor;
     private currentDurationValue;
     private currentPositionValue;
@@ -1007,7 +1125,6 @@ export declare class MediaControl extends UICorePlugin {
     private $seekBarLoaded;
     private $seekBarPosition;
     private $seekBarScrubber;
-    private $subtitlesSelector;
     private $volumeBarContainer;
     private $volumeBarBackground;
     private $volumeBarFill;
@@ -1108,7 +1225,7 @@ export declare class MediaControl extends UICorePlugin {
      */
     setInitialVolume(): void;
     private onVolumeChanged;
-    private onLoadedMetadataOnVideoTag;
+    private onLoadedMetadata;
     private updateVolumeUI;
     private changeTogglePlay;
     private mousemoveOnSeekBar;
@@ -1150,7 +1267,7 @@ export declare class MediaControl extends UICorePlugin {
     private show;
     private hide;
     private updateCursorStyle;
-    private settingsUpdate;
+    private updateSettings;
     private highDefinitionUpdate;
     private createCachedElements;
     /**
@@ -1173,7 +1290,7 @@ export declare class MediaControl extends UICorePlugin {
      * ```
      */
     getElement(name: MediaControlElement): ZeptoResult | null;
-    putElement(name: MediaControlElement, element: ZeptoResult): void;
+    putElement(name: MediaControlElement, element: HTMLElement): void;
     /**
      * Get the right panel area to append custom elements to
      * @returns  ZeptoSelector of the right panel element
@@ -1218,13 +1335,14 @@ export declare class MediaControl extends UICorePlugin {
      */
     disabledControlButton(): void;
     private isSeekEnabledForHtml5Playback;
+    private getElementLocation;
 }
 
 /**
  * Media control elements, mount points for additional plugins
  * @beta
  */
-export declare type MediaControlElement = 'audioTracksSelector' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'subtitlesSelector';
+export declare type MediaControlElement = 'audiotracks' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'cc';
 
 /**
  * Custom events emitted by the plugins to communicate with one another
@@ -1362,6 +1480,7 @@ export declare class PictureInPicture extends UICorePlugin {
      * @internal
      */
     static get version(): string;
+    private static buttonTemplate;
     /**
      * @internal
      */
@@ -1466,6 +1585,7 @@ 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 options to change the playback rate.
+ * Note that the playback rate change is supported only for VOD or DVR enabled live streams.
  */
 export declare class PlaybackRate extends UICorePlugin {
     private playbackRates;
@@ -1490,7 +1610,6 @@ export declare class PlaybackRate extends UICorePlugin {
      */
     get attributes(): {
         class: string;
-        'data-playback-rate-select': string;
     };
     /**
      * @internal
@@ -2341,112 +2460,9 @@ export declare interface StartEventData {
 }
 
 /**
- * `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',
- *   },
- * })
- * ```
+ * @deprecated Use {@link ClosedCaptionsPluginSettings} instead.
  */
-export declare class Subtitles extends UICorePlugin {
-    private currentLevel;
-    private isPreselectedApplied;
-    private isShowing;
-    private track;
-    private tracks;
-    private $string;
-    /**
-     * @internal
-     */
-    get name(): string;
-    /**
-     * @internal
-     */
-    get supportedVersion(): {
-        min: string;
-    };
-    /**
-     * @internal
-     */
-    static get version(): string;
-    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 get preselectedLanguage();
-    /**
-     * @internal
-     */
-    bindEvents(): void;
-    private bindPlaybackEvents;
-    private getTracks;
-    private onStartAd;
-    private onFinishAd;
-    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 setTracks;
-    private findLevelBy;
-    private selectLevel;
-    private onLevelSelect;
-    private applyPreselectedSubtitles;
-    private onShowLevelSelectMenu;
-    private hideSelectLevelMenu;
-    private toggleContextMenu;
-    private buttonElement;
-    private levelElement;
-    private startLevelSwitch;
-    private stopLevelSwitch;
-    private selectSubtitles;
-    private setSubtitleText;
-    private clearSubtitleText;
-    private updateCurrentLevel;
-    private highlightCurrentSubtitles;
-    private renderIcon;
-}
+export declare type SubtitlesPluginSettings = ClosedCaptionsPluginSettings;
 
 /**
  * `PLUGIN` that collects and reports the performance statistics.
@@ -2563,6 +2579,12 @@ export declare type TelemetryRecord = {
  */
 export declare type TelemetrySendFn = (data: TelemetryRecord) => void;
 
+export declare interface TextTrackItem {
+    id: number;
+    name: string;
+    track: TextTrack;
+}
+
 /**
  * `PLUGIN` that displays the thumbnails of the video when available.
  * @beta