@gcorevideo/player 2.19.15 → 2.20.3

package/lib/plugins/playback-rate/PlaybackRate.d.ts

@@ -1,42 +1,75 @@
 import { UICorePlugin } from '@clappr/core';
+/**
+ * Allows changing the playback speed of the video.
+ * @beta
+ *
+ * @remarks
+ * Depends on:
+ *
+ * - {@link MediaControl | media_control}
+ *
+ * - {@link BottomGear | bottom_gear}
+ *
+ * It renders a button in the gear menu, which opens a dropdown with the available playback rates.
+ */
 export declare class PlaybackRate extends UICorePlugin {
     private currentPlayback;
     private playbackRates;
     private prevSelectedRate;
     private selectedRate;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
-    get template(): any;
+    private static readonly template;
+    private static readonly buttonTemplate;
+    private static readonly listTemplate;
+    /**
+     * @internal
+     */
     get attributes(): {
         class: string;
         'data-playback-rate-select': string;
     };
+    /**
+     * @internal
+     */
     get events(): {
         'click .gear-sub-menu_btn': string;
         'click .gear-option': string;
         'click .go-back': string;
     };
+    /**
+     * @internal
+     */
     bindEvents(): void;
-    unBindEvents(): void;
+    private unBindEvents;
     private allRateElements;
     private rateElement;
     private onDashRateChange;
     private updateLiveStatus;
-    reload(): void;
+    private reload;
     private shouldRender;
+    /**
+     * @internal
+     */
     render(): this;
-    onStartAd(): void;
-    onFinishAd(): void;
-    onPlay(): void;
-    onStop(): void;
-    onRateSelect(event: MouseEvent): boolean;
-    onShowMenu(): void;
-    goBack(): void;
-    updatePlaybackRate(rate: string): void;
-    setSelectedRate(rate: string): void;
-    getTitle(): string;
-    highlightCurrentRate(): void;
+    private onStartAd;
+    private onFinishAd;
+    private onPlay;
+    private onStop;
+    private onRateSelect;
+    private onShowMenu;
+    private goBack;
+    private updatePlaybackRate;
+    private setSelectedRate;
+    private getTitle;
+    private highlightCurrentRate;
 }
 //# sourceMappingURL=PlaybackRate.d.ts.map

