@gcorevideo/player 2.22.0 → 2.22.2

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

@@ -1,4 +1,18 @@
 import { UICorePlugin, Core } from '@clappr/core';
+/**
+ * @beta
+ */
+export type PlaybackRateOption = {
+    value: number;
+    label: string;
+};
+/**
+ * @beta
+ */
+export type PlaybackRateSettings = {
+    options?: PlaybackRateOption[];
+    defaultValue?: number;
+};
 /**
  * `PLUGIN` that allows changing the playback speed of the video.
  * @beta
@@ -6,17 +20,32 @@ import { UICorePlugin, Core } from '@clappr/core';
  * @remarks
  * Depends on:
  *
- * - {@link MediaControl | media_control}
+ * - {@link MediaControl}
+ *
+ * - {@link BottomGear}
+ *
+ * It renders an option in the gear menu, which opens a dropdown with the options to change the playback rate.
+ * Note that the playback rate change is supported only for VOD or DVR-enabled live streams.
  *
- * - {@link BottomGear | bottom_gear}
+ * Plugin settings - {@link PlaybackRateSettings}
  *
- * It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate.
- * Note that the playback rate change is supported only for VOD or DVR enabled live streams.
+ * @example
+ * ```ts
+ * import { Player, PlaybackRateSettings } from '@gcorevideo/player'
+ * Player.registerPlugin(PlaybackRate)
+ * const player = new Player({
+ *   playbackRate: {
+ *     options: [
+ *       { value: 0.5, label: '0.5x' },
+ *       { value: 1, label: '1x' },
+ *     ],
+ *     defaultValue: 1,
+ *   } as PlaybackRateSettings,
+ * })
+ * ```
  */
 export declare class PlaybackRate extends UICorePlugin {
     private playbackRates;
-    private prevSelectedRate;
-    private rendered;
     private selectedRate;
     /**
      * @internal
@@ -41,9 +70,8 @@ export declare class PlaybackRate extends UICorePlugin {
      * @internal
      */
     get events(): {
-        'click .gear-sub-menu_btn': string;
-        'click .gear-option': string;
-        'click .go-back': string;
+        'click [data-rate]': string;
+        'click #playback-rate-back-button': string;
     };
     /**
      * @internal
@@ -51,8 +79,10 @@ export declare class PlaybackRate extends UICorePlugin {
     bindEvents(): void;
     private onCoreReady;
     private onActiveContainerChange;
+    private onMediaControlRendered;
     private onGearRendered;
-    private onDvrStateChanged;
+    private addGearItem;
+    private onMetaDataLoaded;
     private allRateElements;
     private rateElement;
     private onPlaybackRateChange;
@@ -61,16 +91,14 @@ export declare class PlaybackRate extends UICorePlugin {
      * @internal
      */
     render(): this;
-    private onStartAd;
-    private onFinishAd;
     private onPlay;
     private resetPlaybackRate;
     private onStop;
-    private onRateSelect;
-    private onShowMenu;
+    private onSelect;
     private goBack;
     private setSelectedRate;
     private getTitle;
     private highlightCurrentRate;
+    private updateGearOptionLabel;
 }
 //# 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,IAAI,EAAE,MAAM,cAAc,CAAA;AAuC7E;;;;;;;;;;;;;GAaG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAO,CAAC,aAAa,CAA+C;IAGpE,OAAO,CAAC,gBAAgB,CAAoB;IAE5C,OAAO,CAAC,QAAQ,CAAQ;IAExB,OAAO,CAAC,YAAY,CAAgC;IAEpD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAuB;IAE7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAqB;gBAE7C,IAAI,EAAE,IAAI;IAQtB;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED;;OAEG;IACH,IAAa,MAAM;;;;MAMlB;IAED;;OAEG;IACM,UAAU;IASnB,OAAO,CAAC,WAAW;IAanB,OAAO,CAAC,uBAAuB;IAgB/B,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,YAAY;IAepB;;OAEG;IACM,MAAM;IAgCf,OAAO,CAAC,SAAS;IAUjB,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,MAAM;IAWd,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,MAAM;IAEd,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,UAAU;IAalB,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,QAAQ;IAOhB,OAAO,CAAC,oBAAoB;CAS7B"}
