@gcorevideo/player 2.24.0 → 2.24.2

package/dist/index.js

@@ -43303,7 +43303,7 @@ class Player {
     }
 }
 
-var version$1 = "2.24.0";
+var version$1 = "2.24.2";
 
 var packages = {
 	"node_modules/@clappr/core": {
@@ -43896,6 +43896,15 @@ class MediaControl extends UICorePlugin {
         this.bindKeyEvents();
         this.show();
     }
+    /**
+     *
+     * @returns  Vertical space available to render something on top of the container.
+     * @remarks
+     * This takes into account the container height and excludes the height of the controls bar
+     */
+    getAvailableHeight() {
+        return (this.core.$el.height() - this.$el.find('.media-control-layer').height());
+    }
     /**
      * Set the initial volume, which is preserved when playback is interrupted by an advertisement
      */
@@ -43995,11 +44004,11 @@ class MediaControl extends UICorePlugin {
         this.applyButtonStyle(this.$playStopToggle);
     }
     mousemoveOnSeekBar(event) {
-        const offset = MediaControl.getPageX(event) -
-            (this.$seekBarContainer.offset().left ?? 0); // TODO check if the result can be negative
-        const hoverOffset = offset -
-            (this.$seekBarHover.width() ?? 0) / 2;
-        const pos = offset ? Math.min(1, Math.max(offset / this.$seekBarContainer.width(), 0)) : 0;
+        const offset = MediaControl.getPageX(event) - (this.$seekBarContainer.offset().left ?? 0); // TODO check if the result can be negative
+        const hoverOffset = offset - (this.$seekBarHover.width() ?? 0) / 2;
+        const pos = offset
+            ? Math.min(1, Math.max(offset / this.$seekBarContainer.width(), 0))
+            : 0;
         if (this.settings.seekEnabled) {
             // TODO test that it works when the element does not exist
             this.$seekBarHover.css({ left: hoverOffset });
@@ -45091,6 +45100,8 @@ const gearHdIcon = "<svg width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\
 
 const VERSION$6 = '2.19.12';
 const T$g = 'plugins.bottom_gear';
+const MENU_VMARGIN = 12;
+const MENU_BACKLINK_HEIGHT = 44;
 /**
  * Events triggered by the plugin
  * @beta
@@ -45102,7 +45113,6 @@ var GearEvents;
      */
     GearEvents["RENDERED"] = "rendered";
 })(GearEvents || (GearEvents = {}));
-// TODO disabled if no items added
 /**
  * `PLUGIN` that adds a button to extend the media controls UI with extra options.
  * @beta
@@ -45239,7 +45249,7 @@ class BottomGear extends UICorePlugin {
      * ```
      */
     addItem(name, $subMenu) {
-        const $existingItem = this.$el.find(`#gear-options li[data-${name}`);
+        const $existingItem = this.$el.find(`#gear-options li[data-${name}]`);
         if ($existingItem.length) {
             trace(`${T$g} addItem already exists`, { name });
             return $existingItem;
@@ -45254,20 +45264,17 @@ class BottomGear extends UICorePlugin {
                 .hide()
                 .appendTo(this.$el.find('#gear-options-wrapper'));
             $item.on('click', (e) => {
-                trace(`${T$g} addItem submenu clicked`, { name });
                 e.stopPropagation();
+                this.alignSubmenu($subMenu);
                 $subMenu.show();
                 this.$el.find('#gear-options').hide();
             });
         }
         this.numItems++;
-        if (this.numItems > 0) {
-            this.$el.show();
-        }
+        this.$el.show();
         return $item;
     }
     bindContainerEvents(container) {
-        trace(`${T$g} bindContainerEvents`);
         this.listenTo(container, Events$1.CONTAINER_HIGHDEFINITIONUPDATE, this.highDefinitionUpdate);
         this.listenTo(container, Events$1.CONTAINER_CLICK, () => {
             this.collapse();
@@ -45282,7 +45289,6 @@ class BottomGear extends UICorePlugin {
      * @internal
      */
     render() {
-        trace(`${T$g} render`);
         const mediaControl = this.core.getPlugin('media_control');
         if (!mediaControl) {
             return this; // TODO test
@@ -45323,11 +45329,11 @@ class BottomGear extends UICorePlugin {
         else {
             this.$el.find('#gear-options-wrapper').show();
         }
-        this.$el.find('#gear-button').attr('aria-expanded', (!this.collapsed).toString());
-        trace(`${T$g} toggleMenu`, { hidden: this.collapsed });
+        this.$el
+            .find('#gear-button')
+            .attr('aria-expanded', (!this.collapsed).toString());
     }
     collapse() {
-        trace(`${T$g} collapse`);
         this.collapsed = true;
         this.$el.find('#gear-options-wrapper').hide();
         this.$el.find('#gear-button').attr('aria-expanded', 'false');
@@ -45335,7 +45341,6 @@ class BottomGear extends UICorePlugin {
         this.collapseSubmenus();
     }
     onCoreReady() {
-        trace(`${T$g} onCoreReady`);
         const mediaControl = this.core.getPlugin('media_control');
         assert(mediaControl, 'media_control plugin is required');
         this.listenTo(mediaControl, Events$1.MEDIACONTROL_RENDERED, this.onMediaControlRendered);
@@ -45351,16 +45356,20 @@ class BottomGear extends UICorePlugin {
         this.bindContainerEvents(mediaControl.container);
     }
     onMediaControlRendered() {
-        trace(`${T$g} onMediaControlRendered`);
         this.mount();
     }
     mount() {
-        trace(`${T$g} mount`, {
-            numItems: this.numItems,
-        });
         const mediaControl = this.core.getPlugin('media_control');
         mediaControl.mount('gear', this.$el);
     }
+    alignSubmenu($subMenu) {
+        const availableHeight = this.core.getPlugin('media_control').getAvailableHeight() -
+            MENU_VMARGIN * 2;
+        $subMenu.css('max-height', `${availableHeight}px`);
+        $subMenu
+            .find('.gear-sub-menu')
+            .css('max-height', `${availableHeight - MENU_BACKLINK_HEIGHT}px`);
+    }
 }
 
 /**
@@ -45703,15 +45712,6 @@ class ClapprStats extends ContainerPlugin {
 function generateSessionId() {
     return window.crypto.randomUUID();
 }
-function generateContentId(sourceUrl) {
-    return window.crypto.subtle.digest('SHA-1', new TextEncoder().encode(sourceUrl))
-        .then(buffer => {
-        const hex = Array.from(new Uint8Array(buffer))
-            .map(b => b.toString(16).padStart(2, '0'))
-            .join('');
-        return hex;
-    });
-}
 
 const CMCD_KEYS = [
     'br',
@@ -45733,6 +45733,7 @@ const CMCD_KEYS = [
     'st',
     'v',
 ];
+// const T = 'plugins.cmcd'
 /**
  * A `PLUGIN` that configures CMCD for playback
  * @beta
@@ -45749,56 +45750,62 @@ class CmcdConfig extends CorePlugin {
     get name() {
         return 'cmcd';
     }
+    get version() {
+        return '0.1.0';
+    }
+    get supportedVersion() {
+        return CLAPPR_VERSION$1;
+    }
     constructor(core) {
         super(core);
         this.sid = this.options.cmcd?.sessionId ?? generateSessionId();
+        this.cid = this.options.cmcd?.contentId ?? this.generateContentId();
     }
     /**
      * @inheritdocs
      */
     bindEvents() {
-        this.listenTo(this.core, Events$1.CORE_ACTIVE_CONTAINER_CHANGED, () => this.updateSettings());
+        this.listenTo(this.core, Events$1.CORE_CONTAINERS_CREATED, () => this.updateSettings(this.core.containers[0]));
     }
-    async getIds() {
+    exportIds() {
         return {
             sid: this.sid,
-            cid: await this.ensureContentId(),
+            cid: this.cid,
         };
     }
-    updateSettings() {
-        switch (this.core.activeContainer.playback.name) {
+    async updateSettings(container) {
+        switch (container.playback.name) {
             case 'dash':
-                this.updateDashjsSettings();
+                $.extend(true, container.playback.options, {
+                    dash: {
+                        cmcd: {
+                            enabled: true,
+                            enabledKeys: CMCD_KEYS,
+                            sid: this.sid,
+                            cid: this.cid,
+                        },
+                    },
+                });
                 break;
             case 'hls':
-                this.updateHlsjsSettings();
+                $.extend(true, container.playback.options, {
+                    playback: {
+                        hlsjsConfig: {
+                            cmcd: {
+                                includeKeys: CMCD_KEYS,
+                                sessionId: this.sid,
+                                contentId: this.cid,
+                            },
+                        },
+                    },
+                });
                 break;
         }
     }
-    async updateDashjsSettings() {
-        const { cid, sid } = await this.getIds();
-        const options = this.core.activePlayback.options;
-        this.core.activePlayback.options = {
-            ...options,
-            dash: {
-                ...(options.dash ?? {}),
-                cmcd: {
-                    enabled: true,
-                    enabledKeys: CMCD_KEYS,
-                    sid,
-                    cid,
-                },
-            },
-        };
-    }
-    async updateHlsjsSettings() {
-        const { cid, sid } = await this.getIds();
-        const options = this.core.activePlayback.options;
-        this.core.activePlayback.options = {
-            ...options,
+    updateHlsjsSettings(options, { cid, sid }) {
+        $.extend(true, options, {
             playback: {
                 hlsjsConfig: {
-                    ...(options.playback?.hlsjsConfig ?? {}),
                     cmcd: {
                         includeKeys: CMCD_KEYS,
                         sessionId: sid,
@@ -45806,23 +45813,10 @@ class CmcdConfig extends CorePlugin {
                     },
                 },
             },
-        };
-    }
-    async ensureContentId() {
-        if (!this.cid) {
-            this.cid = await this.evalContentId();
-        }
-        return this.cid;
+        });
     }
-    async evalContentId() {
-        if (!this.core.activeContainer.options.cmcd?.contentId) {
-            return generateContentId(this.core.activePlayback.options.src);
-        }
-        const contentId = this.core.activeContainer.options.cmcd.contentId;
-        if (typeof contentId === 'string') {
-            return contentId;
-        }
-        return Promise.resolve(contentId(this.core.activePlayback.options.src));
+    generateContentId() {
+        return new URL(this.core.options.source ?? this.core.options.sources[0].source).pathname.slice(0, 64);
     }
 }
 

package/dist/player.d.ts

@@ -155,7 +155,7 @@ export declare class BigMuteButton extends UICorePlugin {
     private hideBigMuteBtn;
     private showBigMuteBtn;
     private destroyBigMuteBtn;
-    private handleBigMuteBtnClick;
+    private clicked;
 }
 
 /**
@@ -703,6 +703,51 @@ export declare type ClosedCaptionsPluginSettings = {
     language?: string;
 };
 
+/**
+ * A `PLUGIN` that configures CMCD for playback
+ * @beta
+ * @remarks
+ * Configuration options
+ *   `cmcd`: {@link CmcdConfigPluginSettings}
+ */
+export declare class CmcdConfig extends CorePlugin {
+    private sid;
+    private cid;
+    /**
+     * @inheritdocs
+     */
+    get name(): string;
+    get version(): string;
+    get supportedVersion(): string;
+    constructor(core: Core);
+    /**
+     * @inheritdocs
+     */
+    bindEvents(): void;
+    exportIds(): {
+        sid: string;
+        cid: string;
+    };
+    private updateSettings;
+    private updateHlsjsSettings;
+    private generateContentId;
+}
+
+/**
+ * @beta
+ */
+export declare type CmcdConfigPluginSettings = {
+    /**
+     * Session ID. If ommitted, a random UUID will be generated
+     */
+    sessionId: string;
+    /**
+     * Content ID,
+     * If ommitted, the pathname part of the first source URL will be used
+     */
+    contentId?: string;
+};
+
 /**
  * @public
  */

package/docs/api/player.cmcdconfig._constructor_.md

@@ -0,0 +1,50 @@
+<!-- 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; [(constructor)](./player.cmcdconfig._constructor_.md)
+
+## CmcdConfig.(constructor)
+
+> 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.
+> 
+
+Constructs a new instance of the `CmcdConfig` class
+
+**Signature:**
+
+```typescript
+constructor(core: Core);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+core
+
+
+</td><td>
+
+Core
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.cmcdconfig.bindevents.md

@@ -0,0 +1,19 @@
+<!-- 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)
+
+## CmcdConfig.bindEvents() method
+
+> 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.
+> 
+
+
+**Signature:**
+
+```typescript
+bindEvents(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.cmcdconfig.exportids.md

@@ -0,0 +1,21 @@
+<!-- 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; [exportIds](./player.cmcdconfig.exportids.md)
+
+## CmcdConfig.exportIds() method
+
+> 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.
+> 
+
+**Signature:**
+
+```typescript
+exportIds(): {
+        sid: string;
+        cid: string;
+    };
+```
+**Returns:**
+
+{ sid: string; cid: string; }
+

package/docs/api/player.cmcdconfig.md

@@ -0,0 +1,191 @@
+<!-- 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)
+
+## CmcdConfig class
+
+> 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.
+> 
+
+A `PLUGIN` that configures CMCD for playback
+
+**Signature:**
+
+```typescript
+export declare class CmcdConfig extends CorePlugin 
+```
+**Extends:** CorePlugin
+
+## Remarks
+
+Configuration options `cmcd`<!-- -->: [CmcdConfigPluginSettings](./player.cmcdconfigpluginsettings.md)
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(core)](./player.cmcdconfig._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Constructs a new instance of the `CmcdConfig` class
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[name](./player.cmcdconfig.name.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** 
+
+
+</td></tr>
+<tr><td>
+
+[supportedVersion](./player.cmcdconfig.supportedversion.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[version](./player.cmcdconfig.version.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[bindEvents()](./player.cmcdconfig.bindevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** 
+
+
+</td></tr>
+<tr><td>
+
+[exportIds()](./player.cmcdconfig.exportids.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.cmcdconfig.name.md

@@ -0,0 +1,15 @@
+<!-- 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; [name](./player.cmcdconfig.name.md)
+
+## CmcdConfig.name 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.
+> 
+
+
+**Signature:**
+
+```typescript
+get name(): string;
+```

package/docs/api/player.cmcdconfig.supportedversion.md

@@ -0,0 +1,14 @@
+<!-- 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; [supportedVersion](./player.cmcdconfig.supportedversion.md)
+
+## CmcdConfig.supportedVersion 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.
+> 
+
+**Signature:**
+
+```typescript
+get supportedVersion(): string;
+```

package/docs/api/player.cmcdconfig.version.md

@@ -0,0 +1,14 @@
+<!-- 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; [version](./player.cmcdconfig.version.md)
+
+## CmcdConfig.version 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.
+> 
+
+**Signature:**
+
+```typescript
+get version(): string;
+```

package/docs/api/player.cmcdconfigpluginsettings.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [CmcdConfigPluginSettings](./player.cmcdconfigpluginsettings.md)
+
+## CmcdConfigPluginSettings type
+
+> 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.
+> 
+
+
+**Signature:**
+
+```typescript
+export type CmcdConfigPluginSettings = {
+    sessionId: string;
+    contentId?: string;
+};
+```