@gcorevideo/player 2.22.16 → 2.22.17

package/dist/player.d.ts

@@ -312,101 +312,32 @@ export declare class BottomGear extends UICorePlugin {
 }
 
 /**
- * `PLUGIN` that displays useful network-related statistics.
  * @beta
- *
- * @remarks
- * Depends on:
- *
- * - {@link BottomGear}
- *
- * - {@link ClapprStats}
- *
- * The plugin is rendered as an item in the gear menu.
- *
- * When clicked, it shows an overlay window with the information about the network speed, latency, etc,
- * and recommended quality level.
  */
-export declare class ClapprNerdStats extends UICorePlugin {
-    private container;
-    private customMetrics;
-    private metrics;
-    private showing;
-    private shortcut;
-    private iconPosition;
-    private static readonly buttonTemplate;
-    /**
-     * @internal
-     */
-    get name(): string;
-    /**
-     * @internal
-     */
-    get supportedVersion(): {
-        min: string;
-    };
-    private static readonly template;
-    /**
-     * @internal
-     */
-    get attributes(): {
-        'data-clappr-nerd-stats': string;
-        class: string;
-    };
-    /**
-     * @internal
-     */
-    get events(): {
-        'click [data-show-stats-button]': string;
-        'click [data-close-button]': string;
-        'click [data-refresh-button]': string;
-    };
-    private get statsBoxElem();
-    private get statsBoxWidthThreshold();
-    private get playerWidth();
-    private get playerHeight();
-    constructor(core: Core);
-    /**
-     * @internal
-     */
-    bindEvents(): void;
-    private onCoreReady;
-    private toggle;
-    private show;
-    private hide;
-    private onPlayerResize;
-    private addGeneralMetrics;
-    private addCustomMetrics;
-    private updateMetrics;
-    private setStatsBoxSize;
-    /**
-     * @internal
-     */
-    render(): this;
-    private addToBottomGear;
-    private clearCustomMetrics;
-    private refreshSpeedTest;
+declare enum Chronograph {
+    Startup = "startup",
+    Watch = "watch",
+    Pause = "pause",
+    Buffering = "buffering",
+    Session = "session"
 }
 
 /**
- * `PLUGIN` that collects useful statistics about playback performance.
+ * `PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.
  * @beta
  * @remarks
  * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.
+ *
+ * Configuration options - {@link ClapprStatsSettings}
+ *
+ * Events - {@link ClapprStatsEvents}
  */
 export declare class ClapprStats extends ContainerPlugin {
-    private bwMeasureCount;
-    private intervalId;
+    private timerId;
     private lastDecodedFramesCount;
     private metrics;
-    private completion;
-    private _onReport;
-    private runBandwidthTestEvery;
-    private runEach;
     private timers;
-    private updateFn;
-    private urisToMeasureBandwidth;
-    private uriToMeasureLatency;
+    private runEach;
     /**
      * @internal
      */
@@ -417,18 +348,12 @@ export declare class ClapprStats extends ContainerPlugin {
     get supportedVersion(): {
         min: string;
     };
-    private get _playbackName();
-    private get _playbackType();
-    private _now;
-    private _inc;
+    private get playbackName();
+    private get playbackType();
+    private now;
+    private inc;
     private start;
-    private _stop;
-    /**
-     * Registers a callback to receive the metrics.
-     * @param updateMetricsFn - The callback to receive the metrics
-     */
-    setUpdateMetrics(updateMetricsFn: MetricsUpdateFn): void;
-    private _defaultReport;
+    private stop;
     constructor(container: Container);
     /**
      * @internal
@@ -440,7 +365,7 @@ export declare class ClapprStats extends ContainerPlugin {
     destroy(): void;
     /**
      * Returns the collected metrics.
-     * @returns Currently collected metrics
+     * @returns Measurements collected so far
      */
     exportMetrics(): Metrics;
     private onBitrate;
@@ -456,17 +381,22 @@ export declare class ClapprStats extends ContainerPlugin {
     private onBuffering;
     private onBufferfull;
     private onProgress;
-    private _newMetrics;
-    private _onCompletion;
-    private _buildReport;
-    private _fetchFPS;
-    private _calculateBitrates;
-    private _calculatePercentages;
-    private _html5FetchFPS;
-    private _measureLatency;
-    private _measureBandwidth;
+    private onCompletion;
+    private buildReport;
+    private fetchFPS;
+    private calcBitrates;
+    private calcBufferingPercentage;
+    private html5FetchFPS;
 }
 
+export declare type ClapprStatsSettings = {
+    /**
+     * The interval in milliseconds of periodic measurements.
+     * The plugin will emit a {@link ClapprStatsEvents.REPORT} event with the collected metrics at the specified interval.
+     */
+    runEach?: number;
+};
+
 /**
  * A small `PLUGIN` that toggles the playback state on click over the video container
  * @beta
@@ -495,21 +425,23 @@ export declare class ClickToPause extends ContainerPlugin {
 }
 
 /**
- * `PLUGIN` that shows text over the seekbar to indicate the current clip.
+ * `PLUGIN` that allows marking up the timeline of the video
  * @beta
  * @remarks
+ * The plugin decorates the seekbar with notches to indicate the clips of the video and displays current clip text in the left panel
+ *
  * Depends on:
  *
  * - {@link MediaControl}
  *
  * Configuration options - {@link ClipsPluginSettings}
  */
-export declare class ClipsPlugin extends UICorePlugin {
+export declare class Clips extends UICorePlugin {
+    private barStyle;
     private clips;
-    private duration;
-    private durationGetting;
-    private _oldContainer;
+    private oldContainer;
     private svgMask;
+    private static readonly template;
     /**
      * @internal
      */
@@ -520,34 +452,37 @@ export declare class ClipsPlugin extends UICorePlugin {
     get attributes(): {
         class: string;
     };
+    get version(): string;
+    get supportedVersion(): {
+        min: string;
+    };
     /**
      * @internal
      */
     bindEvents(): void;
-    private _onCoreReady;
-    private _onMediaControlContainerChanged;
+    render(): this;
+    destroy(): UIObject;
+    disable(): void;
+    enable(): void;
+    private onCoreReady;
+    private onMcRender;
+    private onContainerChanged;
     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;
     private makeSvg;
     private setSVGMask;
     private setClipText;
 }
 
 /**
- * Configuration options for the {@link ClipsPlugin | clips} plugin.
+ * Configuration options for the {@link ClipsPlugin} plugin.
  * @beta
  */
 export declare interface ClipsPluginSettings {
     /**
-     * The text to display over the seekbar.
+     * The compiled text of the clips description, one clip per line in format  :
+     * `HH:MM:SS text` or `MM:SS text` or `SS text`
      */
     text: string;
 }
@@ -758,6 +693,23 @@ export declare type CorePluginConstructor = {
     type: string;
 };
 
+/**
+ * @beta
+ */
+declare enum Counter {
+    Play = "play",
+    Pause = "pause",
+    Error = "error",
+    Buffering = "buffering",
+    DecodedFrames = "decodedFrames",
+    DroppedFrames = "droppedFrames",
+    Fps = "fps",
+    ChangeLevel = "changeLevel",
+    Seek = "seek",
+    Fullscreen = "fullscreen",
+    DvrUsage = "dvrUsage"
+}
+
 /**
  * A plain JS object that must conform to the DASH.js settings schema.
  * @public
@@ -1096,8 +1048,6 @@ export declare class MediaControl extends UICorePlugin {
     private userDisabled;
     private userKeepVisible;
     private verticalVolume;
-    private $clipText;
-    private $clipTextContainer;
     private $duration;
     private $fullscreenToggle;
     private $multiCameraSelector;
@@ -1263,15 +1213,14 @@ export declare class MediaControl extends UICorePlugin {
      * ```ts
      * class MyPlugin extends UICorePlugin {
      *   override render() {
-     *     const mediaControl = this.core.getPlugin('media_control')
-     *     const clipText = mediaControl.getElement('clipText')
-     *     clipText?.el.text('Here we go')
+     *     this.$el.html('<div data-clips>Here we go</div>')
+     *     this.core.getPlugin('media_control').mount('clips', this.$el)
      *     return this
      *   }
      * }
      * ```
      */
-    getElement(name: MediaControlElement): ZeptoResult | null;
+    mount(name: MediaControlElement, element: ZeptoResult): void;
     putElement(name: MediaControlElement, element: ZeptoResult): void;
     /**
      * Toggle the visibility of a media control element
@@ -1336,7 +1285,7 @@ export declare type MediaControlLayerElement = 'seekbar' | 'seekBarContainer';
  * Media control elements that appear in the left area.
  * @beta
  */
-export declare type MediaControlLeftElement = 'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume';
+export declare type MediaControlLeftElement = 'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume' | 'clips';
 
 /**
  * Media control elements that appear in the right area.
@@ -1386,26 +1335,43 @@ export declare type MenuOption = {
  * @beta
  */
 declare type Metrics = {
+    /**
+     * Events count counters
+     */
     counters: {
-        play: number;
-        pause: number;
-        error: number;
-        buffering: number;
-        decodedFrames: number;
-        droppedFrames: number;
-        fps: number;
-        changeLevel: number;
-        seek: number;
-        fullscreen: number;
-        dvrUsage: number;
-    };
-    timers: {
-        startup: number;
-        watch: number;
-        pause: number;
-        buffering: number;
-        session: number;
-        latency: number;
+        /**
+         *
+         */
+        [Counter.Play]: number;
+        [Counter.Pause]: number;
+        [Counter.Error]: number;
+        [Counter.Buffering]: number;
+        [Counter.DecodedFrames]: number;
+        [Counter.DroppedFrames]: number;
+        [Counter.Fps]: number;
+        [Counter.ChangeLevel]: number;
+        [Counter.Seek]: number;
+        [Counter.Fullscreen]: number;
+        [Counter.DvrUsage]: number;
+    };
+    /**
+     * Time measurements - accumulated duration of time-based activities
+     */
+    chrono: {
+        /**
+         * Time spent in the startup phase
+         */
+        [Chronograph.Startup]: number;
+        /**
+         * Total time spent in the watch phase
+         */
+        [Chronograph.Watch]: number;
+        /**
+         *
+         */
+        [Chronograph.Pause]: number;
+        [Chronograph.Buffering]: number;
+        [Chronograph.Session]: number;
     };
     extra: {
         playbackName: string;
@@ -1424,11 +1390,6 @@ declare type Metrics = {
     custom: Record<string, unknown>;
 };
 
-/**
- * @beta
- */
-declare type MetricsUpdateFn = (metrics: Metrics) => void;
-
 /**
  * `PLUGIN` that adds support for loading multiple streams and switching between them using the media control UI.
  * @beta
@@ -1482,6 +1443,89 @@ export declare class MultiCamera extends UICorePlugin {
     private highlightCurrentLevel;
 }
 
+/**
+ * `PLUGIN` that displays useful network-related statistics.
+ * @beta
+ *
+ * @remarks
+ * Depends on:
+ *
+ * - {@link BottomGear}
+ *
+ * - {@link ClapprStats}
+ *
+ * The plugin is rendered as an item in the gear menu.
+ *
+ * When clicked, it shows an overlay window with the information about the network speed, latency, etc,
+ * and recommended quality level.
+ */
+declare class NerdStats extends UICorePlugin {
+    private container;
+    private customMetrics;
+    private metrics;
+    private showing;
+    private shortcut;
+    private iconPosition;
+    private static readonly buttonTemplate;
+    /**
+     * @internal
+     */
+    get name(): string;
+    /**
+     * @internal
+     */
+    get supportedVersion(): {
+        min: string;
+    };
+    private static readonly template;
+    /**
+     * @internal
+     */
+    get attributes(): {
+        'data-clappr-nerd-stats': string;
+        class: string;
+    };
+    /**
+     * @internal
+     */
+    get events(): {
+        'click [data-show-stats-button]': string;
+        'click [data-close-button]': string;
+        'click [data-refresh-button]': string;
+    };
+    private get statsBoxElem();
+    private get statsBoxWidthThreshold();
+    private get playerWidth();
+    private get playerHeight();
+    constructor(core: Core);
+    /**
+     * @internal
+     */
+    bindEvents(): void;
+    private onCoreReady;
+    /**
+     * @internal
+     */
+    destroy(): UIObject;
+    private toggle;
+    private show;
+    private hide;
+    private onPlayerResize;
+    private addGeneralMetrics;
+    private addCustomMetrics;
+    private updateMetrics;
+    private setStatsBoxSize;
+    /**
+     * @internal
+     */
+    render(): this;
+    private addToBottomGear;
+    private clearCustomMetrics;
+    private refreshSpeedTest;
+}
+export { NerdStats as ClapprNerdStats }
+export { NerdStats }
+
 /**
  * `PLUGIN` that enables picture in picture mode.
  * @beta
@@ -2237,20 +2281,21 @@ export declare class Poster extends UIContainerPlugin {
 }
 
 /**
- * A level of quality within a media source.
+ * A level of quality within a media source/representation.
  * @public
  */
 export declare interface QualityLevel {
     /**
      * Zero-based index of the quality level.
+     * Quality levels go from low to high
      */
     level: number;
     /**
-     * Width of the video, pixels.
+     * Width of the video frame, pixels.
      */
     width: number;
     /**
-     * Height of the video, pixels.
+     * Height of the video frame, pixels.
      */
     height: number;
     /**
@@ -2890,21 +2935,32 @@ export declare type ThumbnailsPluginSettings = {
  */
 export declare interface TimePosition {
     /**
-     * Current playback time, 0..duration, seconds.
+     * Current playback time, 0..duration
      */
     current: TimeValue;
     /**
-     * Total duration of the media, seconds.
+     * Total duration of the media content (or DVR window size or segment duration for live streams)
      */
     total: TimeValue;
 }
 
 /**
- * For the plugin development
+ * Time progress information indicated by Clappr CONTAINER_PROGRESS and PLAYBACK_PROGRESS events.
  * @beta
  */
-export declare type TimeProgress = TimePosition & {
-    start: number;
+export declare type TimeProgress = {
+    /**
+     * Current playback time
+     */
+    start: TimeValue;
+    /**
+     * Current buffer length beginning from the start (=current) time
+     */
+    current: TimeValue;
+    /**
+     * Total duration of the media content
+     */
+    total: TimeValue;
 };
 
 /**
@@ -2916,7 +2972,8 @@ export declare type TimeUpdate = TimePosition & {
 };
 
 /**
- * Playback time in seconds since the beginning of the stream (or a segment for the live streams)
+ * Playback time position in seconds since the beginning of the stream.
+ * For the live streams this is limited to the length of a segment. When DVR is enabled, this refers to the
  * @public
  */
 export declare type TimeValue = number;