@gcorevideo/player 2.20.1 → 2.20.3

package/lib/plugins/audio-selector/AudioSelector.js

@@ -4,42 +4,62 @@ import { CLAPPR_VERSION } from '../../build.js';
 import pluginHtml from '../../../assets/audio-selector/track-selector.ejs';
 import '../../../assets/audio-selector/style.scss';
 import audioArrow from '../../../assets/icons/old/quality-arrow.svg';
+import assert from 'assert';
 const VERSION = '0.0.1';
 // const T = 'plugins.audio_selector';
 const AUTO = 0;
 /**
+ * Adds an audio track selector to the media control UI.
  * @beta
  */
 export class AudioSelector extends UICorePlugin {
+    // TODO
     selectedTrackId;
     currentTrack = null;
     tracks = [];
+    /**
+     * @internal
+     */
     get name() {
-        return 'media_control_audio_selector';
+        return 'audio_selector';
     }
+    /**
+     * @internal
+     */
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
+    /**
+     * @internal
+     */
     static get version() {
         return VERSION;
     }
-    get template() {
-        return template(pluginHtml);
-    }
+    static template = template(pluginHtml);
+    /**
+     * @internal
+     */
     get attributes() {
         return {
-            'class': this.name,
-            'data-track-selector': ''
+            class: this.name,
+            'data-track-selector': '',
         };
     }
+    /**
+     * @internal
+     */
     get events() {
         return {
             'click [data-track-selector-select]': 'onTrackSelect',
-            'click [data-track-selector-button]': 'onShowLevelSelectMenu'
+            'click [data-track-selector-button]': 'onShowLevelSelectMenu',
         };
     }
+    /**
+     * @internal
+     */
     bindEvents() {
         this.listenTo(this.core, Events.CORE_READY, this.bindPlaybackEvents);
+        // TODO CORE_ACTIVE_CONTAINER_CHANGED
         this.listenTo(this.core.mediaControl, Events.MEDIACONTROL_CONTAINERCHANGED, this.reload);
         this.listenTo(this.core.mediaControl, Events.MEDIACONTROL_RENDERED, this.render);
         this.listenTo(this.core.mediaControl, Events.MEDIACONTROL_HIDE, this.hideSelectTrackMenu);
@@ -80,12 +100,12 @@ export class AudioSelector extends UICorePlugin {
                 if (defaultTrack) {
                     this.currentTrack = {
                         id: defaultTrack.id,
-                        label: defaultTrack.name
+                        label: defaultTrack.name,
                     };
                 }
-                this.fillTracks(data.audioTracks.map(p => ({
+                this.fillTracks(data.audioTracks.map((p) => ({
                     id: p.id,
-                    label: p.name
+                    label: p.name,
                 })), defaultTrack?.id);
             });
             currentPlayback._hls.on(HlsEvents.AUDIO_TRACK_SWITCHING, this.startTrackSwitch.bind(this));
@@ -131,23 +151,30 @@ export class AudioSelector extends UICorePlugin {
         if (!currentPlayback) {
             return false;
         }
-        const { audioTracks } = (currentPlayback.activePlayback._hls || currentPlayback.$el.get(0));
+        const { audioTracks } = currentPlayback.activePlayback._hls || currentPlayback.$el.get(0);
         this.tracks = audioTracks;
         // Only care if we have at least 2 to choose from
         return this.tracks && this.tracks.length > 1;
     }
+    /**
+     * @internal
+     */
     render() {
-        if (this.shouldRender()) {
-            this.$el.html(this.template({ 'tracks': this.tracks, 'title': this.getTitle() }));
-            if (Object.prototype.hasOwnProperty.call(this.core.mediaControl, '$audioTracksSelector') &&
-                this.core.mediaControl.$audioTracksSelector.length > 0) {
-                this.core.mediaControl.$audioTracksSelector.append(this.el);
-            }
-            this.highlightCurrentTrack();
+        if (!this.shouldRender()) {
+            return this;
         }
-        if (Object.prototype.hasOwnProperty.call(this.core.mediaControl, '$audioTracksSelector') &&
-            this.core.mediaControl.$audioTracksSelector.find('span.audio-arrow').length > 0) {
-            this.core.mediaControl.$audioTracksSelector.find('span.audio-arrow').append(audioArrow);
+        const mediaControl = this.core.getPlugin('media_control');
+        assert(mediaControl, 'media_control plugin is required');
+        this.$el.html(AudioSelector.template({ tracks: this.tracks, title: this.getTitle() }));
+        const ats = mediaControl.getElement('audioTracksSelector');
+        if (!(ats && ats.length > 0)) {
+            return this;
+        }
+        ats.append(this.el);
+        this.highlightCurrentTrack();
+        const aa = ats.find('audioArrow');
+        if (aa.length > 0) {
+            aa.append(audioArrow);
         }
         return this;
     }
@@ -199,9 +226,11 @@ export class AudioSelector extends UICorePlugin {
         this.toggleContextMenu();
     }
     hideSelectTrackMenu() {
+        ;
         this.$('.audio_selector ul').hide();
     }
     toggleContextMenu() {
+        ;
         this.$('.audio_selector ul').toggle();
     }
     buttonElement() {
@@ -211,7 +240,8 @@ export class AudioSelector extends UICorePlugin {
         return this.$('.audio_selector button .audio-text');
     }
     trackElement(id) {
-        return this.$('.audio_selector ul a' + (id !== undefined ? '[data-track-selector-select="' + id + '"]' : '')).parent();
+        return this.$('.audio_selector ul a' +
+            (id !== undefined ? '[data-track-selector-select="' + id + '"]' : '')).parent();
     }
     getTitle() {
         if (!this.tracks) {

package/lib/plugins/big-mute-button/BigMuteButton.d.ts

@@ -1,6 +1,8 @@
 import { UICorePlugin } from '@clappr/core';
 import '../../../assets/big-mute-button/big-mute-button.scss';
 /**
+ * Displays a big mute button over the video when it's muted.
+ * Once pressed, it unmutes the video.
  * @beta
  */
 export declare class BigMuteButton extends UICorePlugin {
@@ -8,17 +10,28 @@ export declare class BigMuteButton extends UICorePlugin {
     private _adIsPlaying;
     private $bigMuteBtnContainer;
     private $bigMuteButton;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
-    get template(): any;
+    private static readonly template;
+    /**
+     * @internal
+     */
     get events(): {
         'click .big-mute-icon': string;
         'click .big-mute-icon-wrapper': string;
     };
+    /**
+     * @internal
+     */
     bindEvents(): void;
-    private unBindEvents;
     private onCoreReady;
     private onContainerVolume;
     private onContainerStart;
@@ -27,6 +40,9 @@ export declare class BigMuteButton extends UICorePlugin {
     private onStartAd;
     private onFinishAd;
     private shouldRender;
+    /**
+     * @internal
+     */
     render(): this;
     private hideBigMuteBtn;
     private showBigMuteBtn;

package/lib/plugins/big-mute-button/BigMuteButton.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BigMuteButton.d.ts","sourceRoot":"","sources":["../../../src/plugins/big-mute-button/BigMuteButton.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,YAAY,EAAS,MAAM,cAAc,CAAC;AAQrE,OAAO,sDAAsD,CAAC;AAI9D;;GAEG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,OAAO,CAAC,qBAAqB,CAAS;IAEtC,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,oBAAoB,CAA4B;IAExD,OAAO,CAAC,cAAc,CAA4B;IAElD,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,QAAQ,QAEX;IAED,IAAa,MAAM;;;MAKlB;IAEQ,UAAU;IAWnB,OAAO,CAAC,YAAY;IAcpB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,YAAY;IAmBX,MAAM;IAqBf,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,qBAAqB;CAS9B"}
+{"version":3,"file":"BigMuteButton.d.ts","sourceRoot":"","sources":["../../../src/plugins/big-mute-button/BigMuteButton.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,YAAY,EAAS,MAAM,cAAc,CAAA;AAQpE,OAAO,sDAAsD,CAAA;AAM7D;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,OAAO,CAAC,qBAAqB,CAAQ;IAErC,OAAO,CAAC,YAAY,CAAQ;IAE5B,OAAO,CAAC,oBAAoB,CAA2B;IAEvD,OAAO,CAAC,cAAc,CAA2B;IAEjD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEvD;;OAEG;IACH,IAAa,MAAM;;;MAKlB;IAED;;OAEG;IACM,UAAU;IAenB,OAAO,CAAC,WAAW;IAkBnB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,YAAY;IAmBpB;;OAEG;IACM,MAAM;IAuBf,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,qBAAqB;CAS9B"}

package/lib/plugins/big-mute-button/BigMuteButton.js

@@ -4,8 +4,11 @@ import { CLAPPR_VERSION } from '../../build.js';
 import volumeMuteIcon from '../../../assets/icons/new/volume-off.svg';
 import pluginHtml from '../../../assets/big-mute-button/big-mute-button.ejs';
 import '../../../assets/big-mute-button/big-mute-button.scss';
-const T = "plugins.big_mute_button";
+const T = 'plugins.big_mute_button';
+// TODO rewrite as a container plugin
 /**
+ * Displays a big mute button over the video when it's muted.
+ * Once pressed, it unmutes the video.
  * @beta
  */
 export class BigMuteButton extends UICorePlugin {
@@ -13,21 +16,31 @@ export class BigMuteButton extends UICorePlugin {
     _adIsPlaying = false;
     $bigMuteBtnContainer = null;
     $bigMuteButton = null;
+    /**
+     * @internal
+     */
     get name() {
         return 'big_mute_button';
     }
+    /**
+     * @internal
+     */
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
-    get template() {
-        return template(pluginHtml);
-    }
+    static template = template(pluginHtml);
+    /**
+     * @internal
+     */
     get events() {
         return {
             'click .big-mute-icon': 'handleBigMuteBtnClick',
             'click .big-mute-icon-wrapper': 'destroyBigMuteBtn',
         };
     }
+    /**
+     * @internal
+     */
     bindEvents() {
         super.bindEvents();
         this.listenTo(this.core, Events.CORE_READY, this.onCoreReady);
@@ -38,17 +51,6 @@ export class BigMuteButton extends UICorePlugin {
         });
         this.listenTo(this.core.mediaControl, Events.MEDIACONTROL_RENDERED, this.mediaControlRendered);
     }
-    unBindEvents() {
-        // @ts-ignore
-        this.stopListening(this.core, Events.CORE_READY);
-        this.stopListening(this.core, 'core:advertisement:start', this.onStartAd);
-        this.stopListening(this.core, 'core:advertisement:finish', this.onFinishAd);
-        this.stopListening(this.core.mediaControl, Events.MEDIACONTROL_RENDERED, this.mediaControlRendered);
-        const container = this.core.activeContainer;
-        if (container) {
-            this.stopListening(container.playback, Events.PLAYBACK_PLAY, this.render);
-        }
-    }
     onCoreReady() {
         this.listenTo(this.core.activeContainer, Events.CONTAINER_VOLUME, this.onContainerVolume);
         this.listenTo(this.core.activeContainer, Events.CONTAINER_READY, this.onContainerStart);
@@ -105,12 +107,15 @@ export class BigMuteButton extends UICorePlugin {
         });
         return autoPlay && !wasMuted && volume === 0;
     }
+    /**
+     * @internal
+     */
     render() {
         if (this.shouldRender()) {
             trace(`${T} render`, {
                 el: !!this.$el,
             });
-            this.$el.html(this.template());
+            this.$el.html(BigMuteButton.template());
             this.$bigMuteBtnContainer = this.$el.find('.big-mute-icon-wrapper[data-big-mute]');
             this._adIsPlaying && this.$bigMuteBtnContainer.addClass('hide');
             this.$bigMuteButton = this.$bigMuteBtnContainer.find('.big-mute-icon');

package/lib/plugins/bottom-gear/BottomGear.d.ts

@@ -4,6 +4,7 @@ import '../../../assets/bottom-gear/gear-sub-menu.scss';
 import { ZeptoResult } from '../../utils/types.js';
 /**
  * Custom events emitted by the plugin
+ * @beta
  */
 export declare enum GearEvents {
     /**

package/lib/plugins/bottom-gear/BottomGear.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BottomGear.d.ts","sourceRoot":"","sources":["../../../src/plugins/bottom-gear/BottomGear.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoC,MAAM,cAAc,CAAC;AAO9E,OAAO,uCAAuC,CAAC;AAC/C,OAAO,gDAAgD,CAAC;AAGxD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAMnD;;GAEG;AACH,oBAAY,UAAU;IACpB;;OAEG;IACH,0BAA0B,+BAA+B;CAC1D;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1D;;;;;;;;;GASG;AACH,qBAAa,UAAW,SAAQ,YAAY;IAC1C,OAAO,CAAC,IAAI,CAAS;IAErB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEvD;;OAEG;IACH,IAAa,UAAU;;;MAKtB;IAED;;OAEG;IACH,IAAa,MAAM;;MAIlB;IAED;;OAEG;IACM,UAAU;IAUnB;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI;IAIrD;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW;IAI/B,OAAO,CAAC,wBAAwB;IAKhC,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,oBAAoB;IAU5B;;OAEG;IACM,MAAM;IAmBf,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,IAAI;CAGb"}
+{"version":3,"file":"BottomGear.d.ts","sourceRoot":"","sources":["../../../src/plugins/bottom-gear/BottomGear.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoC,MAAM,cAAc,CAAC;AAO9E,OAAO,uCAAuC,CAAC;AAC/C,OAAO,gDAAgD,CAAC;AAGxD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAMnD;;;GAGG;AACH,oBAAY,UAAU;IACpB;;OAEG;IACH,0BAA0B,+BAA+B;CAC1D;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1D;;;;;;;;;GASG;AACH,qBAAa,UAAW,SAAQ,YAAY;IAC1C,OAAO,CAAC,IAAI,CAAS;IAErB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEvD;;OAEG;IACH,IAAa,UAAU;;;MAKtB;IAED;;OAEG;IACH,IAAa,MAAM;;MAIlB;IAED;;OAEG;IACM,UAAU;IAUnB;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI;IAIrD;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW;IAI/B,OAAO,CAAC,wBAAwB;IAKhC,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,oBAAoB;IAU5B;;OAEG;IACM,MAAM;IAmBf,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,IAAI;CAGb"}

package/lib/plugins/bottom-gear/BottomGear.js

@@ -11,6 +11,7 @@ const VERSION = '2.19.12';
 const T = 'plugins.bottom_gear';
 /**
  * Custom events emitted by the plugin
+ * @beta
  */
 export var GearEvents;
 (function (GearEvents) {

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

@@ -2,7 +2,10 @@ import { Container, ContainerPlugin } from '@clappr/core';
 import type { QualityLevel } from '../../playback.types.js';
 import type { Metrics, MetricsUpdateFn } from './types.js';
 /**
+ * Collects useful statistics about playback performance.
  * @beta
+ * @remarks
+ * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.
  */
 export declare class ClapprStats extends ContainerPlugin {
     private bwMeasureCount;
@@ -17,27 +20,47 @@ export declare class ClapprStats extends ContainerPlugin {
     private updateFn;
     private urisToMeasureBandwidth;
     private uriToMeasureLatency;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
-    get _playbackName(): string;
-    get _playbackType(): any;
+    private get _playbackName();
+    private get _playbackType();
     private _now;
     private _inc;
     private start;
     private _stop;
+    /**
+     * Registers a callback to receive the metrics.
+     * @param updateMetricsFn
+     */
     setUpdateMetrics(updateMetricsFn: MetricsUpdateFn): void;
-    _defaultReport(metrics: Metrics): void;
+    private _defaultReport;
     constructor(container: Container);
+    /**
+     * @internal
+     */
     bindEvents(): void;
+    /**
+     * @internal
+     */
     destroy(): void;
+    /**
+     * Returns the collected metrics.
+     * @returns The collected metrics
+     */
     exportMetrics(): Metrics;
     onBitrate(newBitrate: QualityLevel): void;
-    stopReporting(): void;
-    startTimers(): void;
-    onFirstPlaying(): void;
-    playAfterPause(): void;
+    private stopReporting;
+    private startTimers;
+    private onFirstPlaying;
+    private playAfterPause;
     private onPlay;
     private onPause;
     private onSeek;
@@ -48,7 +71,7 @@ export declare class ClapprStats extends ContainerPlugin {
     private onProgress;
     private _newMetrics;
     private _onCompletion;
-    _buildReport(): void;
+    private _buildReport;
     private _fetchFPS;
     private _calculateBitrates;
     private _calculatePercentages;

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;AACrF,OAAO,KAAK,EAAE,YAAY,EAA8B,MAAM,yBAAyB,CAAC;AAKxF,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAkB3D;;GAEG;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,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,aAAa,WAEhB;IAED,IAAI,aAAa,QAEhB;IAED,OAAO,CAAC,IAAI;IAMZ,OAAO,CAAC,IAAI;IAQZ,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,KAAK;IAKb,gBAAgB,CAAC,eAAe,EAAE,eAAe;IAIjD,cAAc,CAAC,OAAO,EAAE,OAAO;gBAInB,SAAS,EAAE,SAAS;IAcvB,UAAU;IAmBV,OAAO;IAKhB,aAAa;IAIb,SAAS,CAAC,UAAU,EAAE,YAAY;IAgBlC,aAAa;IAcb,WAAW;IAMX,cAAc;IAOd,cAAc;IAMd,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,YAAY;IAiBZ,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,EAA6B,MAAM,cAAc,CAAC;AACrF,OAAO,KAAK,EAAE,YAAY,EAA8B,MAAM,yBAAyB,CAAC;AAKxF,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;IAIjD,OAAO,CAAC,cAAc;gBAIV,SAAS,EAAE,SAAS;IAchC;;OAEG;IACM,UAAU;IAmBnB;;OAEG;IACM,OAAO;IAKhB;;;OAGG;IACH,aAAa;IAIb,SAAS,CAAC,UAAU,EAAE,YAAY;IAgBlC,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"}

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

@@ -6,7 +6,10 @@ import { newMetrics } from './utils.js';
 // TODO: fix
 const updateMetrics = () => { };
 /**
+ * Collects useful statistics about playback performance.
  * @beta
+ * @remarks
+ * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.
  */
 export class ClapprStats extends ContainerPlugin {
     bwMeasureCount = 0;
@@ -28,9 +31,15 @@ export class ClapprStats extends ContainerPlugin {
     updateFn = updateMetrics;
     urisToMeasureBandwidth;
     uriToMeasureLatency;
+    /**
+     * @internal
+     */
     get name() {
         return 'clappr_stats';
     }
+    /**
+     * @internal
+     */
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
@@ -58,6 +67,10 @@ export class ClapprStats extends ContainerPlugin {
         // 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
+     */
     setUpdateMetrics(updateMetricsFn) {
         this.updateFn = updateMetricsFn;
     }
@@ -76,6 +89,9 @@ export class ClapprStats extends ContainerPlugin {
             calls: []
         };
     }
+    /**
+     * @internal
+     */
     bindEvents() {
         this.listenTo(this.container, CoreEvents.CONTAINER_BITRATE, this.onBitrate);
         this.listenTo(this.container, CoreEvents.CONTAINER_STOP, this.stopReporting);
@@ -94,10 +110,17 @@ export class ClapprStats extends ContainerPlugin {
         this.listenTo(this.container.playback, CoreEvents.PLAYBACK_PROGRESS, this.onProgress);
         this.listenTo(this.container.playback, CoreEvents.PLAYBACK_TIMEUPDATE, this.onTimeUpdate);
     }
+    /**
+     * @internal
+     */
     destroy() {
         this.stopReporting();
         super.destroy();
     }
+    /**
+     * Returns the collected metrics.
+     * @returns The collected metrics
+     */
     exportMetrics() {
         return structuredClone(this.metrics);
     }
@@ -119,6 +142,7 @@ export class ClapprStats extends ContainerPlugin {
             this.intervalId = null;
         }
         this._newMetrics();
+        // TODO
         // @ts-ignore
         this.stopListening();
         this.bindEvents();

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

@@ -1,3 +1,6 @@
+/**
+ * @beta
+ */
 export type Metrics = {
     counters: {
         play: number;
@@ -36,13 +39,22 @@ export type Metrics = {
     };
     custom: Record<string, unknown>;
 };
+/**
+ * @beta
+ */
 export type BitrateTrackRecord = {
     start: number;
     end?: number;
     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"

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":"AAAA,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,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,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAEzD,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":"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"}

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

@@ -1,3 +1,6 @@
+/**
+ * @beta
+ */
 export var ClapprStatsEvents;
 (function (ClapprStatsEvents) {
     ClapprStatsEvents["REPORT_EVENT"] = "clappr:stats:report";

package/lib/plugins/click-to-pause/ClickToPause.d.ts

@@ -1,12 +1,24 @@
 import { ContainerPlugin } from '@clappr/core';
+/**
+ * Adds a behavior of toggling the playback state on click over the container
+ * @beta
+ */
 export declare class ClickToPause extends ContainerPlugin {
     private pointerEnabled;
     private timer;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
-    get config(): any;
+    /**
+     * @internal
+     */
     bindEvents(): void;
     private click;
     private settingsUpdate;

package/lib/plugins/click-to-pause/ClickToPause.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClickToPause.d.ts","sourceRoot":"","sources":["../../../src/plugins/click-to-pause/ClickToPause.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAoB,MAAM,cAAc,CAAC;AAWjE,qBAAa,YAAa,SAAQ,eAAe;IAC/C,OAAO,CAAC,cAAc,CAAS;IAE/B,OAAO,CAAC,KAAK,CAAsB;IAEnC,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAI,MAAM,QAET;IAEQ,UAAU;IAKnB,OAAO,CAAC,KAAK;IAoBb,OAAO,CAAC,cAAc;IAmBtB,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,UAAU;CAMnB"}
+{"version":3,"file":"ClickToPause.d.ts","sourceRoot":"","sources":["../../../src/plugins/click-to-pause/ClickToPause.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAoB,MAAM,cAAc,CAAA;AAShE;;;GAGG;AACH,qBAAa,YAAa,SAAQ,eAAe;IAC/C,OAAO,CAAC,cAAc,CAAQ;IAE9B,OAAO,CAAC,KAAK,CAAqB;IAElC;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACM,UAAU;IASnB,OAAO,CAAC,KAAK;IAoBb,OAAO,CAAC,cAAc;IAmBtB,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,UAAU;CAMnB"}

package/lib/plugins/click-to-pause/ClickToPause.js

@@ -1,22 +1,32 @@
 //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 { ContainerPlugin, Events, Playback } from '@clappr/core';
 import { trace } from '@gcorevideo/utils';
 import { CLAPPR_VERSION } from '../../build.js';
 const T = 'plugins.click_to_pause_custom';
+/**
+ * Adds a behavior of toggling the playback state on click over the container
+ * @beta
+ */
 export class ClickToPause extends ContainerPlugin {
     pointerEnabled = false;
     timer = null;
+    /**
+     * @internal
+     */
     get name() {
         return 'click_to_pause_custom';
     }
+    /**
+     * @internal
+     */
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
-    get config() {
-        return this.container.options.clickToPauseConfig || {};
-    }
+    /**
+     * @internal
+     */
     bindEvents() {
         this.listenTo(this.container, Events.CONTAINER_CLICK, this.click);
         this.listenTo(this.container, Events.CONTAINER_SETTINGSUPDATE, this.settingsUpdate);

package/lib/plugins/clips/Clips.d.ts

@@ -1,25 +1,57 @@
 import { UICorePlugin } from '@clappr/core';
 import '../../../assets/clips/clips.scss';
+/**
+ * Configuration options
+ */
+export interface ClipsPluginSettings {
+    /**
+     * The text to display over the seekbar.
+     */
+    text: string;
+}
+/**
+ * Adds a behavior of showing a text over the seekbar to indicate the current clip.
+ * @beta
+ * @remarks
+ * Depends on:
+ *
+ * - {@link MediaControl}
+ *
+ * Configuration options - {@link ClipsPluginSettings}
+ */
 export declare class ClipsPlugin extends UICorePlugin {
     private clips;
     private duration;
     private durationGetting;
     private _oldContainer;
     private svgMask;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get attributes(): {
         class: string;
     };
+    /**
+     * @internal
+     */
     bindEvents(): void;
     private _onCoreReady;
-    unbindEvents(): void;
     private _onMediaControlContainerChanged;
     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;
-    makeSvg(duration: number): void;
+    private makeSvg;
     private setSVGMask;
     private setClipText;
 }

package/lib/plugins/clips/Clips.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Clips.d.ts","sourceRoot":"","sources":["../../../src/plugins/clips/Clips.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,YAAY,EAAK,MAAM,cAAc,CAAC;AAKlE,OAAO,kCAAkC,CAAC;AAc1C,qBAAa,WAAY,SAAQ,YAAY;IAC3C,OAAO,CAAC,KAAK,CAAmC;IAEhD,OAAO,CAAC,QAAQ,CAAa;IAE7B,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,aAAa,CAAwB;IAE7C,OAAO,CAAC,OAAO,CAA4B;IAE3C,IAAI,IAAI,WAEP;IAED,IAAa,UAAU;;MAItB;IAEQ,UAAU;IAMnB,OAAO,CAAC,YAAY;IAUpB,YAAY;IAOZ,OAAO,CAAC,+BAA+B;IAIvC,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,UAAU;IAwBlB,OAAO,CAAC,IAAI,EAAE,MAAM;IASpB,OAAO,CAAC,QAAQ,EAAE,MAAM;IAuBxB,OAAO,CAAC,UAAU;IAelB,OAAO,CAAC,WAAW;CAOpB"}
+{"version":3,"file":"Clips.d.ts","sourceRoot":"","sources":["../../../src/plugins/clips/Clips.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,YAAY,EAAK,MAAM,cAAc,CAAA;AAKjE,OAAO,kCAAkC,CAAA;AAezC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;;;;;GASG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C,OAAO,CAAC,KAAK,CAAmC;IAEhD,OAAO,CAAC,QAAQ,CAAY;IAE5B,OAAO,CAAC,eAAe,CAAQ;IAE/B,OAAO,CAAC,aAAa,CAAuB;IAE5C,OAAO,CAAC,OAAO,CAA2B;IAE1C;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED;;OAEG;IACM,UAAU;IAanB,OAAO,CAAC,YAAY;IAUpB,OAAO,CAAC,+BAA+B;IAIvC,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,oBAAoB;IAmB5B,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,UAAU;IA4BlB;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM;IASpB,OAAO,CAAC,OAAO;IA4Bf,OAAO,CAAC,UAAU;IAiBlB,OAAO,CAAC,WAAW;CAQpB"}