@gcorevideo/player 2.24.2 → 2.24.3

package/docs/api/player.posterpluginsettings.md

@@ -2,15 +2,116 @@
 
 [Home](./index.md) > [@gcorevideo/player](./player.md) > [PosterPluginSettings](./player.posterpluginsettings.md)
 
-## PosterPluginSettings type
+## PosterPluginSettings interface
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Config options for the [Poster](./player.poster.md) plugin
 
 **Signature:**
 
 ```typescript
-export type PosterPluginSettings = {
-    custom?: string;
-    showForNoOp?: boolean;
-    url?: string;
-    showOnVideoEnd?: boolean;
-};
+export interface PosterPluginSettings 
 ```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[custom?](./player.posterpluginsettings.custom.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Custom CSS background
+
+
+</td></tr>
+<tr><td>
+
+[showForNoOp?](./player.posterpluginsettings.showfornoop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Whether to show the poster image when the playback is noop (i.e., when there is no appropriate video playback engine for current media sources set or the media sources are not set at all)
+
+
+</td></tr>
+<tr><td>
+
+[showOnVideoEnd?](./player.posterpluginsettings.showonvideoend.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Whether to show the poster after playback has ended, by default `true`
+
+
+</td></tr>
+<tr><td>
+
+[url?](./player.posterpluginsettings.url.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Poster image URL
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.posterpluginsettings.showfornoop.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PosterPluginSettings](./player.posterpluginsettings.md) &gt; [showForNoOp](./player.posterpluginsettings.showfornoop.md)
+
+## PosterPluginSettings.showForNoOp property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Whether to show the poster image when the playback is noop (i.e., when there is no appropriate video playback engine for current media sources set or the media sources are not set at all)
+
+**Signature:**
+
+```typescript
+showForNoOp?: boolean;
+```

package/docs/api/player.posterpluginsettings.showonvideoend.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PosterPluginSettings](./player.posterpluginsettings.md) &gt; [showOnVideoEnd](./player.posterpluginsettings.showonvideoend.md)
+
+## PosterPluginSettings.showOnVideoEnd property
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Whether to show the poster after playback has ended, by default `true`
+
+**Signature:**
+
+```typescript
+showOnVideoEnd?: boolean;
+```

package/docs/api/{player.cmcdconfig.bindevents.md → player.posterpluginsettings.url.md}

@@ -1,19 +1,16 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [CmcdConfig](./player.cmcdconfig.md) &gt; [bindEvents](./player.cmcdconfig.bindevents.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PosterPluginSettings](./player.posterpluginsettings.md) &gt; [url](./player.posterpluginsettings.url.md)
 
-## CmcdConfig.bindEvents() method
+## PosterPluginSettings.url property
 
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
+Poster image URL
 
 **Signature:**
 
 ```typescript
-bindEvents(): void;
+url?: string;
 ```
-**Returns:**
-
-void
-

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

@@ -1,15 +1,19 @@
 import { UICorePlugin } from '@clappr/core';
 import '../../../assets/big-mute-button/big-mute-button.scss';
 /**
- * `PLUGIN` that displays a big mute button over the video when it's muted.
- * Once pressed, it unmutes the video.
+ * `PLUGIN` that displays a big mute button over the video when it's being played muted.
  * @beta
+ * @remarks
+ * When pressed, it unmutes the video.
+ * @example
+ * ```ts
+ * import { BigMuteButton } from '@gcorevideo/player'
+ * Player.registerPlugin(BigMuteButton)
+ * ```
  */
 export declare class BigMuteButton extends UICorePlugin {
-    private isBigMuteButtonHidden;
+    private hidden;
     private _adIsPlaying;
-    private $bigMuteBtnContainer;
-    private $bigMuteButton;
     /**
      * @internal
      */
@@ -25,28 +29,26 @@ export declare class BigMuteButton extends UICorePlugin {
      * @internal
      */
     get events(): {
-        'click .big-mute-icon': string;
-        'click .big-mute-icon-wrapper': string;
+        click: string;
     };
     /**
      * @internal
      */
     bindEvents(): void;
     private onCoreReady;
+    private onContainerChanged;
+    private onPlay;
     private onContainerVolume;
-    private onContainerStart;
     private onPlaybackEnded;
-    private mediaControlRendered;
     private onStartAd;
     private onFinishAd;
-    private shouldRender;
     /**
      * @internal
      */
     render(): this;
-    private hideBigMuteBtn;
-    private showBigMuteBtn;
-    private destroyBigMuteBtn;
+    private mount;
+    private hide;
+    private show;
     private clicked;
 }
 //# sourceMappingURL=BigMuteButton.d.ts.map

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,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,OAAO;CAShB"}
+{"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;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,OAAO,CAAC,MAAM,CAAQ;IAGtB,OAAO,CAAC,YAAY,CAAQ;IAE5B;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAyB;IAEzD;;OAEG;IACH,IAAa,MAAM;;MAIlB;IAED;;OAEG;IACM,UAAU;IAOnB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,kBAAkB;IAuB1B,OAAO,CAAC,MAAM;IAgBd,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,UAAU;IAKlB;;OAEG;IACM,MAAM;IAWf,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,IAAI;IAKZ,OAAO,CAAC,IAAI;IAKZ,OAAO,CAAC,OAAO;CAkBhB"}

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

@@ -2,20 +2,25 @@ import { Events, template, UICorePlugin, Utils } from '@clappr/core';
 import { trace } from '@gcorevideo/utils';
 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 templateHtml from '../../../assets/big-mute-button/big-mute-button.ejs';
 import '../../../assets/big-mute-button/big-mute-button.scss';
 const T = 'plugins.big_mute_button';
 // TODO rewrite as a container plugin
 /**
- * `PLUGIN` that displays a big mute button over the video when it's muted.
- * Once pressed, it unmutes the video.
+ * `PLUGIN` that displays a big mute button over the video when it's being played muted.
  * @beta
+ * @remarks
+ * When pressed, it unmutes the video.
+ * @example
+ * ```ts
+ * import { BigMuteButton } from '@gcorevideo/player'
+ * Player.registerPlugin(BigMuteButton)
+ * ```
  */
 export class BigMuteButton extends UICorePlugin {
-    isBigMuteButtonHidden = false;
+    hidden = false;
+    // TODO get back to the ads-related logic later
     _adIsPlaying = false;
-    $bigMuteBtnContainer = null;
-    $bigMuteButton = null;
     /**
      * @internal
      */
@@ -28,14 +33,13 @@ export class BigMuteButton extends UICorePlugin {
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
-    static template = template(pluginHtml);
+    static template = template(templateHtml);
     /**
      * @internal
      */
     get events() {
         return {
-            'click .big-mute-icon': 'clicked',
-            'click .big-mute-icon-wrapper': 'destroyBigMuteBtn',
+            'click': 'clicked',
         };
     }
     /**
@@ -43,110 +47,91 @@ export class BigMuteButton extends UICorePlugin {
      */
     bindEvents() {
         this.listenTo(this.core, Events.CORE_READY, this.onCoreReady);
+        this.listenTo(this.core, Events.CORE_ACTIVE_CONTAINER_CHANGED, this.onContainerChanged);
         this.listenTo(this.core, 'core:advertisement:start', this.onStartAd);
         this.listenTo(this.core, 'core:advertisement:finish', this.onFinishAd);
-        trace(`${T} bindEvents`, {
-            mediacontrol: !!this.core.mediaControl,
-        });
-        // TOOD use core.getPlugin('media_control')
-        this.listenTo(this.core.mediaControl, Events.MEDIACONTROL_RENDERED, this.mediaControlRendered);
     }
     onCoreReady() {
+    }
+    onContainerChanged() {
         this.listenTo(this.core.activeContainer, Events.CONTAINER_VOLUME, this.onContainerVolume);
-        this.listenTo(this.core.activeContainer, Events.CONTAINER_READY, this.onContainerStart);
+        // this.listenTo(
+        //   this.core.activeContainer,
+        //   Events.CONTAINER_READY,
+        //   this.onContainerReady,
+        // )
         this.listenTo(this.core.activePlayback, Events.PLAYBACK_ENDED, this.onPlaybackEnded);
+        this.listenTo(this.core.activeContainer, Events.CONTAINER_PLAY, this.onPlay);
     }
-    onContainerVolume(value) {
-        if (value !== 0) {
-            this.destroyBigMuteBtn();
+    onPlay(_, { autoPlay }) {
+        const container = this.core.activeContainer;
+        const { volume } = container;
+        const { wasMuted } = this.options;
+        trace(`${T} onPlay`, {
+            autoPlay,
+            wasMuted,
+            volume,
+        });
+        if (autoPlay && !wasMuted && volume === 0) {
+            this.mount();
+        }
+        else {
+            this.destroy();
         }
     }
-    onContainerStart() {
-        if (this.isBigMuteButtonHidden) {
-            this.showBigMuteBtn();
+    onContainerVolume(value) {
+        if (value !== 0) {
+            this.destroy();
         }
     }
     onPlaybackEnded() {
-        this.hideBigMuteBtn();
-    }
-    mediaControlRendered() {
-        const container = this.core.activeContainer;
-        trace(`${T} mediaControlRendered`, {
-            container: !!container,
-        });
-        if (container) {
-            this.listenTo(container.playback, Events.PLAYBACK_PLAY, () => {
-                trace(`${T} PLAYBACK_PLAY`);
-                this.render();
-            });
-        }
+        this.hide();
     }
     onStartAd() {
         this._adIsPlaying = true;
-        if (this.$bigMuteBtnContainer) {
-            this.$bigMuteBtnContainer.addClass('hide');
-        }
+        this.hide();
     }
     onFinishAd() {
         this._adIsPlaying = false;
-        if (this.$bigMuteBtnContainer) {
-            this.$bigMuteBtnContainer.removeClass('hide');
-        }
-    }
-    shouldRender() {
-        const container = this.core.activeContainer;
-        if (!container) {
-            return false;
-        }
-        const { autoPlay, wasMuted } = this.options;
-        const volume = container.volume;
-        trace(`${T} shouldRender`, {
-            autoPlay,
-            wasMuted,
-            volume,
-        });
-        return autoPlay && !wasMuted && volume === 0;
+        this.show();
     }
     /**
      * @internal
      */
     render() {
-        if (this.shouldRender()) {
-            trace(`${T} render`, {
-                el: !!this.$el,
-            });
-            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');
-            this.$bigMuteButton.append(volumeMuteIcon);
-            const container = this.core.activeContainer;
-            container.$el.append(this.$el.get(0));
-        }
+        trace(`${T} render`);
+        this.$el.html(BigMuteButton.template());
+        this.$el.find('#gplayer-big-mute-icon').append(volumeMuteIcon);
+        // TODO
+        // this._adIsPlaying && this.hide()
         return this;
     }
-    hideBigMuteBtn() {
-        this.isBigMuteButtonHidden = true;
-        this.$bigMuteBtnContainer?.addClass('hide');
+    mount() {
+        this.core.activeContainer.$el.append(this.$el);
+        this.show();
     }
-    showBigMuteBtn() {
-        this.isBigMuteButtonHidden = false;
-        if (this.$bigMuteBtnContainer) {
-            this.$bigMuteBtnContainer.removeClass('hide');
-        }
+    hide() {
+        this.hidden = true;
+        this.$el.find('#gplayer-big-mute-button')?.addClass('hide');
     }
-    destroyBigMuteBtn(e) {
-        this.hideBigMuteBtn();
-        if (e && e.stopPropagation) {
-            e.stopPropagation();
-        }
-        this.destroy();
+    show() {
+        this.hidden = false;
+        this.$el.find('#gplayer-big-mute-button')?.removeClass('hide');
     }
     clicked(e) {
+        trace(`${T} clicked`);
+        const mediaControl = this.core.getPlugin('media_control');
+        // TODO delegate to media_control plugin
         const localVolume = Utils.Config.restore('volume');
         const volume = !isNaN(localVolume) ? localVolume : 100;
-        // TODO use container.setVolume() instead
-        this.core.mediaControl.setVolume(volume === 0 ? 100 : volume);
-        this.destroyBigMuteBtn(e);
+        const unmuted = volume === 0 ? 100 : volume;
+        if (mediaControl) {
+            mediaControl.setVolume(unmuted);
+        }
+        else {
+            this.core.activeContainer.setVolume(unmuted);
+        }
+        e.stopPropagation?.();
+        this.destroy();
     }
 }

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

@@ -1,13 +1,17 @@
 import { Container, ContainerPlugin } from '@clappr/core';
 import type { ClapprStatsMetrics } from './types.js';
 export * from './types.js';
-export type ClapprStatsSettings = {
+/**
+ * Config options for the {@link ClapprStats} plugin
+ * @beta
+ */
+export interface ClapprStatsSettings {
     /**
      * The interval in milliseconds of periodic measurements.
      * The plugin will emit a {@link ClapprStatsEvents.REPORT} event with the collected metrics at the specified interval.
      */
     runEach?: number;
-};
+}
 /**
  * `PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.
  * @beta

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,EAAwB,MAAM,cAAc,CAAA;AAU/E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAMpD,cAAc,YAAY,CAAA;AAM1B,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAC9C,OAAO,CAAC,OAAO,CAAuB;IAEtC,OAAO,CAAC,sBAAsB,CAAI;IAElC,OAAO,CAAC,OAAO,CAAmC;IAElD,OAAO,CAAC,MAAM,CAMb;IAED,OAAO,CAAC,OAAO,CAAQ;IAEvB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,CAAC,GAAG;IASX,OAAO,CAAC,GAAG;IAIX,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,IAAI;gBAIA,SAAS,EAAE,SAAS;IAKhC;;OAEG;IACM,UAAU;IAqDnB;;OAEG;IACM,OAAO;IAKhB;;;OAGG;IACH,aAAa;IAIb,YAAY;IAIZ,OAAO,CAAC,SAAS;IAkBjB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,OAAO;IAgBf,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,YAAY;IA8BpB,OAAO,CAAC,6BAA6B;IAOrC,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,YAAY;IASpB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,WAAW;IAcnB,OAAO,CAAC,QAAQ;IAgBhB,OAAO,CAAC,YAAY;IAuBpB,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,aAAa;CA0BtB"}
+{"version":3,"file":"ClapprStats.d.ts","sourceRoot":"","sources":["../../../src/plugins/clappr-stats/ClapprStats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAwB,MAAM,cAAc,CAAA;AAU/E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAMpD,cAAc,YAAY,CAAA;AAM1B;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAC9C,OAAO,CAAC,OAAO,CAAuB;IAEtC,OAAO,CAAC,sBAAsB,CAAI;IAElC,OAAO,CAAC,OAAO,CAAmC;IAElD,OAAO,CAAC,MAAM,CAMb;IAED,OAAO,CAAC,OAAO,CAAQ;IAEvB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,CAAC,GAAG;IASX,OAAO,CAAC,GAAG;IAIX,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,IAAI;gBAIA,SAAS,EAAE,SAAS;IAKhC;;OAEG;IACM,UAAU;IAqDnB;;OAEG;IACM,OAAO;IAKhB;;;OAGG;IACH,aAAa;IAIb,YAAY;IAIZ,OAAO,CAAC,SAAS;IAkBjB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,OAAO;IAgBf,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,YAAY;IA8BpB,OAAO,CAAC,6BAA6B;IAOrC,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,YAAY;IASpB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,WAAW;IAcnB,OAAO,CAAC,QAAQ;IAgBhB,OAAO,CAAC,YAAY;IAuBpB,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,aAAa;CA0BtB"}

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

@@ -7,7 +7,7 @@ import '../../../assets/clips/clips.scss';
  */
 export interface ClipsPluginSettings {
     /**
-     * The compiled text of the clips description, one clip per line in format  :
+     * The compiled text of the clips description, one clip per line in format:
      * `HH:MM:SS text` or `MM:SS text` or `SS text`
      */
     text: string;

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,EAAe,MAAM,cAAc,CAAA;AAI3E,OAAO,EAAgB,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAEjE,OAAO,kCAAkC,CAAA;AAOzC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAKD;;;;;;;;;;;GAWG;AACH,qBAAa,KAAM,SAAQ,YAAY;IACrC,OAAO,CAAC,QAAQ,CAAgC;IAEhD,OAAO,CAAC,KAAK,CAAiB;IAE9B,OAAO,CAAC,YAAY,CAAuB;IAE3C,OAAO,CAAC,OAAO,CAA2B;IAE1C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAsB;IAEtD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED,IAAI,OAAO,WAEV;IAED,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACM,UAAU;IAUV,MAAM;IAUN,OAAO;IAQP,OAAO;IAQP,MAAM;IAKf;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IAI5C,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,kBAAkB;IAsB1B,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,OAAO;IASf,OAAO,CAAC,UAAU;IAiBlB,OAAO,CAAC,WAAW;CAOpB"}
+{"version":3,"file":"Clips.d.ts","sourceRoot":"","sources":["../../../src/plugins/clips/Clips.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,YAAY,EAAe,MAAM,cAAc,CAAA;AAI3E,OAAO,EAAgB,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAEjE,OAAO,kCAAkC,CAAA;AAOzC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAKD;;;;;;;;;;;GAWG;AACH,qBAAa,KAAM,SAAQ,YAAY;IACrC,OAAO,CAAC,QAAQ,CAAgC;IAEhD,OAAO,CAAC,KAAK,CAAiB;IAE9B,OAAO,CAAC,YAAY,CAAuB;IAE3C,OAAO,CAAC,OAAO,CAA2B;IAE1C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAsB;IAEtD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED,IAAI,OAAO,WAEV;IAED,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACM,UAAU;IAUV,MAAM;IAUN,OAAO;IAQP,OAAO;IAQP,MAAM;IAKf;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IAK5C,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,kBAAkB;IAsB1B,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,OAAO;IASf,OAAO,CAAC,UAAU;IAiBlB,OAAO,CAAC,WAAW;CAOpB"}

package/lib/plugins/clips/Clips.js

@@ -86,7 +86,8 @@ export class Clips extends UICorePlugin {
      * @returns The text of the clip at the given time
      */
     getText(time) {
-        return this.clips.find((clip) => clip.start <= time && clip.end >= time)?.text;
+        return this.clips.find((clip) => clip.start <= time && clip.end >= time)
+            ?.text;
     }
     onCoreReady() {
         trace(`${T} onCoreReady`);

package/lib/plugins/cmcd-config/CmcdConfig.d.ts

@@ -1,45 +1,68 @@
 import { Core, CorePlugin } from '@clappr/core';
 /**
+ * Config options for the {@link CmcdConfig} plugin
  * @beta
  */
-export type CmcdConfigPluginSettings = {
+export interface CmcdConfigOptions {
     /**
-     * Session ID. If ommitted, a random UUID will be generated
+     * `sid` value. If ommitted, a random UUID will be generated
      */
-    sessionId: string;
+    sessionId?: string;
     /**
-     * Content ID,
+     * `cid` value.
      * If ommitted, the pathname part of the first source URL will be used
      */
     contentId?: string;
-};
+}
 /**
- * A `PLUGIN` that configures CMCD for playback
+ * A `PLUGIN` that configures {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf | CMCD} for playback
  * @beta
  * @remarks
- * Configuration options
- *   `cmcd`: {@link CmcdConfigPluginSettings}
+ * Configuration options - {@link CmcdConfigOptions}.
+ * @example
+ * ```ts
+ * import { CmcdConfig } from '@gcorevideo/player'
+ * Player.registerPlugin(CmcdConfig)
+ *
+ * const player = new Player({
+ *   source: 'https://example.com/video.mp4',
+ *   cmcd: {
+ *     sessionId: '1234567890',
+ *     contentId: 'f572d396fae9206628714fb2ce00f72e94f2258f',
+ *   },
+ * })
+ * ```
  */
 export declare class CmcdConfig extends CorePlugin {
     private sid;
     private cid;
     /**
-     * @inheritdocs
+     * @internal
      */
     get name(): string;
+    /**
+     * @internal
+     */
     get version(): string;
+    /**
+     * @internal
+     */
     get supportedVersion(): string;
     constructor(core: Core);
     /**
-     * @inheritdocs
+     * @internal
      */
     bindEvents(): void;
+    /**
+     * Returns the current `sid` and `cid` values.
+     * Useful when the auto-generated values need to be known.
+     * @returns `sid` and `cid` values
+     */
     exportIds(): {
         sid: string;
         cid: string;
     };
     private updateSettings;
-    private updateHlsjsSettings;
     private generateContentId;
 }
 //# sourceMappingURL=CmcdConfig.d.ts.map

package/lib/plugins/cmcd-config/CmcdConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CmcdConfig.d.ts","sourceRoot":"","sources":["../../../src/plugins/cmcd-config/CmcdConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,IAAI,EAAE,UAAU,EAAU,MAAM,cAAc,CAAA;AA6BrE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAID;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,OAAO,CAAC,GAAG,CAAQ;IAEnB,OAAO,CAAC,GAAG,CAAK;IAEhB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED,IAAI,OAAO,WAEV;IAED,IAAI,gBAAgB,WAEnB;gBAEW,IAAI,EAAE,IAAI;IAMtB;;OAEG;IACM,UAAU;IAMnB,SAAS,IAAI;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE;YAO3B,cAAc;IA8B5B,OAAO,CAAC,mBAAmB;IAiB3B,OAAO,CAAC,iBAAiB;CAK1B"}
+{"version":3,"file":"CmcdConfig.d.ts","sourceRoot":"","sources":["../../../src/plugins/cmcd-config/CmcdConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,IAAI,EAAE,UAAU,EAAU,MAAM,cAAc,CAAA;AA4BrE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAID;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,OAAO,CAAC,GAAG,CAAQ;IAEnB,OAAO,CAAC,GAAG,CAAK;IAEhB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,OAAO,WAEV;IAED;;OAEG;IACH,IAAI,gBAAgB,WAEnB;gBAEW,IAAI,EAAE,IAAI;IAMtB;;OAEG;IACM,UAAU;IAMnB;;;;OAIG;IACH,SAAS,IAAI;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE;YAO3B,cAAc;IA8B5B,OAAO,CAAC,iBAAiB;CAK1B"}