+{"version":3,"file":"PlaybackRate.d.ts","sourceRoot":"","sources":["../../../src/plugins/playback-rate/PlaybackRate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAsB,IAAI,EAAK,MAAM,cAAc,CAAA;AAiBhF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAgBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAO,CAAC,aAAa,CAA+C;IAKpE,OAAO,CAAC,YAAY,CAAwB;IAE5C;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAuB;IAE7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAqB;gBAE7C,IAAI,EAAE,IAAI;IAQtB;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED;;OAEG;IACH,IAAa,MAAM;;;MAKlB;IAED;;OAEG;IACM,UAAU;IASnB,OAAO,CAAC,WAAW;IAenB,OAAO,CAAC,uBAAuB;IAgB/B,OAAO,CAAC,sBAAsB;IAK9B,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,WAAW;IAiBnB,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,YAAY;IAepB;;OAEG;IACM,MAAM;IAwCf,OAAO,CAAC,MAAM;IAWd,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,MAAM;IAEd,OAAO,CAAC,QAAQ;IAchB,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,QAAQ;IAOhB,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,qBAAqB;CAI9B"}

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

@@ -1,4 +1,4 @@
-import { Events, UICorePlugin, Playback, template } from '@clappr/core';
+import { Events, UICorePlugin, Playback, template, $ } from '@clappr/core';
 import { trace } from '@gcorevideo/utils';
 import assert from 'assert';
 import { CLAPPR_VERSION } from '../../build.js';
@@ -8,18 +8,18 @@ import speedIcon from '../../../assets/icons/new/speed.svg';
 import arrowRightIcon from '../../../assets/icons/new/arrow-right.svg';
 import arrowLeftIcon from '../../../assets/icons/new/arrow-left.svg';
 import checkIcon from '../../../assets/icons/new/check.svg';
+import { GearEvents } from '../bottom-gear/BottomGear.js';
 import { PlaybackEvents } from '../../playback/types.js';
-import { MediaControlEvents, } from '../media-control/MediaControl.js';
 const DEFAULT_PLAYBACK_RATES = [
-    { value: '0.5', label: '0.5x' },
-    { value: '0.75', label: '0.75x' },
-    { value: '1.0', label: '1x' },
-    { value: '1.25', label: '1.25x' },
-    { value: '1.5', label: '1.5x' },
-    { value: '1.75', label: '1.75x' },
-    { value: '2.0', label: '2x' },
+    { value: 0.5, label: '0.5x' },
+    { value: 0.75, label: '0.75x' },
+    { value: 1.0, label: '1x' },
+    { value: 1.25, label: '1.25x' },
+    { value: 1.5, label: '1.5x' },
+    { value: 1.75, label: '1.75x' },
+    { value: 2.0, label: '2x' },
 ];
-const DEFAULT_PLAYBACK_RATE = '1.0';
+const DEFAULT_PLAYBACK_RATE = 1;
 const T = 'plugins.playback_rate';
 /**
  * `PLUGIN` that allows changing the playback speed of the video.
@@ -28,18 +28,34 @@ const T = 'plugins.playback_rate';
  * @remarks
  * Depends on:
  *
- * - {@link MediaControl | media_control}
+ * - {@link MediaControl}
  *
- * - {@link BottomGear | bottom_gear}
+ * - {@link BottomGear}
  *
- * It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate.
- * Note that the playback rate change is supported only for VOD or DVR enabled live streams.
+ * It renders an option in the gear menu, which opens a dropdown with the options to change the playback rate.
+ * Note that the playback rate change is supported only for VOD or DVR-enabled live streams.
+ *
+ * Plugin settings - {@link PlaybackRateSettings}
+ *
+ * @example
+ * ```ts
+ * import { Player, PlaybackRateSettings } from '@gcorevideo/player'
+ * Player.registerPlugin(PlaybackRate)
+ * const player = new Player({
+ *   playbackRate: {
+ *     options: [
+ *       { value: 0.5, label: '0.5x' },
+ *       { value: 1, label: '1x' },
+ *     ],
+ *     defaultValue: 1,
+ *   } as PlaybackRateSettings,
+ * })
+ * ```
  */
 export class PlaybackRate extends UICorePlugin {
     playbackRates = DEFAULT_PLAYBACK_RATES;
     // Saved when an ad starts to restore after it finishes
-    prevSelectedRate;
-    rendered = false;
+    // private prevSelectedRate: string | undefined
     selectedRate = DEFAULT_PLAYBACK_RATE;
     /**
      * @internal
@@ -75,16 +91,15 @@ export class PlaybackRate extends UICorePlugin {
      */
     get events() {
         return {
-            'click .gear-sub-menu_btn': 'onRateSelect',
-            'click .gear-option': 'onShowMenu',
-            'click .go-back': 'goBack',
+            'click [data-rate]': 'onSelect',
+            'click #playback-rate-back-button': 'goBack',
         };
     }
     /**
      * @internal
      */
     bindEvents() {
-        this.listenTo(this.core, Events.CORE_READY, this.onCoreReady);
+        this.listenToOnce(this.core, Events.CORE_READY, this.onCoreReady);
         this.listenTo(this.core, Events.CORE_ACTIVE_CONTAINER_CHANGED, this.onActiveContainerChange);
     }
     onCoreReady() {
@@ -93,45 +108,56 @@ export class PlaybackRate extends UICorePlugin {
         assert(mediaControl, 'media_control plugin is required');
         const gear = this.core.getPlugin('bottom_gear');
         assert(gear, 'bottom_gear plugin is required');
-        this.listenTo(mediaControl, MediaControlEvents.MEDIACONTROL_GEAR_RENDERED, this.onGearRendered);
+        this.listenTo(mediaControl, Events.MEDIACONTROL_RENDERED, this.onMediaControlRendered);
+        this.listenTo(gear, GearEvents.RENDERED, this.onGearRendered);
     }
     onActiveContainerChange() {
         trace(`${T} onActiveContainerChange`);
         this.listenTo(this.core.activePlayback, Events.PLAYBACK_STOP, this.onStop);
         this.listenTo(this.core.activePlayback, Events.PLAYBACK_PLAY, this.onPlay);
         this.listenTo(this.core.activePlayback, PlaybackEvents.PLAYBACK_RATE_CHANGED, this.onPlaybackRateChange);
-        this.listenTo(this.core.activeContainer, Events.CONTAINER_PLAYBACKDVRSTATECHANGED, this.onDvrStateChanged);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_LOADEDMETADATA, this.onMetaDataLoaded);
     }
-    onGearRendered() {
-        trace(`${T} onGearRendered`, {
-            rendered: this.rendered,
-        });
-        this.rendered = false;
+    onMediaControlRendered() {
+        trace(`${T} onMediaControlRendered`);
         this.render();
     }
-    onDvrStateChanged(dvrEnabled) {
-        trace(`${T} onDvrStateChanged`, {
-            dvrEnabled,
-        });
-        if (dvrEnabled) {
-            this.render();
-        }
+    onGearRendered() {
+        trace(`${T} onGearRendered`);
+        this.addGearItem();
+    }
+    addGearItem() {
+        trace(`${T} addGearItem`);
+        this.core
+            .getPlugin('bottom_gear')
+            ?.addItem('rate', this.$el)
+            .html($(PlaybackRate.buttonTemplate({
+            title: this.getTitle(),
+            speedIcon,
+            arrowRightIcon,
+            i18n: this.core.i18n,
+        })));
+    }
+    onMetaDataLoaded() {
+        trace(`${T} onMetaDataLoaded`);
+        this.render();
     }
     allRateElements() {
-        return this.$('ul.gear-sub-menu li');
+        return this.$el.find('#playback-rate-menu li');
     }
-    rateElement(rate = '1') {
-        return this.$(`ul.gear-sub-menu a[data-rate="${rate}"]`).parent();
+    rateElement(rate) {
+        return this.$el.find(`#playback-rate-menu a[data-rate="${rate}"]`).parent();
     }
     onPlaybackRateChange(playbackRate) {
-        const selectedRate = parseInt(this.selectedRate, 10);
         // TODO check it doesn't interfere with the DASH.js or HLS.js playback live catchup
-        if (Math.abs(playbackRate - selectedRate) > 0.1) {
-            trace(`${T} onPlaybackRateChange setting target rate`, {
+        if (Math.abs(playbackRate - this.selectedRate) > 0.1) {
+            this.core.activePlayback?.setPlaybackRate(this.selectedRate);
+        }
+        else {
+            trace(`${T} onPlaybackRateChange not steering to the selected rate, it is seemingly a catchup algorithm working`, {
                 playbackRate,
-                selectedRate,
+                selectedRate: this.selectedRate,
             });
-            this.core.activePlayback?.setPlaybackRate(selectedRate);
         }
     }
     shouldRender() {
@@ -149,38 +175,35 @@ export class PlaybackRate extends UICorePlugin {
      */
     render() {
         trace(`${T} render`, {
-            rendered: this.rendered,
             shouldRender: this.shouldRender(),
         });
         if (!this.shouldRender()) {
             return this;
         }
-        if (this.rendered) {
-            return this;
-        }
-        const button = PlaybackRate.buttonTemplate({
-            title: this.getTitle(),
-            speedIcon,
-            arrowRightIcon,
+        this.$el.html(PlaybackRate.listTemplate({
+            arrowLeftIcon,
+            checkIcon,
+            current: this.selectedRate,
             i18n: this.core.i18n,
-        });
-        this.$el.html(button);
-        this.core.getPlugin('bottom_gear')
-            ?.getElement('rate')
-            ?.html(this.el);
-        this.rendered = true;
+            playbackRates: this.playbackRates,
+        }));
+        this.addGearItem();
         return this;
     }
-    onStartAd() {
-        this.prevSelectedRate = this.selectedRate;
-        this.resetPlaybackRate();
-        this.listenToOnce(this.core.activePlayback, Events.PLAYBACK_PLAY, this.onFinishAd);
-    }
-    onFinishAd() {
-        if (this.prevSelectedRate) {
-            this.setSelectedRate(this.prevSelectedRate);
-        }
-    }
+    // private onStartAd() {
+    //   this.prevSelectedRate = this.selectedRate
+    //   this.resetPlaybackRate()
+    //   this.listenToOnce(
+    //     this.core.activePlayback,
+    //     Events.PLAYBACK_PLAY,
+    //     this.onFinishAd,
+    //   )
+    // }
+    // private onFinishAd() {
+    //   if (this.prevSelectedRate) {
+    //     this.setSelectedRate(this.prevSelectedRate)
+    //   }
+    // }
     onPlay() {
         if (this.core.getPlaybackType() === Playback.LIVE &&
             !this.core.activePlayback.dvrEnabled) {
@@ -194,44 +217,39 @@ export class PlaybackRate extends UICorePlugin {
         this.setSelectedRate(DEFAULT_PLAYBACK_RATE);
     }
     onStop() { }
-    onRateSelect(event) {
+    onSelect(event) {
         event.stopPropagation();
-        const rate = event.currentTarget.dataset.rate;
+        const rate = parseFloat(event.currentTarget.dataset.rate || '');
         if (rate) {
             this.setSelectedRate(rate);
             this.highlightCurrentRate();
+            this.updateGearOptionLabel();
         }
         return false;
     }
-    onShowMenu() {
-        this.$el.html(PlaybackRate.listTemplate({
-            playbackRates: this.playbackRates,
-            arrowLeftIcon,
-            checkIcon,
-            i18n: this.core.i18n,
-        }));
-        this.core.getPlugin('bottom_gear')?.setContent(this.el);
-        this.highlightCurrentRate();
-    }
     goBack() {
         setTimeout(() => {
             this.core.getPlugin('bottom_gear').refresh();
         }, 0);
     }
     setSelectedRate(rate) {
-        // Set <video playbackRate="..."
         this.core.activePlayback?.setPlaybackRate(rate);
         this.selectedRate = rate;
     }
     getTitle() {
         return (this.playbackRates.find((r) => r.value === this.selectedRate)?.label ||
-            this.selectedRate);
+            `x${this.selectedRate}`);
     }
     highlightCurrentRate() {
         this.allRateElements().removeClass('current');
         this.allRateElements().find('a').removeClass('gcore-skin-active');
-        const currentLevelElement = this.rateElement(this.selectedRate);
-        currentLevelElement.addClass('current');
-        currentLevelElement.find('a').addClass('gcore-skin-active');
+        this.rateElement(this.selectedRate)
+            .addClass('current')
+            .find('a')
+            .addClass('gcore-skin-active');
+    }
+    updateGearOptionLabel() {
+        trace(`${T} updateGearOptionLabel`);
+        this.addGearItem();
     }
 }

package/lib/plugins/source-controller/SourceController.d.ts

@@ -1,10 +1,46 @@
 import { CorePlugin, type Core as ClapprCore } from '@clappr/core';
 /**
- * `PLUGIN` that is responsible for managing the automatic failover between sources.
- * @beta
+ * `PLUGIN` that is managing the automatic failover between media sources.
+ * @public
  * @remarks
  * Have a look at the {@link https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787 | source failover diagram} for the details
- * on how sources ordering and selection works.
+ * on how sources ordering and selection works. Below is a simplified diagram:
+ *
+ * ```markdown
+ * sources_list:
+ *       - a.mpd  |    +--------------------+
+ *       - b.m3u8 |--->|         init       |
+ *       - ...    |    |--------------------|
+ *                     | current_source = 0 |
+ *                     +--------------------+
+ *                            |
+ *                            |  source = a.mpd
+ *                            |  playback = dash.js
+ *                            v
+ *                      +------------------+
+ *                  +-->|   load source    |
+ *                  |   +---------|--------+
+ *                  |             v
+ *                  |   +------------------+
+ *                  |   |       play       |
+ *                  |   +---------|--------+
+ *                  |             |
+ *                  |             v
+ *                  |   +-----------------------+
+ *                  |   |  on playback_error    |
+ *                  |   |-----------------------|
+ *                  |   | current_source =      |
+ *                  |   |  (current_source + 1) |
+ *                  |   |  % len sources_list   |
+ *                  |   |                       |
+ *                  |   | delay 1..3s           |
+ *                  |   +---------------|-------+
+ *                  |                   |
+ *                  |   source=b.m3u8   |
+ *                  |   playback=hls.js |
+ *                  +-------------------+
+ *
+ * ```
  *
  * This plugin does not expose any public methods apart from required by the Clappr plugin interface.
  * It is supposed to work autonomously.
@@ -34,7 +70,7 @@ export declare class SourceController extends CorePlugin {
         min: string;
     };
     /**
-     * @internal
+     * @param core - The Clappr core instance.
      */
     constructor(core: ClapprCore);
     /**

package/lib/plugins/source-controller/SourceController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SourceController.d.ts","sourceRoot":"","sources":["../../../src/plugins/source-controller/SourceController.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,KAAK,IAAI,IAAI,UAAU,EACxB,MAAM,cAAc,CAAA;AAwBrB;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,gBAAiB,SAAQ,UAAU;IAuC9C,OAAO,CAAC,WAAW,CAA8B;IAEjD,OAAO,CAAC,kBAAkB,CAAI;IAE9B,OAAO,CAAC,YAAY,CAA6B;IAEjD,OAAO,CAAC,MAAM,CAAQ;IAEtB,OAAO,CAAC,SAAS,CAAQ;IAEzB,OAAO,CAAC,IAAI,CAAiB;IAE7B;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;gBACS,IAAI,EAAE,UAAU;IAW5B;;OAEG;IACM,UAAU;IAWnB,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,wBAAwB;IAoBhC,OAAO,CAAC,2BAA2B;IAwCnC,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,aAAa;IA4BrB,OAAO,CAAC,kBAAkB;IAe1B;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;CACF"}
+{"version":3,"file":"SourceController.d.ts","sourceRoot":"","sources":["../../../src/plugins/source-controller/SourceController.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,KAAK,IAAI,IAAI,UAAU,EACxB,MAAM,cAAc,CAAA;AAwBrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,qBAAa,gBAAiB,SAAQ,UAAU;IAwC9C,OAAO,CAAC,WAAW,CAA8B;IAEjD,OAAO,CAAC,kBAAkB,CAAI;IAE9B,OAAO,CAAC,YAAY,CAA6B;IAEjD,OAAO,CAAC,MAAM,CAAQ;IAEtB,OAAO,CAAC,SAAS,CAAQ;IAEzB,OAAO,CAAC,IAAI,CAAiB;IAE7B;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;gBACS,IAAI,EAAE,UAAU;IAW5B;;OAEG;IACM,UAAU;IAWnB,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,wBAAwB;IAoBhC,OAAO,CAAC,2BAA2B;IAwCnC,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,aAAa;IA4BrB,OAAO,CAAC,kBAAkB;IAe1B;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;CACF"}

package/lib/plugins/source-controller/SourceController.js

@@ -12,11 +12,47 @@ function noSync(cb) {
     queueMicrotask(cb);
 }
 /**
- * `PLUGIN` that is responsible for managing the automatic failover between sources.
- * @beta
+ * `PLUGIN` that is managing the automatic failover between media sources.
+ * @public
  * @remarks
  * Have a look at the {@link https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787 | source failover diagram} for the details
- * on how sources ordering and selection works.
+ * on how sources ordering and selection works. Below is a simplified diagram:
+ *
+ * ```markdown
+ * sources_list:
+ *       - a.mpd  |    +--------------------+
+ *       - b.m3u8 |--->|         init       |
+ *       - ...    |    |--------------------|
+ *                     | current_source = 0 |
+ *                     +--------------------+
+ *                            |
+ *                            |  source = a.mpd
+ *                            |  playback = dash.js
+ *                            v
+ *                      +------------------+
+ *                  +-->|   load source    |
+ *                  |   +---------|--------+
+ *                  |             v
+ *                  |   +------------------+
+ *                  |   |       play       |
+ *                  |   +---------|--------+
+ *                  |             |
+ *                  |             v
+ *                  |   +-----------------------+
+ *                  |   |  on playback_error    |
+ *                  |   |-----------------------|
+ *                  |   | current_source =      |
+ *                  |   |  (current_source + 1) |
+ *                  |   |  % len sources_list   |
+ *                  |   |                       |
+ *                  |   | delay 1..3s           |
+ *                  |   +---------------|-------+
+ *                  |                   |
+ *                  |   source=b.m3u8   |
+ *                  |   playback=hls.js |
+ *                  +-------------------+
+ *
+ * ```
  *
  * This plugin does not expose any public methods apart from required by the Clappr plugin interface.
  * It is supposed to work autonomously.
@@ -66,6 +102,7 @@ export class SourceController extends CorePlugin {
      *                  |   playback=hls.js |
      *                  +-------------------+
      *
+     * As can be seen from the diagram, the plugin will endless try to load the next sources rotating between them in round-robin manner.
      */
     sourcesList = [];
     currentSourceIndex = 0;
@@ -86,7 +123,7 @@ export class SourceController extends CorePlugin {
         return { min: CLAPPR_VERSION };
     }
     /**
-     * @internal
+     * @param core - The Clappr core instance.
      */
     constructor(core) {
         super(core);

package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts

@@ -2,20 +2,20 @@ import { Container, UIContainerPlugin } from '@clappr/core';
 import '../../../assets/spinner-three-bounce/spinner.scss';
 /**
  * Custom events emitted by the plugin
- * @beta
+ * @public
  */
 export declare enum SpinnerEvents {
     /**
      * Emitted at the end of the spinner animation cycle to facilitate smooth UI updates,
-     * e.g. {@link SourceController} listens to this event to reload the source when the spinner is hidden
+     * for instance, {@link SourceController} listens to this event to reload the source when the spinner is hidden
      */
     SYNC = "plugins:spinner:sync"
 }
 /**
- * `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state
- * @beta
+ * `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state.
+ * @public
  * @remarks
- * Events emitted- {@link SpinnerEvents}
+ * Events emitted - {@link SpinnerEvents}
  * Other plugins can use {@link SpinnerThreeBounce.show | show} and {@link SpinnerThreeBounce.hide | hide} methods to
  * implement custom pending/progress indication scenarios.
  */
@@ -51,7 +51,9 @@ export declare class SpinnerThreeBounce extends UIContainerPlugin {
     /**
      * Shows the spinner.
      *
-     * When called, the spinner will not hide (due to its built-in logic) until {@link SpinnerThreeBounce.hide} is called
+     * The method call prevents spinner's built-in logic from automatically hiding it until {@link SpinnerThreeBounce.hide} is called
+     *
+     * @param delay - The delay in milliseconds before the spinner is shown.
      */
     show(delay?: number): void;
     /**

package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpinnerThreeBounce.d.ts","sourceRoot":"","sources":["../../../src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,SAAS,EAET,iBAAiB,EAElB,MAAM,cAAc,CAAA;AAKrB,OAAO,mDAAmD,CAAA;AAM1D;;;GAGG;AACH,oBAAY,aAAa;IACvB;;;OAGG;IACH,IAAI,yBAAyB;CAC9B;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB;IACvD,OAAO,CAAC,SAAS,CAAQ;IAEzB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,IAAa,UAAU;;;MAKtB;IAED,OAAO,CAAC,WAAW,CAAuB;IAE1C,OAAO,CAAC,QAAQ,CAAwB;IAExC,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,YAAY,CAAQ;gBAEhB,SAAS,EAAE,SAAS;IAmBhC,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,MAAM;IAKd,OAAO,CAAC,MAAM;IAOd,OAAO,CAAC,OAAO;IAUf;;;;OAIG;IACH,IAAI,CAAC,KAAK,SAAM;IAMhB;;OAEG;IACH,IAAI;IAKJ,OAAO,CAAC,KAAK;IASb,OAAO,CAAC,KAAK;IAeb;;OAEG;IACM,MAAM;CAiBhB"}
+{"version":3,"file":"SpinnerThreeBounce.d.ts","sourceRoot":"","sources":["../../../src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,SAAS,EAET,iBAAiB,EAElB,MAAM,cAAc,CAAA;AAKrB,OAAO,mDAAmD,CAAA;AAM1D;;;GAGG;AACH,oBAAY,aAAa;IACvB;;;OAGG;IACH,IAAI,yBAAyB;CAC9B;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB;IACvD,OAAO,CAAC,SAAS,CAAQ;IAEzB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,IAAa,UAAU;;;MAKtB;IAED,OAAO,CAAC,WAAW,CAAuB;IAE1C,OAAO,CAAC,QAAQ,CAAwB;IAExC,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,YAAY,CAAQ;gBAEhB,SAAS,EAAE,SAAS;IAmBhC,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,MAAM;IAKd,OAAO,CAAC,MAAM;IAOd,OAAO,CAAC,OAAO;IAUf;;;;;;OAMG;IACH,IAAI,CAAC,KAAK,SAAM;IAMhB;;OAEG;IACH,IAAI;IAKJ,OAAO,CAAC,KAAK;IASb,OAAO,CAAC,KAAK;IAeb;;OAEG;IACM,MAAM;CAiBhB"}

package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.js

@@ -1,6 +1,8 @@
+// This work is based on the original work of Globo.com
 // 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.
+// https://github.com/clappr/clappr-plugins/blob/ffaa9d27005fa5a8a7c243ffc47eb5655b84b371/LICENSE
 import { Events as ClapprEvents, UIContainerPlugin, template, } from '@clappr/core';
 import { trace } from '@gcorevideo/utils';
 import { PlaybackErrorCode } from '../../playback.types.js';
@@ -10,21 +12,21 @@ import { CLAPPR_VERSION } from '../../build.js';
 const T = 'plugins.spinner';
 /**
  * Custom events emitted by the plugin
- * @beta
+ * @public
  */
 export var SpinnerEvents;
 (function (SpinnerEvents) {
     /**
      * Emitted at the end of the spinner animation cycle to facilitate smooth UI updates,
-     * e.g. {@link SourceController} listens to this event to reload the source when the spinner is hidden
+     * for instance, {@link SourceController} listens to this event to reload the source when the spinner is hidden
      */
     SpinnerEvents["SYNC"] = "plugins:spinner:sync";
 })(SpinnerEvents || (SpinnerEvents = {}));
 /**
- * `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state
- * @beta
+ * `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state.
+ * @public
  * @remarks
- * Events emitted- {@link SpinnerEvents}
+ * Events emitted - {@link SpinnerEvents}
  * Other plugins can use {@link SpinnerThreeBounce.show | show} and {@link SpinnerThreeBounce.hide | hide} methods to
  * implement custom pending/progress indication scenarios.
  */
@@ -97,7 +99,9 @@ export class SpinnerThreeBounce extends UIContainerPlugin {
     /**
      * Shows the spinner.
      *
-     * When called, the spinner will not hide (due to its built-in logic) until {@link SpinnerThreeBounce.hide} is called
+     * The method call prevents spinner's built-in logic from automatically hiding it until {@link SpinnerThreeBounce.hide} is called
+     *
+     * @param delay - The delay in milliseconds before the spinner is shown.
      */
     show(delay = 300) {
         trace(`${T} show`);

package/lib/plugins/subtitles/ClosedCaptions.d.ts

@@ -1,21 +1,21 @@
 import { UICorePlugin } from '@clappr/core';
 import '../../../assets/subtitles/style.scss';
+/**
+ * Configuration options for the {@link ClosedCaptions} plugin.
+ * @beta
+ */
 export type ClosedCaptionsPluginSettings = {
     /**
-     * Initially selected subtitles language
+     * Initially selected subtitles language.
      */
     language?: string;
 };
-/**
- * @deprecated Use {@link ClosedCaptionsPluginSettings} instead.
- */
-export type SubtitlesPluginSettings = ClosedCaptionsPluginSettings;
 /**
  * `PLUGIN` that provides a UI to select the subtitles when available.
  * @beta
  *
  * @remarks
- * The plugin is activated when closed captions tracks are provided with the media source.
+ * The plugin is activated when closed captions tracks are detected in the media source.
  * It shows a familiar "CC" button with a dropdown menu to select the subtitles language.
  *
  * Depends on:
@@ -32,7 +32,7 @@ export type SubtitlesPluginSettings = ClosedCaptionsPluginSettings;
  * new Player({
  *   ...
  *   cc: {
- *     language: 'en',
+ *     language: 'pt-BR',
  *   },
  * })
  * ```