@gcorevideo/player 2.24.1 → 2.24.3

package/dist/player.d.ts

@@ -109,9 +109,15 @@ export { AudioTracks as AudioSelector }
 export { AudioTracks }
 
 /**
- * `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;
@@ -144,14 +150,16 @@ export declare class BigMuteButton extends UICorePlugin {
     private onContainerVolume;
     private onContainerStart;
     private onPlaybackEnded;
-    private mediaControlRendered;
+    private onMediaControlRendered;
     private onStartAd;
     private onFinishAd;
-    private shouldRender;
+    private isActive;
     /**
      * @internal
      */
     render(): this;
+    private mount;
+    private update;
     private hideBigMuteBtn;
     private showBigMuteBtn;
     private destroyBigMuteBtn;
@@ -302,6 +310,7 @@ export declare class BottomGear extends UICorePlugin {
     private onCoreReady;
     private onMediaControlRendered;
     private mount;
+    private alignSubmenu;
 }
 
 /**
@@ -480,13 +489,17 @@ export declare type ClapprStatsMetrics = {
     };
 };
 
-export declare type ClapprStatsSettings = {
+/**
+ * Config options for the {@link ClapprStats} plugin
+ * @beta
+ */
+export declare 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;
-};
+}
 
 /**
  * A small `PLUGIN` that toggles the playback state on click over the video container
@@ -578,7 +591,7 @@ export declare class Clips extends UICorePlugin {
  */
 export declare 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;
@@ -704,49 +717,72 @@ export declare type ClosedCaptionsPluginSettings = {
 };
 
 /**
- * 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;
 }
 
 /**
+ * Config options for the {@link CmcdConfig} plugin
  * @beta
  */
