@gcorevideo/player 2.22.17 → 2.22.20

package/dist/player.d.ts

@@ -161,7 +161,7 @@ export declare class BigMuteButton extends UICorePlugin {
 /**
  * @beta
  */
-declare type BitrateTrackRecord = {
+export declare type BitrateTrackRecord = {
     start: number;
     end?: number;
     time?: number;
@@ -311,23 +311,14 @@ export declare class BottomGear extends UICorePlugin {
     private onMediaControlRendered;
 }
 
-/**
- * @beta
- */
-declare enum Chronograph {
-    Startup = "startup",
-    Watch = "watch",
-    Pause = "pause",
-    Buffering = "buffering",
-    Session = "session"
-}
-
 /**
  * `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.
  *
+ * @see {@link NerdStats} - a plugin that visualises the playback metrics
+ *
  * Configuration options - {@link ClapprStatsSettings}
  *
  * Events - {@link ClapprStatsEvents}
@@ -367,7 +358,7 @@ export declare class ClapprStats extends ContainerPlugin {
      * Returns the collected metrics.
      * @returns Measurements collected so far
      */
-    exportMetrics(): Metrics;
+    exportMetrics(): ClapprStatsMetrics;
     private onBitrate;
     private stopReporting;
     private startTimers;
@@ -389,6 +380,102 @@ export declare class ClapprStats extends ContainerPlugin {
     private html5FetchFPS;
 }
 
+/**
+ * @beta
+ */
+export declare enum ClapprStatsChronograph {
+    Startup = "startup",
+    Watch = "watch",
+    Pause = "pause",
+    Buffering = "buffering",
+    Session = "session"
+}
+
+/**
+ * @beta
+ */
+export declare enum ClapprStatsCounter {
+    Play = "play",
+    Pause = "pause",
+    Error = "error",
+    Buffering = "buffering",
+    DecodedFrames = "decodedFrames",
+    DroppedFrames = "droppedFrames",
+    Fps = "fps",
+    ChangeLevel = "changeLevel",
+    Seek = "seek",
+    Fullscreen = "fullscreen",
+    DvrUsage = "dvrUsage"
+}
+
+/**
+ * @beta
+ */
+export declare enum ClapprStatsEvents {
+    /**
+     * Emitted periodically with current measurements.
+     */
+    REPORT = "clappr:stats:report"
+}
+
+/**
+ * @beta
+ */
+export declare type ClapprStatsMetrics = {
+    /**
+     * Events count counters
+     */
+    counters: {
+        /**
+         *
+         */
+        [ClapprStatsCounter.Play]: number;
+        [ClapprStatsCounter.Pause]: number;
+        [ClapprStatsCounter.Error]: number;
+        [ClapprStatsCounter.Buffering]: number;
+        [ClapprStatsCounter.DecodedFrames]: number;
+        [ClapprStatsCounter.DroppedFrames]: number;
+        [ClapprStatsCounter.Fps]: number;
+        [ClapprStatsCounter.ChangeLevel]: number;
+        [ClapprStatsCounter.Seek]: number;
+        [ClapprStatsCounter.Fullscreen]: number;
+        [ClapprStatsCounter.DvrUsage]: number;
+    };
+    /**
+     * Time measurements - accumulated duration of time-based activities
+     */
+    chrono: {
+        /**
+         * Time spent in the startup phase
+         */
+        [ClapprStatsChronograph.Startup]: number;
+        /**
+         * Total time spent in the watch phase
+         */
+        [ClapprStatsChronograph.Watch]: number;
+        /**
+         *
+         */
+        [ClapprStatsChronograph.Pause]: number;
+        [ClapprStatsChronograph.Buffering]: number;
+        [ClapprStatsChronograph.Session]: number;
+    };
+    extra: {
+        playbackName: string;
+        playbackType: string;
+        bitratesHistory: BitrateTrackRecord[];
+        bitrateWeightedMean: number;
+        bitrateMostUsed: number;
+        buffersize: number;
+        watchHistory: Array<[number, number]>;
+        watchedPercentage: number;
+        bufferingPercentage: number;
+        bandwidth: number;
+        duration: number;
+        currentTime: number;
+    };
+};
+
 export declare type ClapprStatsSettings = {
     /**
      * The interval in milliseconds of periodic measurements.
@@ -476,7 +563,7 @@ export declare class Clips extends UICorePlugin {
 }
 
 /**
- * Configuration options for the {@link ClipsPlugin} plugin.
+ * Configuration options for the {@link Clips} plugin.
  * @beta
  */
 export declare interface ClipsPluginSettings {
@@ -693,23 +780,6 @@ 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
@@ -1331,65 +1401,6 @@ export declare type MenuOption = {
     icon?: string;
 };
 
-/**
- * @beta
- */
-declare type Metrics = {
-    /**
-     * Events count counters
-     */
-    counters: {
-        /**
-         *
-         */
-        [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;
-        playbackType: string;
-        bitratesHistory: BitrateTrackRecord[];
-        bitrateWeightedMean: number;
-        bitrateMostUsed: number;
-        buffersize: number;
-        watchHistory: Array<[number, number]>;
-        watchedPercentage: number;
-        bufferingPercentage: number;
-        bandwidth: number;
-        duration: number;
-        currentTime: number;
-    };
-    custom: Record<string, unknown>;
-};
-
 /**
  * `PLUGIN` that adds support for loading multiple streams and switching between them using the media control UI.
  * @beta
@@ -1444,15 +1455,15 @@ export declare class MultiCamera extends UICorePlugin {
 }
 
 /**
- * `PLUGIN` that displays useful network-related statistics.
+ * `PLUGIN` that displays useful statistics regarding the playback as well as the network quality estimation.
  * @beta
  *
  * @remarks
  * Depends on:
  *
- * - {@link BottomGear}
+ * - {@link BottomGear} - where the button is attached
  *
- * - {@link ClapprStats}
+ * - {@link ClapprStats} - to get the metrics from
  *
  * The plugin is rendered as an item in the gear menu.
  *
@@ -1461,9 +1472,9 @@ export declare class MultiCamera extends UICorePlugin {
  */
 declare class NerdStats extends UICorePlugin {
     private container;
-    private customMetrics;
+    private speedtestMetrics;
     private metrics;
-    private showing;
+    private open;
     private shortcut;
     private iconPosition;
     private static readonly buttonTemplate;
@@ -1482,17 +1493,17 @@ declare class NerdStats extends UICorePlugin {
      * @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;
+        click: string;
+        'click #nerd-stats-close': string;
+        'click #nerd-stats-refresh': string;
     };
+    private clicked;
     private get statsBoxElem();
     private get statsBoxWidthThreshold();
     private get playerWidth();
@@ -1503,6 +1514,7 @@ declare class NerdStats extends UICorePlugin {
      */
     bindEvents(): void;
     private onCoreReady;
+    private onActiveContainerChanged;
     /**
      * @internal
      */
@@ -1511,17 +1523,19 @@ declare class NerdStats extends UICorePlugin {
     private show;
     private hide;
     private onPlayerResize;
-    private addGeneralMetrics;
-    private addCustomMetrics;
+    private updateResolution;
+    private estimateQuality;
     private updateMetrics;
+    private updateEstimatedQuality;
     private setStatsBoxSize;
     /**
      * @internal
      */
     render(): this;
-    private addToBottomGear;
-    private clearCustomMetrics;
+    private attach;
+    private clearSpeedtestMetrics;
     private refreshSpeedTest;
+    private formatPlaybackName;
 }
 export { NerdStats as ClapprNerdStats }
 export { NerdStats }
@@ -2041,7 +2055,7 @@ export declare interface PlayerConfig extends Record<string, unknown> {
     mute?: boolean;
     /**
      * Stream type.
-     * @remark
+     * @remarks
      * Should only be set if known in advance, as it should not change once determined.
      * Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.
      */
@@ -2447,7 +2461,7 @@ export declare class SeekTime extends UICorePlugin {
     private $seekTimeEl;
     bindEvents(): void;
     private onContainerChanged;
-    private updateDuration;
+    private onTimeUpdate;
     private showTime;
     private hideTime;
     private calculateHoverPosition;
@@ -2966,10 +2980,9 @@ export declare type TimeProgress = {
 /**
  * For the plugin development
  * @beta
+ * @deprecated  Use TimePosition instead
  */
-export declare type TimeUpdate = TimePosition & {
-    firstFragDateTime: number;
-};
+export declare type TimeUpdate = TimePosition;
 
 /**
  * Playback time position in seconds since the beginning of the stream.