package/lib/plugins/playback-rate/PlaybackRate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PlaybackRate.d.ts","sourceRoot":"","sources":["../../../src/plugins/playback-rate/PlaybackRate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAsB,MAAM,cAAc,CAAC;AAiCxE,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAO,CAAC,eAAe,CAAyB;IAEhD,OAAO,CAAC,aAAa,CAAgD;IAErE,OAAO,CAAC,gBAAgB,CAAqB;IAE7C,OAAO,CAAC,YAAY,CAAiC;IAErD,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,QAAQ,QAEX;IAED,IAAa,UAAU;;;MAKtB;IAED,IAAa,MAAM;;;;MAMlB;IAEQ,UAAU;IAoBnB,YAAY;IAOZ,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,gBAAgB;IAcxB,MAAM;IAKN,OAAO,CAAC,YAAY;IAUX,MAAM;IAyCf,SAAS;IAMT,UAAU;IAMV,MAAM;IAWN,MAAM;IAIN,YAAY,CAAC,KAAK,EAAE,UAAU;IAW9B,UAAU;IAaV,MAAM;IAIN,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAI/B,eAAe,CAAC,IAAI,EAAE,MAAM;IAQ5B,QAAQ;IAYR,oBAAoB;CASrB"}
+{"version":3,"file":"PlaybackRate.d.ts","sourceRoot":"","sources":["../../../src/plugins/playback-rate/PlaybackRate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAsB,MAAM,cAAc,CAAC;AAiCxE;;;;;;;;;;;;GAYG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAO,CAAC,eAAe,CAAyB;IAEhD,OAAO,CAAC,aAAa,CAAgD;IAErE,OAAO,CAAC,gBAAgB,CAAqB;IAE7C,OAAO,CAAC,YAAY,CAAiC;IAErD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAwB;IAExD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAwB;IAE9D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAsB;IAE1D;;OAEG;IACH,IAAa,UAAU;;;MAKtB;IAED;;OAEG;IACH,IAAa,MAAM;;;;MAMlB;IAED;;OAEG;IACM,UAAU;IAqBnB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,MAAM;IAKd,OAAO,CAAC,YAAY;IAUpB;;OAEG;IACM,MAAM;IAuCf,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,MAAM;IAWd,OAAO,CAAC,MAAM;IAGd,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,UAAU;IAWlB,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,QAAQ;IAYhB,OAAO,CAAC,oBAAoB;CAS7B"}

package/lib/plugins/playback-rate/PlaybackRate.js

@@ -19,26 +19,51 @@ const DEFAULT_PLAYBACK_RATES = [
 const DEFAULT_PLAYBACK_RATE = '1.0';
 // TODO
 const MEDIACONTROL_PLAYBACKRATE = 'playbackRate';
+/**
+ * Allows changing the playback speed of the video.
+ * @beta
+ *
+ * @remarks
+ * Depends on:
+ *
+ * - {@link MediaControl | media_control}
+ *
+ * - {@link BottomGear | bottom_gear}
+ *
+ * It renders a button in the gear menu, which opens a dropdown with the available playback rates.
+ */
 export class PlaybackRate extends UICorePlugin {
     currentPlayback = null;
     playbackRates = DEFAULT_PLAYBACK_RATES;
     prevSelectedRate;
     selectedRate = DEFAULT_PLAYBACK_RATE;
+    /**
+     * @internal
+     */
     get name() {
-        return 'media_control_playback_rate';
+        return 'playback_rate';
     }
+    /**
+     * @internal
+     */
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
-    get template() {
-        return template(pluginHtml);
-    }
+    static template = template(pluginHtml);
+    static buttonTemplate = template(buttonHtml);
+    static listTemplate = template(listHtml);
+    /**
+     * @internal
+     */
     get attributes() {
         return {
             'class': this.name,
             'data-playback-rate-select': ''
         };
     }
+    /**
+     * @internal
+     */
     get events() {
         return {
             'click .gear-sub-menu_btn': 'onRateSelect',
@@ -46,8 +71,12 @@ export class PlaybackRate extends UICorePlugin {
             'click .go-back': 'goBack',
         };
     }
+    /**
+     * @internal
+     */
     bindEvents() {
         this.listenTo(this.core, 'gear:rendered', this.render);
+        // TODO this.core.getPlugin('media_control'), bottom_gear
         this.listenTo(this.core.mediaControl, Events.MEDIACONTROL_CONTAINERCHANGED, this.reload);
         this.listenTo(this.core.mediaControl, MEDIACONTROL_PLAYBACKRATE, this.updatePlaybackRate);
         this.listenTo(this.core, 'core:advertisement:start', this.onStartAd);
@@ -101,6 +130,9 @@ export class PlaybackRate extends UICorePlugin {
         this.currentPlayback = this.core.activePlayback;
         return !(this.currentPlayback?.tagName !== 'video' && this.currentPlayback?.tagName !== 'audio');
     }
+    /**
+     * @internal
+     */
     render() {
         const container = this.core.activeContainer;
         if (this.core.getPlaybackType() === Playback.LIVE && !container.isDvrEnabled()) {
@@ -114,9 +146,7 @@ export class PlaybackRate extends UICorePlugin {
             this.selectedRate = cfg.defaultValue || DEFAULT_PLAYBACK_RATE;
         }
         if (this.shouldRender()) {
-            const t = template(buttonHtml);
-            // const html = t({ playbackRates: this.playbackRates, title: this.getTitle() });
-            const button = t({
+            const button = PlaybackRate.buttonTemplate({
                 title: this.getTitle(),
                 speedIcon,
                 arrowRightIcon,
@@ -164,8 +194,7 @@ export class PlaybackRate extends UICorePlugin {
         return false;
     }
     onShowMenu() {
-        const t = template(listHtml);
-        this.$el.html(t({
+        this.$el.html(PlaybackRate.listTemplate({
             playbackRates: this.playbackRates,
             arrowLeftIcon,
             checkIcon,

package/lib/plugins/seek-time/SeekTime.d.ts

@@ -1,5 +1,9 @@
 import { UICorePlugin } from '@clappr/core';
 import '../../../assets/seek-time/seek-time.scss';
+/**
+ * The plugin adds a seek time indicator to the media control UI.
+ * @beta
+ */
 export declare class SeekTime extends UICorePlugin {
     get name(): string;
     get supportedVersion(): {

package/lib/plugins/seek-time/SeekTime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SeekTime.d.ts","sourceRoot":"","sources":["../../../src/plugins/seek-time/SeekTime.ts"],"names":[],"mappings":"AAIA,OAAO,EAAoB,YAAY,EAAmB,MAAM,cAAc,CAAC;AAM/E,OAAO,0CAA0C,CAAC;AAKlD,qBAAa,QAAS,SAAQ,YAAY;IACxC,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,QAAQ,QAEX;IAED,IAAa,UAAU;;;MAKtB;IAED,IAAI,YAAY,QAEf;IAED,IAAI,qBAAqB,QAExB;IAED,IAAI,mBAAmB,QAItB;IAED,IAAI,aAAa,YAEhB;IAED,OAAO,CAAC,mBAAmB,CAAS;IAEpC,OAAO,CAAC,aAAa,CAAK;IAE1B,OAAO,CAAC,iBAAiB,CAAuB;IAEhD,OAAO,CAAC,iBAAiB,CAAsB;IAE/C,OAAO,CAAC,QAAQ,CAAK;IAGrB,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,WAAW,CAA4B;IAE/C,OAAO,CAAC,WAAW,CAA4B;IAEtC,UAAU;IAWnB,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,QAAQ;IAMhB,OAAO,CAAC,QAAQ;IAKhB,OAAO,CAAC,sBAAsB;IAO9B,WAAW;;;IAYX,MAAM;IA8CN,eAAe;IAQN,MAAM;CAahB"}
+{"version":3,"file":"SeekTime.d.ts","sourceRoot":"","sources":["../../../src/plugins/seek-time/SeekTime.ts"],"names":[],"mappings":"AAIA,OAAO,EAAoB,YAAY,EAAmB,MAAM,cAAc,CAAC;AAM/E,OAAO,0CAA0C,CAAC;AAKlD;;;GAGG;AACH,qBAAa,QAAS,SAAQ,YAAY;IACxC,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,QAAQ,QAEX;IAED,IAAa,UAAU;;;MAKtB;IAED,IAAI,YAAY,QAEf;IAED,IAAI,qBAAqB,QAExB;IAED,IAAI,mBAAmB,QAItB;IAED,IAAI,aAAa,YAEhB;IAED,OAAO,CAAC,mBAAmB,CAAS;IAEpC,OAAO,CAAC,aAAa,CAAK;IAE1B,OAAO,CAAC,iBAAiB,CAAuB;IAEhD,OAAO,CAAC,iBAAiB,CAAsB;IAE/C,OAAO,CAAC,QAAQ,CAAK;IAGrB,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,WAAW,CAA4B;IAE/C,OAAO,CAAC,WAAW,CAA4B;IAEtC,UAAU;IAWnB,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,QAAQ;IAMhB,OAAO,CAAC,QAAQ;IAKhB,OAAO,CAAC,sBAAsB;IAO9B,WAAW;;;IAYX,MAAM;IA8CN,eAAe;IAQN,MAAM;CAahB"}

package/lib/plugins/seek-time/SeekTime.js

@@ -1,11 +1,15 @@
 // Copyright 2014 Globo.com Player authors. All rights reserved.
 // Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
+// license that can be found at https://github.com/clappr/clappr-plugins/blob/master/LICENSE
 import { Events, Playback, UICorePlugin, Utils, template } from '@clappr/core';
 import { CLAPPR_VERSION } from '../../build.js';
 import seekTimeHTML from '../../../assets/seek-time/seek-time.html';
 import '../../../assets/seek-time/seek-time.scss';
 const { formatTime } = Utils;
+/**
+ * The plugin adds a seek time indicator to the media control UI.
+ * @beta
+ */
 export class SeekTime extends UICorePlugin {
     get name() {
         return 'media_control_seek_time';

package/lib/plugins/share/Share.d.ts

@@ -1,5 +1,8 @@
 import { UICorePlugin } from '@clappr/core';
 import '../../../assets/share/style.scss';
+/**
+ * The plugin adds a share button to the media control UI.
+ */
 export declare class Share extends UICorePlugin {
     private hide;
     private container;

package/lib/plugins/share/Share.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Share.d.ts","sourceRoot":"","sources":["../../../src/plugins/share/Share.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,YAAY,EAAY,MAAM,cAAc,CAAC;AAKzE,OAAO,kCAAkC,CAAC;AAM1C,qBAAa,KAAM,SAAQ,YAAY;IACrC,OAAO,CAAC,IAAI,CAAS;IAErB,OAAO,CAAC,SAAS,CAA0B;IAE3C,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,QAAQ,QAEX;IAED,IAAa,UAAU;;;MAKtB;IAED,IAAa,MAAM;;;;;;;MASlB;IAEQ,UAAU;IAQnB,YAAY;IAaZ,YAAY;IAIZ,OAAO,CAAC,OAAO;IASN,MAAM;IAgBf,SAAS;IAIT,SAAS;IAOT,eAAe;IASf,WAAW;IAIX,WAAW;IAIX,SAAS;IAQT,SAAS;IAQT,gBAAgB;IAIhB,iBAAiB;CAGlB"}
+{"version":3,"file":"Share.d.ts","sourceRoot":"","sources":["../../../src/plugins/share/Share.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,YAAY,EAAY,MAAM,cAAc,CAAC;AAKzE,OAAO,kCAAkC,CAAC;AAM1C;;GAEG;AACH,qBAAa,KAAM,SAAQ,YAAY;IACrC,OAAO,CAAC,IAAI,CAAS;IAErB,OAAO,CAAC,SAAS,CAA0B;IAE3C,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,QAAQ,QAEX;IAED,IAAa,UAAU;;;MAKtB;IAED,IAAa,MAAM;;;;;;;MASlB;IAEQ,UAAU;IAQnB,YAAY;IAaZ,YAAY;IAIZ,OAAO,CAAC,OAAO;IASN,MAAM;IAgBf,SAAS;IAIT,SAAS;IAOT,eAAe;IASf,WAAW;IAIX,WAAW;IAIX,SAAS;IAQT,SAAS;IAQT,gBAAgB;IAIhB,iBAAiB;CAGlB"}

package/lib/plugins/share/Share.js

@@ -6,6 +6,9 @@ import shareIcon from '../../../assets/icons/old/share.svg';
 import closeIcon from '../../../assets/icons/old/close-share.svg';
 import fbIcon from '../../../assets/icons/old/fb.svg';
 import twIcon from '../../../assets/icons/old/twitter.svg';
+/**
+ * The plugin adds a share button to the media control UI.
+ */
 export class Share extends UICorePlugin {
     hide = false;
     container = null;

package/lib/plugins/skip-time/SkipTime.d.ts

@@ -1,5 +1,8 @@
 import { UICorePlugin as UICorePluginOriginal } from '@clappr/core';
 import '../../../assets/skip-time/style.scss';
+/**
+ * The plugin adds skip controls to the media control UI.
+ */
 export declare class SkipTime extends UICorePluginOriginal {
     get name(): string;
     get supportedVersion(): {

package/lib/plugins/skip-time/SkipTime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SkipTime.d.ts","sourceRoot":"","sources":["../../../src/plugins/skip-time/SkipTime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,oBAAoB,EAAuC,MAAM,cAAc,CAAC;AAKzG,OAAO,sCAAsC,CAAC;AAI9C,qBAAa,QAAS,SAAQ,oBAAoB;IAChD,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,SAAS,QAEZ;IAED,IAAI,QAAQ,QAEX;IAED,IAAa,UAAU;;;MAKtB;IAED,OAAO,CAAC,QAAQ,CAAmB;IAEnC,IAAa,MAAM;;;;MAMlB;IAEQ,UAAU;IAQnB,OAAO;IAIP,kBAAkB;IA4BlB,WAAW;IAIX,UAAU;IAIV,gBAAgB;IAMP,MAAM;CAWhB"}
+{"version":3,"file":"SkipTime.d.ts","sourceRoot":"","sources":["../../../src/plugins/skip-time/SkipTime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,oBAAoB,EAAuC,MAAM,cAAc,CAAC;AAKzG,OAAO,sCAAsC,CAAC;AAI9C;;GAEG;AACH,qBAAa,QAAS,SAAQ,oBAAoB;IAChD,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,SAAS,QAEZ;IAED,IAAI,QAAQ,QAEX;IAED,IAAa,UAAU;;;MAKtB;IAED,OAAO,CAAC,QAAQ,CAAmB;IAEnC,IAAa,MAAM;;;;MAMlB;IAEQ,UAAU;IAQnB,OAAO;IAIP,kBAAkB;IA4BlB,WAAW;IAIX,UAAU;IAIV,gBAAgB;IAMP,MAAM;CAWhB"}

package/lib/plugins/skip-time/SkipTime.js

@@ -2,6 +2,9 @@ import { UICorePlugin as UICorePluginOriginal, Browser, Playback, Events, templa
 import { CLAPPR_VERSION } from '../../build.js';
 import pluginHtml from '../../../assets/skip-time/skip-time.ejs';
 import '../../../assets/skip-time/style.scss';
+/**
+ * The plugin adds skip controls to the media control UI.
+ */
 export class SkipTime extends UICorePluginOriginal {
     get name() {
         return 'skip_time';

package/lib/plugins/statistics/Statistics.d.ts

@@ -1,10 +1,13 @@
 import { Container, ContainerPlugin } from '@clappr/core';
-import type { PlaybackType } from '../..//types';
+import type { PlaybackType } from '../../types';
 type StatisticsEventData = Record<string, string | number | boolean>;
 type StatisticsRecord = {
     event: StatisticsEvent;
     type: PlaybackType;
 } & StatisticsEventData;
+/**
+ * Plugin settings
+ */
 export type PluginSettings = {
     /**
      * Sends the statistics record to the storage.
@@ -14,8 +17,37 @@ export type PluginSettings = {
     send: (data: StatisticsRecord) => void;
 };
 type StatisticsEvent = 'init' | 'start' | 'watch' | 'heatmap';
+/**
+ * Collects and reports the performance statistics.
+ * @beta
+ * @example
+ * ```ts
+ * import { Statistics } from '@gcorevideo/player'
+ *
+ * Player.registerPlugin(Statistics)
+ *
+ * const player = new Player({
+ *   statistics: {
+ *     send: (data) => {
+ *        fetch('/stats', {
+ *          method: 'POST',
+ *          body: JSON.stringify(data),
+ *          headers: { 'content-type': 'application/json' },
+ *        })
+ *     }
+ *   },
+ *   ...
+ * })
+ * ```
+ */
 export declare class Statistics extends ContainerPlugin {
+    /**
+     * The name of the plugin.
+     */
     get name(): string;
+    /**
+     * The supported version of the plugin.
+     */
     get supportedVersion(): {
         min: string;
     };
@@ -35,13 +67,16 @@ export declare class Statistics extends ContainerPlugin {
      */
     private bufAccDuration;
     constructor(container: Container);
+    /**
+     * @internal
+     */
     bindEvents(): void;
     private startLevelSwitch;
-    private stopLevelSwitch;
+    private endLevelSwitch;
     private onBuffering;
     private onBufferFull;
     private onReady;
-    private initEvent;
+    private sendInit;
     private sendMessage;
     private send;
     private sendHeatmap;

package/lib/plugins/statistics/Statistics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Statistics.d.ts","sourceRoot":"","sources":["../../../src/plugins/statistics/Statistics.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAoB,MAAM,cAAc,CAAA;AAE3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAYhD,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;AAEpE,KAAK,gBAAgB,GAAG;IACtB,KAAK,EAAE,eAAe,CAAA;IACtB,IAAI,EAAE,YAAY,CAAA;CACnB,GAAG,mBAAmB,CAAA;AAEvB,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;OAIG;IACH,IAAI,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAA;CACvC,CAAA;AAED,KAAK,eAAe,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;AAG7D,qBAAa,UAAW,SAAQ,eAAe;IAC7C,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,OAAO,CAAQ;IAEvB,OAAO,CAAC,SAAS,CAAI;IAErB,OAAO,CAAC,WAAW,CAAQ;IAE3B,OAAO,CAAC,eAAe,CAAI;IAE3B,OAAO,CAAC,SAAS,CAAQ;IAEzB,OAAO,CAAC,WAAW,CAAQ;IAE3B,OAAO,CAAC,IAAI,CAAI;IAEhB;;OAEG;IACH,OAAO,CAAC,cAAc,CAAI;IAE1B;;OAEG;IACH,OAAO,CAAC,cAAc,CAAI;gBAEd,SAAS,EAAE,SAAS;IASvB,UAAU;IAoCnB,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,OAAO;IAOf,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,IAAI;IAQZ,OAAO,CAAC,WAAW;IAgBnB,OAAO,CAAC,gBAAgB;IAuBxB,OAAO,CAAC,OAAO;CAOhB"}
+{"version":3,"file":"Statistics.d.ts","sourceRoot":"","sources":["../../../src/plugins/statistics/Statistics.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAoB,MAAM,cAAc,CAAA;AAK3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAY/C,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;AAEpE,KAAK,gBAAgB,GAAG;IACtB,KAAK,EAAE,eAAe,CAAA;IACtB,IAAI,EAAE,YAAY,CAAA;CACnB,GAAG,mBAAmB,CAAA;AAEvB;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;OAIG;IACH,IAAI,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAA;CACvC,CAAA;AAED,KAAK,eAAe,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,UAAW,SAAQ,eAAe;IAC7C;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,OAAO,CAAQ;IAEvB,OAAO,CAAC,SAAS,CAAI;IAErB,OAAO,CAAC,WAAW,CAAQ;IAE3B,OAAO,CAAC,eAAe,CAAI;IAE3B,OAAO,CAAC,SAAS,CAAQ;IAEzB,OAAO,CAAC,WAAW,CAAQ;IAE3B,OAAO,CAAC,IAAI,CAAI;IAEhB;;OAEG;IACH,OAAO,CAAC,cAAc,CAAI;IAE1B;;OAEG;IACH,OAAO,CAAC,cAAc,CAAI;gBAEd,SAAS,EAAE,SAAS;IAShC;;OAEG;IACM,UAAU;IAoCnB,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,OAAO;IAgBf,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,IAAI;IAQZ,OAAO,CAAC,WAAW;IAgBnB,OAAO,CAAC,gBAAgB;IAuBxB,OAAO,CAAC,OAAO;CAOhB"}

package/lib/plugins/statistics/Statistics.js

@@ -1,16 +1,45 @@
 // An example implementation of client side performancestatistics
 import { ContainerPlugin, Events, Playback } from '@clappr/core';
-import { reportError } from '@gcorevideo/utils';
+import { reportError, trace } from '@gcorevideo/utils';
 import assert from 'assert';
 import { CLAPPR_VERSION } from '../../build.js';
-const CUSTOM_EVENTS_CONTAINER_START = 'container:start';
+// const CUSTOM_EVENTS_CONTAINER_START = 'container:start'
 const WATCH_CUTOFF = 5;
 const HEATMAP_INTERVAL = 10;
-// TODO rewrite as core plugin
+const T = 'plugins.statistics';
+/**
+ * Collects and reports the performance statistics.
+ * @beta
+ * @example
+ * ```ts
+ * import { Statistics } from '@gcorevideo/player'
+ *
+ * Player.registerPlugin(Statistics)
+ *
+ * const player = new Player({
+ *   statistics: {
+ *     send: (data) => {
+ *        fetch('/stats', {
+ *          method: 'POST',
+ *          body: JSON.stringify(data),
+ *          headers: { 'content-type': 'application/json' },
+ *        })
+ *     }
+ *   },
+ *   ...
+ * })
+ * ```
+ */
 export class Statistics extends ContainerPlugin {
+    /**
+     * The name of the plugin.
+     */
     get name() {
-        return 'statistics_gplayer';
+        return 'statistics';
     }
+    /**
+     * The supported version of the plugin.
+     */
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
@@ -34,20 +63,27 @@ export class Statistics extends ContainerPlugin {
         assert(this.options.statistics &&
             typeof this.options.statistics.send === 'function', 'Statistics plugin requires statistics options');
     }
+    /**
+     * @internal
+     */
     bindEvents() {
         // TODO remove this
-        this.listenToOnce(this.container, CUSTOM_EVENTS_CONTAINER_START, this.onStart);
+        // this.listenToOnce(
+        //   this.container,
+        //   CUSTOM_EVENTS_CONTAINER_START,
+        //   this.onStart,
+        // )
         this.listenToOnce(this.container, Events.CONTAINER_READY, this.onReady);
         this.listenTo(this.container, Events.CONTAINER_STATE_BUFFERING, this.onBuffering);
         this.listenTo(this.container, Events.CONTAINER_STATE_BUFFERFULL, this.onBufferFull);
         this.listenTo(this.container.playback, Events.PLAYBACK_TIMEUPDATE, this.onTimeUpdateLive);
         this.listenTo(this.container.playback, Events.PLAYBACK_LEVEL_SWITCH_START, this.startLevelSwitch);
-        this.listenTo(this.container.playback, Events.PLAYBACK_LEVEL_SWITCH_END, this.stopLevelSwitch);
+        this.listenTo(this.container.playback, Events.PLAYBACK_LEVEL_SWITCH_END, this.endLevelSwitch);
     }
     startLevelSwitch() {
         this.bufTracking = false;
     }
-    stopLevelSwitch() {
+    endLevelSwitch() {
         this.bufTracking = true;
     }
     onBuffering() {
@@ -63,12 +99,18 @@ export class Statistics extends ContainerPlugin {
         this.bufTracking = true;
     }
     onReady() {
-        this.initEvent();
+        this.sendInit();
+        trace(`${T} onReady`, {
+            autoPlay: this.options.autoPlay,
+        });
         if (this.options.autoPlay) {
             this.onStart();
         }
+        else {
+            this.listenToOnce(this.container.playback, Events.PLAYBACK_PLAY_INTENT, this.onStart);
+        }
     }
-    initEvent() {
+    sendInit() {
         this.sendMessage('init');
     }
     sendMessage(state) {

package/lib/plugins/telemetry/Telemetry.d.ts

@@ -0,0 +1,153 @@
+import { Container, ContainerPlugin } from '@clappr/core';
+import type { PlaybackType } from '../../types.js';
+/**
+ * Telemetry event data
+ * @beta
+ */
+export type TelemetryEventData = StallEventData | InitEventData | StartEventData | WatchEventData;
+/**
+ * Playback stall event data
+ * @beta
+ */
+export interface StallEventData {
+    event: TelemetryEvent.Stall;
+    /**
+     * Accumulated buffering duration over the measurement interval, ms
+     */
+    total_ms: number;
+    /**
+     * Number of stalls
+     */
+    count: number;
+    /**
+     * Playback time when the stall is reported at the end of a stall measurement interval, s
+     */
+    time: number;
+}
+/**
+ * Telemetry init event data
+ * @beta
+ */
+export interface InitEventData {
+    event: TelemetryEvent.Init;
+}
+/**
+ * Telemetry start event data
+ * @beta
+ */
+export interface StartEventData {
+    event: TelemetryEvent.Start;
+}
+/**
+ * Telemetry watch event data
+ * @beta
+ */
+export interface WatchEventData {
+    event: TelemetryEvent.Watch;
+}
+/**
+ * Telemetry record
+ * @beta
+ */
+export type TelemetryRecord = {
+    type: PlaybackType;
+} & TelemetryEventData;
+/**
+ * Callback to send the telemetry record to the storage.
+ * @param data - The telemetry record to send.
+ * @beta
+ */
+type TelemetrySendFn = (data: TelemetryRecord) => void;
+/**
+ * Plugin settings
+ * @beta
+ */
+export interface TelemetryPluginSettings {
+    /**
+     * Sends the statistics record to the storage.
+     * The actual delivery is presumably async and batched.
+     */
+    send: TelemetrySendFn;
+}
+/**
+ * Telemetry event type
+ * @beta
+ */
+export declare enum TelemetryEvent {
+    Init = 1,
+    Start = 2,
+    Watch = 3,
+    Stall = 4
+}
+/**
+ * Collects and reports the performance statistics.
+ * @beta
+ * @remarks
+ * This plugin is experimental and its API is likely to change.
+ *
+ * Configuration options {@link TelemetryPluginSettings}
+ *
+ * @example
+ * ```ts
+ * import { Statistics } from '@gcorevideo/player'
+ *
+ * Player.registerPlugin(Statistics)
+ *
+ * const player = new Player({
+ *   statistics: {
+ *     send: (data) => {
+ *        fetch('/stats', {
+ *          method: 'POST',
+ *          body: JSON.stringify(data),
+ *          headers: { 'content-type': 'application/json' },
+ *        })
+ *     },
+ *   },
+ *   ...
+ * })
+ * ```
+ */
+export declare class Telemetry extends ContainerPlugin {
+    /**
+     * The name of the plugin.
+     */
+    get name(): string;
+    /**
+     * The supported version of the plugin.
+     */
+    get supportedVersion(): {
+        min: string;
+    };
+    private started;
+    private timeStart;
+    private stallSent;
+    private stallLastTime;
+    private watchSent;
+    private bufTracking;
+    private numStalls;
+    /**
+     * The time when buffering last started.
+     */
+    private bufLastStarted;
+    /**
+     * The accumulated buffering duration.
+     */
+    private stallAcc;
+    constructor(container: Container);
+    /**
+     * @internal
+     */
+    bindEvents(): void;
+    private startLevelSwitch;
+    private endLevelSwitch;
+    private onBuffering;
+    private onBufferFull;
+    private onReady;
+    private sendInit;
+    private send;
+    private sendStall;
+    private onTimeUpdate;
+    private onStart;
+}
+export {};
+//# sourceMappingURL=Telemetry.d.ts.map

package/lib/plugins/telemetry/Telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Telemetry.d.ts","sourceRoot":"","sources":["../../../src/plugins/telemetry/Telemetry.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAU,MAAM,cAAc,CAAA;AAKjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAUlD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAA;AAEjG;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,cAAc,CAAC,KAAK,CAAA;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,cAAc,CAAC,IAAI,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,cAAc,CAAC,KAAK,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,cAAc,CAAC,KAAK,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,YAAY,CAAA;CACnB,GAAG,kBAAkB,CAAC;AAEvB;;;;GAIG;AACH,KAAK,eAAe,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAA;AAEtD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,IAAI,EAAE,eAAe,CAAA;CACtB;AAED;;;GAGG;AACH,oBAAY,cAAc;IACxB,IAAI,IAAI;IACR,KAAK,IAAA;IACL,KAAK,IAAA;IACL,KAAK,IAAA;CACN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,SAAU,SAAQ,eAAe;IAC5C;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,OAAO,CAAQ;IAEvB,OAAO,CAAC,SAAS,CAAI;IAErB,OAAO,CAAC,SAAS,CAAQ;IAEzB,OAAO,CAAC,aAAa,CAAI;IAEzB,OAAO,CAAC,SAAS,CAAQ;IAEzB,OAAO,CAAC,WAAW,CAAQ;IAE3B,OAAO,CAAC,SAAS,CAAI;IAErB;;OAEG;IACH,OAAO,CAAC,cAAc,CAAI;IAE1B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAI;gBAER,SAAS,EAAE,SAAS;IAUhC;;OAEG;IACM,UAAU;IAoCnB,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,OAAO;IAgBf,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,IAAI;IAOZ,OAAO,CAAC,SAAS;IAejB,OAAO,CAAC,YAAY;IAuBpB,OAAO,CAAC,OAAO;CAShB"}