@gcorevideo/player 2.19.14 → 2.20.1

package/lib/plugins/media-control/MediaControl.js

@@ -119,14 +119,14 @@ export class MediaControl extends UICorePlugin {
      * @deprecated
      */
     get container() {
-        return this.core && this.core.activeContainer;
+        return this.core.activeContainer;
     }
     /**
      * @internal
      * @deprecated
      */
     get playback() {
-        return this.core && this.core.activePlayback;
+        return this.core.activePlayback;
     }
     /**
      * @internal
@@ -219,7 +219,6 @@ export class MediaControl extends UICorePlugin {
         this.listenTo(this.core, Events.CORE_FULLSCREEN, this.show);
         this.listenTo(this.core, Events.CORE_OPTIONS_CHANGE, this.configure);
         this.listenTo(this.core, Events.CORE_RESIZE, this.playerResize);
-        this.bindContainerEvents();
         this.listenTo(this.core, 'core:advertisement:start', this.onStartAd);
         this.listenTo(this.core, 'core:advertisement:finish', this.onFinishAd);
         // const has360 = this.core?.getPlugin('video_360');
@@ -243,26 +242,23 @@ export class MediaControl extends UICorePlugin {
         // }
     }
     bindContainerEvents() {
-        if (!this.container) {
-            return;
-        }
-        this.listenTo(this.container, Events.CONTAINER_PLAY, this.changeTogglePlay);
-        this.listenTo(this.container, Events.CONTAINER_PAUSE, this.changeTogglePlay);
-        this.listenTo(this.container, Events.CONTAINER_STOP, this.changeTogglePlay);
-        this.listenTo(this.container, Events.CONTAINER_DBLCLICK, this.toggleFullscreen);
-        this.listenTo(this.container, Events.CONTAINER_TIMEUPDATE, this.onTimeUpdate);
-        this.listenTo(this.container, Events.CONTAINER_PROGRESS, this.updateProgressBar);
-        this.listenTo(this.container, Events.CONTAINER_SETTINGSUPDATE, this.settingsUpdate);
-        this.listenTo(this.container, Events.CONTAINER_PLAYBACKDVRSTATECHANGED, this.settingsUpdate);
-        this.listenTo(this.container, Events.CONTAINER_HIGHDEFINITIONUPDATE, this.highDefinitionUpdate);
-        this.listenTo(this.container, Events.CONTAINER_MEDIACONTROL_DISABLE, this.disable);
-        this.listenTo(this.container, Events.CONTAINER_MEDIACONTROL_ENABLE, this.enable);
-        this.listenTo(this.container, Events.CONTAINER_ENDED, this.ended);
-        this.listenTo(this.container, Events.CONTAINER_VOLUME, this.onVolumeChanged);
-        this.listenTo(this.container, Events.CONTAINER_OPTIONS_CHANGE, this.setInitialVolume);
-        if (this.container.playback.el.nodeName.toLowerCase() === 'video') {
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_PLAY, this.changeTogglePlay);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_PAUSE, this.changeTogglePlay);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_STOP, this.changeTogglePlay);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_DBLCLICK, this.toggleFullscreen);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_TIMEUPDATE, this.onTimeUpdate);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_PROGRESS, this.updateProgressBar);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_SETTINGSUPDATE, this.settingsUpdate);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_PLAYBACKDVRSTATECHANGED, this.settingsUpdate);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_HIGHDEFINITIONUPDATE, this.highDefinitionUpdate);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_MEDIACONTROL_DISABLE, this.disable);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_MEDIACONTROL_ENABLE, this.enable);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_ENDED, this.ended);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_VOLUME, this.onVolumeChanged);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_OPTIONS_CHANGE, this.setInitialVolume);
+        if (this.core.activePlayback.el.nodeName.toLowerCase() === 'video') {
             // wait until the metadata has loaded and then check if fullscreen on video tag is supported
-            this.listenToOnce(this.container, Events.CONTAINER_LOADEDMETADATA, this.onLoadedMetadataOnVideoTag);
+            this.listenToOnce(this.core.activeContainer, Events.CONTAINER_LOADEDMETADATA, this.onLoadedMetadataOnVideoTag);
         }
     }
     /**
@@ -297,7 +293,7 @@ export class MediaControl extends UICorePlugin {
         this.updateVolumeUI();
     }
     onLoadedMetadataOnVideoTag(event) {
-        const video = this.playback && this.playback.el;
+        const video = this.core.activePlayback?.el;
         // video.webkitSupportsFullscreen is deprecated but iOS appears to only use this
         // see https://github.com/clappr/clappr/issues/1127
         if (!Fullscreen.fullscreenEnabled() && video.webkitSupportsFullscreen) {
@@ -528,24 +524,25 @@ export class MediaControl extends UICorePlugin {
     }
     onActiveContainerChanged() {
         this.fullScreenOnVideoTagSupported = null;
-        this.bindEvents();
         // set the new container to match the volume of the last one
         this.setInitialVolume();
         this.changeTogglePlay();
         this.bindContainerEvents();
         this.settingsUpdate();
-        this.container &&
-            this.container.trigger(Events.CONTAINER_PLAYBACKDVRSTATECHANGED, this.container.isDvrInUse());
-        this.container && this.container.mediaControlDisabled && this.disable();
+        this.core.activeContainer &&
+            this.core.activeContainer.trigger(Events.CONTAINER_PLAYBACKDVRSTATECHANGED, this.core.activeContainer.isDvrInUse());
+        this.core.activeContainer && this.core.activeContainer.mediaControlDisabled && this.disable();
         this.trigger(Events.MEDIACONTROL_CONTAINERCHANGED);
-        if (this.container.$el) {
-            this.container.$el.addClass('container-skin-1');
+        if (this.core.activeContainer.$el) {
+            this.core.activeContainer.$el.addClass('container-skin-1');
         }
         if (this.options.cropVideo) {
-            this.container.$el.addClass('crop-video');
+            this.core.activeContainer.$el.addClass('crop-video');
         }
-        const spinnerPlugin = this.container.getPlugin('spinner');
+        // TODO handle by the spinner itself
+        const spinnerPlugin = this.core.activeContainer.getPlugin('spinner');
         spinnerPlugin?.$el.find('div').addClass('gcore-skin-main-color');
+        // TODO handle by the seek_time itself
         const seekTimePlugin = this.container.getPlugin('seek_time');
         seekTimePlugin?.$el.addClass('gcore-skin-bg-color');
         seekTimePlugin?.$el.find('span').addClass('gcore-skin-text-color');
@@ -708,12 +705,11 @@ export class MediaControl extends UICorePlugin {
         }
     }
     settingsUpdate() {
-        const newSettings = this.getSettings();
-        $.extend(true, newSettings, {
+        const newSettings = $.extend(true, {
             left: [],
             default: [],
             right: [],
-        });
+        }, this.core.activeContainer?.settings);
         newSettings.left = orderByOrderPattern([...newSettings.left, 'clipsText', 'volume'], LEFT_ORDER);
         newSettings.right = [
             'fullscreen',
@@ -744,10 +740,6 @@ export class MediaControl extends UICorePlugin {
             this.render();
         }
     }
-    getSettings() {
-        // TODO show live and remove duration/position if live
-        return $.extend(true, {}, this.container && this.container.settings);
-    }
     highDefinitionUpdate(isHD) {
         this.isHD = isHD;
     }
@@ -811,8 +803,17 @@ export class MediaControl extends UICorePlugin {
                 return this.$playbackRate;
             case 'seekBarContainer':
                 return this.$seekBarContainer;
+            case 'subtitlesSelector':
+                return this.$subtitlesSelector;
         }
     }
+    /**
+     * Get the right panel area to append custom elements to
+     * @returns  ZeptoSelector of the right panel element
+     */
+    getRightPanel() {
+        return this.$el.find('.media-control-right-panel');
+    }
     resetIndicators() {
         assert.ok(this.$duration && this.$position, 'duration and position elements must be present');
         this.displayedPosition = this.$position.text();
@@ -971,7 +972,7 @@ export class MediaControl extends UICorePlugin {
         this.$playPauseToggle?.addClass('paused');
         this.$playStopToggle?.addClass('stopped');
         this.changeTogglePlay();
-        if (this.container) {
+        if (this.core.activeContainer) {
             this.hideId = setTimeout(() => this.hide(), timeout);
             this.disabled && this.hide();
         }

package/lib/plugins/picture-in-picture/PictureInPicture.d.ts

@@ -1,20 +1,48 @@
 import { UICorePlugin } from '@clappr/core';
 import '../../../assets/picture-in-picture/button.scss';
+/**
+ * Enables picture in picture mode.
+ * @beta
+ * @remarks
+ * Depends on:
+ *
+ * - {@link MediaControl}
+ *
+ * It renders a button to toggle picture in picture mode in the media control UI.
+ */
 export declare class PictureInPicture extends UICorePlugin {
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
+    /**
+     * @internal
+     */
     static get version(): string;
+    /**
+     * @internal
+     */
     get events(): {
         'click button': string;
     };
-    get videoElement(): any;
+    private get videoElement();
+    /**
+     * @internal
+     */
     bindEvents(): void;
     private isPiPSupported;
+    /**
+     * @internal
+     */
     render(): this;
-    togglePictureInPicture(): void;
-    requestPictureInPicture(): void;
-    exitPictureInPicture(): void;
+    private togglePictureInPicture;
+    private requestPictureInPicture;
+    private exitPictureInPicture;
 }
 //# sourceMappingURL=PictureInPicture.d.ts.map

package/lib/plugins/picture-in-picture/PictureInPicture.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PictureInPicture.d.ts","sourceRoot":"","sources":["../../../src/plugins/picture-in-picture/PictureInPicture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoB,MAAM,cAAc,CAAC;AAO9D,OAAO,gDAAgD,CAAC;AAMxD,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,MAAM,KAAK,OAAO,WAEjB;IAED,IAAa,MAAM;;MAIlB;IAED,IAAI,YAAY,QAEf;IAEQ,UAAU;IAInB,OAAO,CAAC,cAAc;IASb,MAAM;IAiBf,sBAAsB;IAStB,uBAAuB;IAOvB,oBAAoB;CAIrB"}
+{"version":3,"file":"PictureInPicture.d.ts","sourceRoot":"","sources":["../../../src/plugins/picture-in-picture/PictureInPicture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoB,MAAM,cAAc,CAAC;AAO9D,OAAO,gDAAgD,CAAC;AAMxD;;;;;;;;;GASG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;IAED;;OAEG;IACH,IAAa,MAAM;;MAIlB;IAED,OAAO,KAAK,YAAY,GAEvB;IAED;;OAEG;IACM,UAAU;IAInB,OAAO,CAAC,cAAc;IAStB;;OAEG;IACM,MAAM;IAiBf,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,oBAAoB;CAI7B"}

package/lib/plugins/picture-in-picture/PictureInPicture.js

@@ -5,17 +5,39 @@ import pipIcon from '../../../assets/icons/new/pip.svg';
 import buttonHtml from '../../../assets/picture-in-picture/button.ejs';
 import '../../../assets/picture-in-picture/button.scss';
 const VERSION = '0.0.1';
-const T = `plugins.media_control_pip`;
+const T = `plugins.pip`;
+/**
+ * Enables picture in picture mode.
+ * @beta
+ * @remarks
+ * Depends on:
+ *
+ * - {@link MediaControl}
+ *
+ * It renders a button to toggle picture in picture mode in the media control UI.
+ */
 export class PictureInPicture extends UICorePlugin {
+    /**
+     * @internal
+     */
     get name() {
-        return 'media_control_pip';
+        return 'pip';
     }
+    /**
+     * @internal
+     */
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
+    /**
+     * @internal
+     */
     static get version() {
         return VERSION;
     }
+    /**
+     * @internal
+     */
     get events() {
         return {
             'click button': 'togglePictureInPicture',
@@ -24,6 +46,9 @@ export class PictureInPicture extends UICorePlugin {
     get videoElement() {
         return this.core.activePlayback.el;
     }
+    /**
+     * @internal
+     */
     bindEvents() {
         this.listenTo(this.core.mediaControl, Events.MEDIACONTROL_RENDERED, this.render);
     }
@@ -34,6 +59,9 @@ export class PictureInPicture extends UICorePlugin {
         });
         return document.pictureInPictureEnabled && !!HTMLVideoElement.prototype.requestPictureInPicture;
     }
+    /**
+     * @internal
+     */
     render() {
         if (!this.isPiPSupported()) {
             return this;

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/source-controller/SourceController.d.ts

@@ -22,7 +22,13 @@ export declare class SourceController extends CorePlugin {
     private sourcesDelay;
     private active;
     private sync;
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
@@ -36,6 +42,9 @@ export declare class SourceController extends CorePlugin {
     private reset;
     private retryPlayback;
     private getNextMediaSource;
+    /**
+     * @internal
+     */
     static get version(): string;
 }
 //# sourceMappingURL=SourceController.d.ts.map

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;AA4BrB;;;;;;;;;;;;;;;;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,IAAI,CAAiB;IAE7B,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;gBAEW,IAAI,EAAE,UAAU;IAW5B;;OAEG;IACM,UAAU;IAMnB,OAAO,CAAC,OAAO;IAoBf,OAAO,CAAC,2BAA2B;IAsCnC,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,aAAa;IA0BrB,OAAO,CAAC,kBAAkB;IAe1B,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;AA6BrB;;;;;;;;;;;;;;;;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,IAAI,CAAiB;IAE7B;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;gBAEW,IAAI,EAAE,UAAU;IAW5B;;OAEG;IACM,UAAU;IAMnB,OAAO,CAAC,OAAO;IAoBf,OAAO,CAAC,2BAA2B;IAsCnC,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,aAAa;IA0BrB,OAAO,CAAC,kBAAkB;IAe1B;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;CACF"}

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

@@ -1,6 +1,7 @@
 import { Events as ClapprEvents, CorePlugin, } from '@clappr/core';
 import { PlaybackErrorCode, } from '../../playback.types.js';
 import { trace } from '@gcorevideo/utils';
+import { SpinnerEvents } from '../spinner-three-bounce/SpinnerThreeBounce.js';
 import { CLAPPR_VERSION } from '../../build.js';
 const T = 'plugins.source_controller';
 const INITIAL_RETRY_DELAY = 1000;
@@ -71,9 +72,15 @@ export class SourceController extends CorePlugin {
     sourcesDelay = {};
     active = false;
     sync = noSync;
+    /**
+     * @internal
+     */
     get name() {
         return 'source_controller';
     }
+    /**
+     * @internal
+     */
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
@@ -103,7 +110,7 @@ export class SourceController extends CorePlugin {
         const spinner = this.core.activeContainer?.getPlugin('spinner');
         if (spinner) {
             this.sync = (cb) => {
-                spinner.once('spinner:sync', cb);
+                spinner.once(SpinnerEvents.SYNC, cb);
             };
         }
         else {
@@ -188,6 +195,9 @@ export class SourceController extends CorePlugin {
             setTimeout(() => resolve(s), delay);
         });
     }
+    /**
+     * @internal
+     */
     static get version() {
         return VERSION;
     }

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

@@ -1,10 +1,35 @@
 import { Container, UIContainerPlugin } from '@clappr/core';
 import '../../../assets/spinner-three-bounce/spinner.scss';
+/**
+ * Custom events emitted by the plugin
+ */
+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
+     */
+    SYNC = "plugins:spinner:sync"
+}
+/**
+ * Shows a pending operation indicator when playback is buffering or in other appropriate cases
+ * @beta
+ * @remarks
+ * The plugin emits
+ */
 export declare class SpinnerThreeBounce extends UIContainerPlugin {
+    /**
+     * @internal
+     */
     get name(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): {
         min: string;
     };
+    /**
+     * @internal
+     */
     get attributes(): {
         'data-spinner': string;
         class: string;
@@ -19,8 +44,17 @@ export declare class SpinnerThreeBounce extends UIContainerPlugin {
     private onPlay;
     private onStop;
     private onError;
-    show(immediate?: boolean): void;
+    /**
+     * Shows the spinner
+     */
+    show(): void;
+    /**
+     * Hides the spinner
+     */
     hide(): void;
+    /**
+     * @internal
+     */
     render(): this;
 }
 //# sourceMappingURL=SpinnerThreeBounce.d.ts.map

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,EAAE,SAAS,EAAU,iBAAiB,EAAY,MAAM,cAAc,CAAC;AAK9E,OAAO,mDAAmD,CAAC;AAM3D,qBAAa,kBAAmB,SAAQ,iBAAiB;IACvD,IAAI,IAAI,WAEP;IAED,IAAI,gBAAgB;;MAEnB;IAED,IAAa,UAAU;;;MAKtB;IAED,OAAO,CAAC,WAAW,CAAwB;IAE3C,OAAO,CAAC,QAAQ,CAAyB;IAEzC,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,YAAY,CAAQ;gBAEhB,SAAS,EAAE,SAAS;IAWhC,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,MAAM;IAKd,OAAO,CAAC,MAAM;IAUd,OAAO,CAAC,OAAO;IAef,IAAI,CAAC,SAAS,UAAQ;IAetB,IAAI;IAQK,MAAM;CAmBhB"}
+{"version":3,"file":"SpinnerThreeBounce.d.ts","sourceRoot":"","sources":["../../../src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAA0B,iBAAiB,EAAY,MAAM,cAAc,CAAC;AAK9F,OAAO,mDAAmD,CAAC;AAM3D;;GAEG;AACH,oBAAY,aAAa;IACvB;;;OAGG;IACH,IAAI,yBAAyB;CAC9B;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB;IACvD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,IAAa,UAAU;;;MAKtB;IAED,OAAO,CAAC,WAAW,CAAwB;IAE3C,OAAO,CAAC,QAAQ,CAAyB;IAEzC,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,YAAY,CAAQ;gBAEhB,SAAS,EAAE,SAAS;IAWhC,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,MAAM;IAKd,OAAO,CAAC,MAAM;IAUd,OAAO,CAAC,OAAO;IAef;;OAEG;IACH,IAAI;IAIJ;;OAEG;IACH,IAAI;IAQJ;;OAEG;IACM,MAAM;CAmBhB"}