-export declare type CmcdConfigPluginSettings = {
+export declare 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;
-};
+}
 
 /**
  * @public
@@ -986,6 +1022,10 @@ export declare type ErrorScreenSettings = {
     noReload?: boolean;
 };
 
+/**
+ * Extended events for the {@link MediaControl} plugin
+ * @beta
+ */
 export declare enum ExtendedEvents {
     MEDIACONTROL_VOLUME = "mediacontrol:volume",
     MEDIACONTROL_MENU_COLLAPSE = "mediacontrol:menu:collapse"
@@ -1287,6 +1327,13 @@ export declare class MediaControl extends UICorePlugin {
      * Reenables the plugin disabled earlier with the {@link MediaControl.disable} method
      */
     enable(): void;
+    /**
+     *
+     * @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(): number;
     /**
      * Set the initial volume, which is preserved when playback is interrupted by an advertisement
      */
@@ -2348,7 +2395,11 @@ export declare class Poster extends UIContainerPlugin {
     destroy(): this;
 }
 
-export declare type PosterPluginSettings = {
+/**
+ * Config options for the {@link Poster} plugin
+ * @beta
+ */
+export declare interface PosterPluginSettings {
     /**
      * Custom CSS background
      */
@@ -2362,10 +2413,10 @@ export declare type PosterPluginSettings = {
      */
     url?: string;
     /**
-     * Whether to show the poster after playback has ended @default true
+     * Whether to show the poster after playback has ended, by default `true`
      */
     showOnVideoEnd?: boolean;
-};
+}
 
 /**
  * A level of quality within a media source/representation.

package/docs/api/player.bigmutebutton.md

@@ -7,7 +7,7 @@
 > 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.
 > 
 
-`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.
 
 **Signature:**
 
@@ -16,3 +16,15 @@ export declare class BigMuteButton extends UICorePlugin
 ```
 **Extends:** UICorePlugin
 
+## Remarks
+
+When pressed, it unmutes the video.
+
+## Example
+
+
+```ts
+import { BigMuteButton } from '@gcorevideo/player'
+Player.registerPlugin(BigMuteButton)
+```
+

package/docs/api/player.clapprstatssettings.md

@@ -2,12 +2,59 @@
 
 [Home](./index.md) > [@gcorevideo/player](./player.md) > [ClapprStatsSettings](./player.clapprstatssettings.md)
 
-## ClapprStatsSettings type
+## ClapprStatsSettings 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 [ClapprStats](./player.clapprstats.md) plugin
 
 **Signature:**
 
 ```typescript
-export type ClapprStatsSettings = {
-    runEach?: number;
-};
+export interface ClapprStatsSettings 
 ```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[runEach?](./player.clapprstatssettings.runeach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ The interval in milliseconds of periodic measurements. The plugin will emit a [ClapprStatsEvents.REPORT](./player.clapprstatsevents.md) event with the collected metrics at the specified interval.
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.clapprstatssettings.runeach.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; [ClapprStatsSettings](./player.clapprstatssettings.md) &gt; [runEach](./player.clapprstatssettings.runeach.md)
+
+## ClapprStatsSettings.runEach 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.
+> 
+
+The interval in milliseconds of periodic measurements. The plugin will emit a [ClapprStatsEvents.REPORT](./player.clapprstatsevents.md) event with the collected metrics at the specified interval.
+
+**Signature:**
+
+```typescript
+runEach?: number;
+```

package/docs/api/player.clipspluginsettings.md

@@ -53,7 +53,7 @@ string
 
 </td><td>
 
-**_(BETA)_** The compiled text of the clips description, one clip per line in format : `HH:MM:SS text` or `MM:SS text` or `SS text`
+**_(BETA)_** The compiled text of the clips description, one clip per line in format: `HH:MM:SS text` or `MM:SS text` or `SS text`
 
 
 </td></tr>

package/docs/api/player.clipspluginsettings.text.md

@@ -7,7 +7,7 @@
 > 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.
 > 
 
-The compiled text of the clips description, one clip per line in format : `HH:MM:SS text` or `MM:SS text` or `SS text`
+The compiled text of the clips description, one clip per line in format: `HH:MM:SS text` or `MM:SS text` or `SS text`
 
 **Signature:**
 

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

@@ -7,6 +7,8 @@
 > 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.
 > 
 
+Returns the current `sid` and `cid` values. Useful when the auto-generated values need to be known.
+
 **Signature:**
 
 ```typescript
@@ -19,3 +21,5 @@ exportIds(): {
 
 { sid: string; cid: string; }
 
+`sid` and `cid` values
+

package/docs/api/player.cmcdconfig.md

@@ -7,7 +7,7 @@
 > 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
+A `PLUGIN` that configures [CMCD](https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf) for playback
 
 **Signature:**
 
@@ -18,47 +18,29 @@ export declare class CmcdConfig 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)
+Configuration options - [CmcdConfigOptions](./player.cmcdconfigoptions.md)<!-- -->.
 
+## Example
 
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Constructs a new instance of the `CmcdConfig` class
 
+```ts
+import { CmcdConfig } from '@gcorevideo/player'
+Player.registerPlugin(CmcdConfig)
 
-</td></tr>
-</tbody></table>
+const player = new Player({
+  source: 'https://example.com/video.mp4',
+  cmcd: {
+    sessionId: '1234567890',
+    contentId: 'f572d396fae9206628714fb2ce00f72e94f2258f',
+  },
+})
+```
 
-## Properties
+## Constructors
 
 <table><thead><tr><th>
 
-Property
+Constructor
 
 
 </th><th>
@@ -66,11 +48,6 @@ Property
 Modifiers
 
 
-</th><th>
-
-Type
-
-
 </th><th>
 
 Description
@@ -79,64 +56,15 @@ 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`
+[(constructor)(core)](./player.cmcdconfig._constructor_.md)
 
 
 </td><td>
 
-string
-
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Constructs a new instance of the `CmcdConfig` class
 
 
 </td></tr>
@@ -162,20 +90,6 @@ 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)
 
 
@@ -184,7 +98,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Returns the current `sid` and `cid` values. Useful when the auto-generated values need to be known.
 
 
 </td></tr>

package/docs/api/{player.cmcdconfig.version.md → player.cmcdconfigoptions.contentid.md}

@@ -1,14 +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; [version](./player.cmcdconfig.version.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [CmcdConfigOptions](./player.cmcdconfigoptions.md) &gt; [contentId](./player.cmcdconfigoptions.contentid.md)
 
-## CmcdConfig.version property
+## CmcdConfigOptions.contentId 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.
 > 
 
+`cid` value. If ommitted, the pathname part of the first source URL will be used
+
 **Signature:**
 
 ```typescript
-get version(): string;
+contentId?: string;
 ```

package/docs/api/player.cmcdconfigoptions.md

@@ -0,0 +1,79 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [CmcdConfigOptions](./player.cmcdconfigoptions.md)
+
+## CmcdConfigOptions 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 [CmcdConfig](./player.cmcdconfig.md) plugin
+
+**Signature:**
+
+```typescript
+export interface CmcdConfigOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[contentId?](./player.cmcdconfigoptions.contentid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ `cid` value. If ommitted, the pathname part of the first source URL will be used
+
+
+</td></tr>
+<tr><td>
+
+[sessionId?](./player.cmcdconfigoptions.sessionid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ `sid` value. If ommitted, a random UUID will be generated
+
+
+</td></tr>
+</tbody></table>

package/docs/api/{player.cmcdconfigpluginsettings.md → player.cmcdconfigoptions.sessionid.md}

@@ -1,18 +1,16 @@
 <!-- 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)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [CmcdConfigOptions](./player.cmcdconfigoptions.md) &gt; [sessionId](./player.cmcdconfigoptions.sessionid.md)
 
-## CmcdConfigPluginSettings type
+## CmcdConfigOptions.sessionId 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.
 > 
 
+`sid` value. If ommitted, a random UUID will be generated
 
 **Signature:**
 
 ```typescript
-export type CmcdConfigPluginSettings = {
-    sessionId: string;
-    contentId?: string;
-};
+sessionId?: string;
 ```

package/docs/api/player.extendedevents.md

@@ -4,6 +4,11 @@
 
 ## ExtendedEvents enum
 
+> 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.
+> 
+
+Extended events for the [MediaControl](./player.mediacontrol.md) plugin
+
 **Signature:**
 
 ```typescript
@@ -40,6 +45,8 @@ MEDIACONTROL\_MENU\_COLLAPSE
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -54,6 +61,8 @@ MEDIACONTROL\_VOLUME
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>