@gcorevideo/player 2.22.16 → 2.22.18

package/lib/plugins/clappr-stats/ClapprStats.d.ts

@@ -1,24 +1,28 @@
 import { Container, ContainerPlugin } from '@clappr/core';
-import type { Metrics, MetricsUpdateFn } from './types.js';
+import type { Metrics } from './types.js';
+export 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;
+};
 /**
- * `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
      */
@@ -29,18 +33,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
@@ -52,7 +50,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;
@@ -68,14 +66,11 @@ 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;
 }
 //# sourceMappingURL=ClapprStats.d.ts.map

package/lib/plugins/clappr-stats/ClapprStats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClapprStats.d.ts","sourceRoot":"","sources":["../../../src/plugins/clappr-stats/ClapprStats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAA6B,MAAM,cAAc,CAAC;AAMrF,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAkB3D;;;;;GAKG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAC9C,OAAO,CAAC,cAAc,CAAK;IAE3B,OAAO,CAAC,UAAU,CAAwB;IAE1C,OAAO,CAAC,sBAAsB,CAAK;IAEnC,OAAO,CAAC,OAAO,CAAyB;IAExC,OAAO,CAAC,UAAU,CAGhB;IAEF,OAAO,CAAC,SAAS,CAA6B;IAE9C,OAAO,CAAC,qBAAqB,CAAS;IAEtC,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,MAAM,CAOZ;IAEF,OAAO,CAAC,QAAQ,CAAkC;IAElD,OAAO,CAAC,sBAAsB,CAA0B;IAExD,OAAO,CAAC,mBAAmB,CAAqB;IAEhD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,KAAK,aAAa,GAExB;IAED,OAAO,KAAK,aAAa,GAExB;IAED,OAAO,CAAC,IAAI;IAMZ,OAAO,CAAC,IAAI;IAQZ,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,KAAK;IAKb;;;OAGG;IACH,gBAAgB,CAAC,eAAe,EAAE,eAAe;IAKjD,OAAO,CAAC,cAAc;gBAIV,SAAS,EAAE,SAAS;IAchC;;OAEG;IACM,UAAU;IAmBnB;;OAEG;IACM,OAAO;IAKhB;;;OAGG;IACH,aAAa;IAIb,OAAO,CAAC,SAAS;IAgBjB,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,OAAO;IAQf,OAAO,CAAC,MAAM;IAKd,OAAO,CAAC,YAAY;IA0BpB,OAAO,CAAC,6BAA6B;IAOrC,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,YAAY;IAiBpB,OAAO,CAAC,SAAS;IAcjB,OAAO,CAAC,kBAAkB;IAsB1B,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,cAAc;IAqBtB,OAAO,CAAC,eAAe;IA2BvB,OAAO,CAAC,iBAAiB;CAmD1B"}
+{"version":3,"file":"ClapprStats.d.ts","sourceRoot":"","sources":["../../../src/plugins/clappr-stats/ClapprStats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAwB,MAAM,cAAc,CAAA;AAU/E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAIzC,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;;;GASG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAC9C,OAAO,CAAC,OAAO,CAAuB;IAEtC,OAAO,CAAC,sBAAsB,CAAI;IAElC,OAAO,CAAC,OAAO,CAAwB;IAEvC,OAAO,CAAC,MAAM,CAMb;IAED,OAAO,CAAC,OAAO,CAAQ;IAEvB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,CAAC,GAAG;IASX,OAAO,CAAC,GAAG;IAQX,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,IAAI;gBAKA,SAAS,EAAE,SAAS;IAKhC;;OAEG;IACM,UAAU;IAmDnB;;OAEG;IACM,OAAO;IAKhB;;;OAGG;IACH,aAAa;IAIb,OAAO,CAAC,SAAS;IAkBjB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,OAAO;IAgBf,OAAO,CAAC,MAAM;IAKd,OAAO,CAAC,YAAY;IA8BpB,OAAO,CAAC,6BAA6B;IAOrC,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,YAAY;IASpB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,WAAW;IAcnB,OAAO,CAAC,QAAQ;IAgBhB,OAAO,CAAC,YAAY;IAuBpB,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,aAAa;CA0BtB"}

package/lib/plugins/clappr-stats/ClapprStats.js

@@ -1,36 +1,29 @@
-import { ContainerPlugin, Events as CoreEvents, Log } from '@clappr/core';
-import assert from 'assert';
+import { ContainerPlugin, Events as CoreEvents } from '@clappr/core';
 import { CLAPPR_VERSION } from '../../build.js';
-import { ClapprStatsEvents } from './types.js';
+import { ClapprStatsEvents, Chronograph, Counter } from './types.js';
 import { newMetrics } from './utils.js';
-// TODO: fix
-const updateMetrics = () => { };
 /**
- * `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 class ClapprStats extends ContainerPlugin {
-    bwMeasureCount = 0;
-    intervalId = null;
+    timerId = null;
     lastDecodedFramesCount = 0;
     metrics = newMetrics();
-    completion;
-    _onReport;
-    runBandwidthTestEvery;
-    runEach;
     timers = {
-        startup: 0,
-        watch: 0,
-        pause: 0,
-        buffering: 0,
-        session: 0,
-        latency: 0,
+        [Chronograph.Startup]: 0,
+        [Chronograph.Watch]: 0,
+        [Chronograph.Pause]: 0,
+        [Chronograph.Buffering]: 0,
+        [Chronograph.Session]: 0,
     };
-    updateFn = updateMetrics;
-    urisToMeasureBandwidth;
-    uriToMeasureLatency;
+    runEach;
     /**
      * @internal
      */
@@ -43,17 +36,19 @@ export class ClapprStats extends ContainerPlugin {
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
-    get _playbackName() {
+    get playbackName() {
         return String(this.container.playback.name || '');
     }
-    get _playbackType() {
+    get playbackType() {
         return this.container.getPlaybackType();
     }
-    _now() {
-        const hasPerformanceSupport = window.performance && typeof (window.performance.now) === 'function';
-        return (hasPerformanceSupport) ? window.performance.now() : new Date().getTime();
+    now() {
+        const hasPerformanceSupport = window.performance && typeof window.performance.now === 'function';
+        return hasPerformanceSupport
+            ? window.performance.now()
+            : new Date().getTime();
     }
-    _inc(counter) {
+    inc(counter) {
         this.metrics.counters[counter] += 1;
     }
     // _timerHasStarted(timer) {
@@ -61,34 +56,15 @@ export class ClapprStats extends ContainerPlugin {
     // }
     start(timer) {
         // this[`_start${timer}`] = this._now();
-        this.timers[timer] = this._now();
+        this.timers[timer] = this.now();
     }
-    _stop(timer) {
+    stop(timer) {
         // this._metrics.timers[timer] += this._now() - this[`_start${timer}`];
-        this.metrics.timers[timer] += this._now() - this.timers[timer];
-    }
-    /**
-     * Registers a callback to receive the metrics.
-     * @param updateMetricsFn - The callback to receive the metrics
-     */
-    setUpdateMetrics(updateMetricsFn) {
-        // TODO use events instead
-        this.updateFn = updateMetricsFn;
-    }
-    _defaultReport(metrics) {
-        this.updateFn(metrics);
+        this.metrics.chrono[timer] += this.now() - this.timers[timer];
     }
     constructor(container) {
         super(container);
         this.runEach = container.options.clapprStats?.runEach ?? 5000;
-        this._onReport = container.options.clapprStats?.onReport ?? this._defaultReport;
-        this.uriToMeasureLatency = container.options.clapprStats?.uriToMeasureLatency;
-        this.urisToMeasureBandwidth = container.options.clapprStats?.urisToMeasureBandwidth;
-        this.runBandwidthTestEvery = container.options.clapprStats?.runBandwidthTestEvery ?? 10;
-        this.completion = {
-            watch: container.options.clapprStats?.onCompletion ?? [],
-            calls: []
-        };
     }
     /**
      * @internal
@@ -103,10 +79,10 @@ export class ClapprStats extends ContainerPlugin {
         this.listenTo(this.container, CoreEvents.CONTAINER_PAUSE, this.onPause);
         this.listenToOnce(this.container, CoreEvents.CONTAINER_STATE_BUFFERING, this.onBuffering);
         this.listenTo(this.container, CoreEvents.CONTAINER_SEEK, this.onSeek);
-        this.listenTo(this.container, CoreEvents.CONTAINER_ERROR, () => this._inc('error'));
-        this.listenTo(this.container, CoreEvents.CONTAINER_FULLSCREEN, () => this._inc('fullscreen'));
+        this.listenTo(this.container, CoreEvents.CONTAINER_ERROR, () => this.inc(Counter.Error));
+        this.listenTo(this.container, CoreEvents.CONTAINER_FULLSCREEN, () => this.inc(Counter.Fullscreen));
         this.listenTo(this.container, CoreEvents.CONTAINER_PLAYBACKDVRSTATECHANGED, (dvrInUse) => {
-            dvrInUse && this._inc('dvrUsage');
+            dvrInUse && this.inc(Counter.DvrUsage);
         });
         this.listenTo(this.container.playback, CoreEvents.PLAYBACK_PROGRESS, this.onProgress);
         this.listenTo(this.container.playback, CoreEvents.PLAYBACK_TIMEUPDATE, this.onTimeUpdate);
@@ -120,67 +96,63 @@ export class ClapprStats extends ContainerPlugin {
     }
     /**
      * Returns the collected metrics.
-     * @returns Currently collected metrics
+     * @returns Measurements collected so far
      */
     exportMetrics() {
         return structuredClone(this.metrics);
     }
     onBitrate(newBitrate) {
         const bitrate = newBitrate.bitrate;
-        const now = this._now();
+        const now = this.now();
         if (this.metrics.extra.bitratesHistory.length > 0) {
-            const beforeLast = this.metrics.extra.bitratesHistory[this.metrics.extra.bitratesHistory.length - 1];
-            beforeLast.end = now;
-            beforeLast.time = now - beforeLast.start;
+            const last = this.metrics.extra.bitratesHistory[this.metrics.extra.bitratesHistory.length - 1];
+            last.end = now;
+            last.time = now - last.start;
         }
-        this.metrics.extra.bitratesHistory.push({ start: this._now(), bitrate: bitrate });
-        this._inc('changeLevel');
+        this.metrics.extra.bitratesHistory.push({ start: this.now(), bitrate });
+        this.inc(Counter.ChangeLevel);
     }
     stopReporting() {
-        this._buildReport();
-        if (this.intervalId !== null) {
-            clearInterval(this.intervalId);
-            this.intervalId = null;
+        this.buildReport();
+        if (this.timerId !== null) {
+            clearInterval(this.timerId);
+            this.timerId = null;
         }
-        this._newMetrics();
-        // TODO
-        // @ts-ignore
-        this.stopListening();
-        this.bindEvents();
     }
     startTimers() {
-        this.intervalId = setInterval(this._buildReport.bind(this), this.runEach);
-        this.start('session');
-        this.start('startup');
+        this.timerId = setInterval(this.buildReport.bind(this), this.runEach);
+        this.start(Chronograph.Session);
+        this.start(Chronograph.Startup);
     }
     onFirstPlaying() {
         this.listenTo(this.container, CoreEvents.CONTAINER_TIMEUPDATE, this.onContainerUpdateWhilePlaying);
-        this.start('watch');
-        this._stop('startup');
+        this.start(Chronograph.Watch);
+        this.stop(Chronograph.Startup);
     }
     playAfterPause() {
         this.listenTo(this.container, CoreEvents.CONTAINER_TIMEUPDATE, this.onContainerUpdateWhilePlaying);
-        this._stop('pause');
-        this.start('watch');
+        this.stop(Chronograph.Pause);
+        this.start(Chronograph.Watch);
     }
     onPlay() {
-        this._inc('play');
+        this.inc(Counter.Play);
     }
     onPause() {
-        this._stop('watch');
-        this.start('pause');
-        this._inc('pause');
+        this.stop(Chronograph.Watch);
+        this.start(Chronograph.Pause);
+        this.inc(Counter.Pause);
         this.listenToOnce(this.container, CoreEvents.CONTAINER_PLAY, this.playAfterPause);
         this.stopListening(this.container, CoreEvents.CONTAINER_TIMEUPDATE, this.onContainerUpdateWhilePlaying);
     }
     onSeek(e) {
-        this._inc('seek');
+        this.inc(Counter.Seek);
         this.metrics.extra.watchHistory.push([e * 1000, e * 1000]);
     }
     onTimeUpdate(e) {
         const current = e.current * 1000, total = e.total * 1000, l = this.metrics.extra.watchHistory.length;
         this.metrics.extra.duration = total;
         this.metrics.extra.currentTime = current;
+        // TODO what if it's a live stream?
         this.metrics.extra.watchedPercentage = (current / total) * 100;
         if (l === 0) {
             this.metrics.extra.watchHistory.push([current, current]);
@@ -191,68 +163,60 @@ export class ClapprStats extends ContainerPlugin {
         if (this.metrics.extra.bitratesHistory.length > 0) {
             const lastBitrate = this.metrics.extra.bitratesHistory[this.metrics.extra.bitratesHistory.length - 1];
             if (!lastBitrate.end) {
-                lastBitrate.time = this._now() - lastBitrate.start;
+                lastBitrate.time = this.now() - lastBitrate.start;
             }
         }
-        this._onCompletion();
+        this.onCompletion();
     }
     onContainerUpdateWhilePlaying() {
         if (this.container.playback.isPlaying()) {
-            this._stop('watch');
-            this.start('watch');
+            this.stop(Chronograph.Watch);
+            this.start(Chronograph.Watch);
         }
     }
     onBuffering() {
-        this._inc('buffering');
-        this.start('buffering');
+        this.inc(Counter.Buffering);
+        this.start(Chronograph.Buffering);
         this.listenToOnce(this.container, CoreEvents.CONTAINER_STATE_BUFFERFULL, this.onBufferfull);
     }
     onBufferfull() {
-        this._stop('buffering');
+        this.stop(Chronograph.Buffering);
         this.listenToOnce(this.container, CoreEvents.CONTAINER_STATE_BUFFERING, this.onBuffering);
     }
     onProgress(progress) {
         this.metrics.extra.buffersize = progress.current * 1000;
     }
-    _newMetrics() {
-        this.metrics = newMetrics();
-    }
-    _onCompletion() {
-        const currentPercentage = this.metrics.extra.watchedPercentage;
-        const allPercentages = this.completion.watch;
-        const isCalled = this.completion.calls.indexOf(currentPercentage) !== -1;
-        if (allPercentages.indexOf(currentPercentage) !== -1 && !isCalled) {
-            Log.info(this.name + ' PERCENTAGE_EVENT: ' + currentPercentage);
-            this.completion.calls.push(currentPercentage);
-            this.trigger(ClapprStatsEvents.PERCENTAGE_EVENT, currentPercentage);
-        }
-    }
-    _buildReport() {
-        this._stop('session');
-        this.start('session');
-        this.metrics.extra.playbackName = this._playbackName;
-        this.metrics.extra.playbackType = this._playbackType;
-        this._calculateBitrates();
-        this._calculatePercentages();
-        this._fetchFPS();
-        this._measureLatency();
-        this._measureBandwidth();
-        this._onReport(this.metrics);
-        this.trigger(ClapprStatsEvents.REPORT_EVENT, structuredClone(this.metrics));
-    }
-    _fetchFPS() {
+    onCompletion() {
+        // Decide if this is needed
+        // const currentPercentage = this.metrics.extra.watchedPercentage;
+        // this.trigger(ClapprStatsEvents.PERCENTAGE, currentPercentage);
+    }
+    buildReport() {
+        this.stop(Chronograph.Session);
+        this.start(Chronograph.Session);
+        this.metrics.extra.playbackName = this.playbackName;
+        this.metrics.extra.playbackType = this.playbackType;
+        this.calcBitrates();
+        this.calcBufferingPercentage();
+        // TODO calc FPS properly, e.g., on TIMEUPDATE event
+        this.fetchFPS();
+        this.trigger(ClapprStatsEvents.REPORT, structuredClone(this.metrics));
+    }
+    fetchFPS() {
+        // TODO check if the playback and media sources support video, then use the common method
         // flashls ??? - hls.droppedFramesl hls.stream.bufferLength (seconds)
         // hls ??? (use the same?)
         const fetchFPS = {
-            'html5_video': this._html5FetchFPS,
-            'hls': this._html5FetchFPS,
-            'dash_shaka_playback': this._html5FetchFPS
+            html5_video: this.html5FetchFPS,
+            hls: this.html5FetchFPS,
+            dash: this.html5FetchFPS,
         };
-        if (this._playbackName in fetchFPS) {
-            fetchFPS[this._playbackName].call(this);
+        if (this.playbackName in fetchFPS) {
+            fetchFPS[this.playbackName].call(this);
         }
     }
-    _calculateBitrates() {
+    // TODO sort out
+    calcBitrates() {
         const { bitratesHistory } = this.metrics.extra;
         if (bitratesHistory.length === 0) {
             return;
@@ -266,95 +230,23 @@ export class ClapprStats extends ContainerPlugin {
         this.metrics.extra.bitrateWeightedMean = weightedTotal / totalTime;
         this.metrics.extra.bitrateMostUsed = bitratesHistory.reduce((mostUsed, current) => (current.time || 0) > (mostUsed.time || 0) ? current : mostUsed, { time: 0, bitrate: 0, start: 0, end: 0 }).bitrate;
     }
-    _calculatePercentages() {
+    calcBufferingPercentage() {
         if (this.metrics.extra.duration > 0) {
-            this.metrics.extra.bufferingPercentage = (this.metrics.timers.buffering / this.metrics.extra.duration) * 100;
+            this.metrics.extra.bufferingPercentage =
+                (this.metrics.chrono.buffering / this.metrics.extra.duration) * 100;
         }
     }
-    _html5FetchFPS() {
+    html5FetchFPS() {
         const videoTag = this.container.playback.el;
-        const getFirstValidValue = (...args) => args.find(val => val !== undefined);
+        const getFirstValidValue = (...args) => args.find((val) => val !== undefined);
         const decodedFrames = getFirstValidValue(videoTag.webkitDecodedFrameCount, videoTag.mozDecodedFrames, 0);
-        const droppedFrames = getFirstValidValue(videoTag.webkitDroppedFrameCount, videoTag.mozParsedFrames && videoTag.mozDecodedFrames ? videoTag.mozParsedFrames - videoTag.mozDecodedFrames : 0, 0);
-        const decodedFramesLastTime = decodedFrames - (this.lastDecodedFramesCount || 0);
+        const droppedFrames = getFirstValidValue(videoTag.webkitDroppedFrameCount, videoTag.mozParsedFrames && videoTag.mozDecodedFrames
+            ? videoTag.mozParsedFrames - videoTag.mozDecodedFrames
+            : 0, 0);
+        const delta = decodedFrames - (this.lastDecodedFramesCount || 0);
         this.metrics.counters.decodedFrames = decodedFrames;
         this.metrics.counters.droppedFrames = droppedFrames;
-        this.metrics.counters.fps = decodedFramesLastTime / (this.runEach / 1000);
+        this.metrics.counters.fps = delta / (this.runEach / 1000); // TODO use time delta instead of runEach
         this.lastDecodedFramesCount = decodedFrames;
     }
-    // originally from https://www.smashingmagazine.com/2011/11/analyzing-network-characteristics-using-javascript-and-the-dom-part-1/
-    _measureLatency() {
-        if (this.uriToMeasureLatency) {
-            const t = [];
-            const n = 2;
-            let rtt;
-            const ld = () => {
-                t.push(this._now());
-                if (t.length > n) {
-                    done();
-                }
-                else {
-                    const img = new Image;
-                    img.onload = ld;
-                    img.src = this.uriToMeasureLatency + '?' + Math.random()
-                        + '=' + this._now();
-                }
-            };
-            const done = () => {
-                rtt = t[2] - t[1];
-                this.metrics.timers.latency = rtt;
-            };
-            ld();
-        }
-    }
-    // originally from https://www.smashingmagazine.com/2011/11/analyzing-network-characteristics-using-javascript-and-the-dom-part-1/
-    _measureBandwidth() {
-        if (this.urisToMeasureBandwidth && (this.bwMeasureCount % this.runBandwidthTestEvery === 0)) {
-            let i = 0;
-            const ld = (e) => {
-                if (i > 0) {
-                    const prev = this.urisToMeasureBandwidth[i - 1];
-                    prev.end = this._now();
-                    if (prev.timer !== null) {
-                        clearTimeout(prev.timer);
-                    }
-                }
-                if (i >= this.urisToMeasureBandwidth.length || (i > 0 && this.urisToMeasureBandwidth[i - 1].expired)) {
-                    assert(e, 'incorrect invocation in _measureBandwidth');
-                    done(e);
-                }
-                else {
-                    const xhr = new XMLHttpRequest();
-                    xhr.open('GET', this.urisToMeasureBandwidth[i].url, true);
-                    xhr.responseType = 'arraybuffer';
-                    xhr.onload = xhr.onabort = ld;
-                    this.urisToMeasureBandwidth[i].start = this._now();
-                    this.urisToMeasureBandwidth[i].timer = setTimeout((j) => {
-                        this.urisToMeasureBandwidth[j].expired = true;
-                        xhr.abort();
-                    }, this.urisToMeasureBandwidth[i].timeout, i);
-                    xhr.send();
-                }
-                i++;
-            };
-            const done = (e) => {
-                const timeSpent = (this.urisToMeasureBandwidth[i - 1].end - this.urisToMeasureBandwidth[i - 1].start) / 1000;
-                const bandwidthBps = (e.loaded * 8) / timeSpent;
-                this.metrics.extra.bandwidth = bandwidthBps;
-                this.urisToMeasureBandwidth.forEach((x) => {
-                    x.start = 0;
-                    x.end = 0;
-                    x.expired = false;
-                    if (x.timer !== null) {
-                        clearTimeout(x.timer);
-                        x.timer = null;
-                    }
-                });
-            };
-            ld();
-        }
-        this.bwMeasureCount++;
-    }
 }
-// ClapprStats.REPORT_EVENT = 'clappr:stats:report';
-// ClapprStats.PERCENTAGE_EVENT = 'clappr:stats:percentage';

package/lib/plugins/clappr-stats/types.d.ts

@@ -1,27 +1,70 @@
+/**
+ * @beta
+ */
+export declare enum Chronograph {
+    Startup = "startup",
+    Watch = "watch",
+    Pause = "pause",
+    Buffering = "buffering",
+    Session = "session"
+}
+/**
+ * @beta
+ */
+export 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"
+}
 /**
  * @beta
  */
 export 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;
+        /**
+         *
+         */
+        [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;
     };
-    timers: {
-        startup: number;
-        watch: number;
-        pause: number;
-        buffering: number;
-        session: number;
-        latency: 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;
@@ -37,7 +80,6 @@ export type Metrics = {
         duration: number;
         currentTime: number;
     };
-    custom: Record<string, unknown>;
 };
 /**
  * @beta
@@ -48,15 +90,13 @@ export type BitrateTrackRecord = {
     time?: number;
     bitrate: number;
 };
-/**
- * @beta
- */
-export type MetricsUpdateFn = (metrics: Metrics) => void;
 /**
  * @beta
  */
 export declare enum ClapprStatsEvents {
-    REPORT_EVENT = "clappr:stats:report",
-    PERCENTAGE_EVENT = "clappr:stats:percentage"
+    /**
+     * Emitted periodically with current measurements.
+     */
+    REPORT = "clappr:stats:report"
 }
 //# sourceMappingURL=types.d.ts.map

package/lib/plugins/clappr-stats/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/plugins/clappr-stats/types.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,EAAE,MAAM,CAAC;QACtB,aAAa,EAAE,MAAM,CAAC;QACtB,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,KAAK,EAAE;QACL,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC;QACrB,eAAe,EAAE,kBAAkB,EAAE,CAAC;QACtC,mBAAmB,EAAE,MAAM,CAAC;QAC5B,eAAe,EAAE,MAAM,CAAC;QACxB,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QACtC,iBAAiB,EAAE,MAAM,CAAC;QAC1B,mBAAmB,EAAE,MAAM,CAAC;QAC5B,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAEzD;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,YAAY,wBAAwB;IACpC,gBAAgB,4BAA4B;CAC7C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/plugins/clappr-stats/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,OAAO,YAAY;CAEpB;AAED;;GAEG;AACH,oBAAY,OAAO;IACjB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,aAAa,kBAAkB;IAC/B,aAAa,kBAAkB;IAC/B,GAAG,QAAQ;IACX,WAAW,gBAAgB;IAC3B,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,QAAQ,EAAE;QACR;;WAEG;QACH,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;QACtB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;QACvB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;QACvB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;QAC3B,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;QAC/B,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;QAC/B,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;QACrB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;QAC7B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;QACtB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;QAC5B,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAC3B,CAAA;IACD;;OAEG;IACH,MAAM,EAAE;QACN;;WAEG;QACH,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;QAC7B;;WAEG;QACH,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;QAC3B;;WAEG;QACH,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;QAC3B,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;QAC/B,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAE9B,CAAA;IACD,KAAK,EAAE;QACL,YAAY,EAAE,MAAM,CAAA;QACpB,YAAY,EAAE,MAAM,CAAA;QACpB,eAAe,EAAE,kBAAkB,EAAE,CAAA;QACrC,mBAAmB,EAAE,MAAM,CAAA;QAC3B,eAAe,EAAE,MAAM,CAAA;QACvB,UAAU,EAAE,MAAM,CAAA;QAClB,YAAY,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QACrC,iBAAiB,EAAE,MAAM,CAAA;QACzB,mBAAmB,EAAE,MAAM,CAAA;QAC3B,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,WAAW,EAAE,MAAM,CAAA;KACpB,CAAA;CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B;;OAEG;IACH,MAAM,wBAAwB;CAK/B"}