@gcorevideo/player 2.24.2 → 2.24.3

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>

package/docs/api/player.md

@@ -61,7 +61,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that displays a big mute button over the video when it's muted. Once pressed, it unmutes the video.
+**_(BETA)_** `PLUGIN` that displays a big mute button over the video when it's being played muted.
 
 
 </td></tr>
@@ -127,7 +127,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** A `PLUGIN` that configures CMCD for playback
+**_(BETA)_** A `PLUGIN` that configures [CMCD](https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf) for playback
 
 
 </td></tr>
@@ -428,6 +428,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Extended events for the [MediaControl](./player.mediacontrol.md) plugin
+
 
 </td></tr>
 <tr><td>
@@ -539,6 +541,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[ClapprStatsSettings](./player.clapprstatssettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Config options for the [ClapprStats](./player.clapprstats.md) plugin
+
+
+</td></tr>
+<tr><td>
+
 [ClipsPluginSettings](./player.clipspluginsettings.md)
 
 
@@ -547,6 +560,17 @@ Description
 **_(BETA)_** Configuration options for the [Clips](./player.clips.md) plugin.
 
 
+</td></tr>
+<tr><td>
+
+[CmcdConfigOptions](./player.cmcdconfigoptions.md)
+
+
+</td><td>
+
+**_(BETA)_** Config options for the [CmcdConfig](./player.cmcdconfig.md) plugin
+
+
 </td></tr>
 <tr><td>
 
@@ -613,6 +637,17 @@ Configuration options for the player
 Describes a media source with its MIME type and URL.
 
 
+</td></tr>
+<tr><td>
+
+[PosterPluginSettings](./player.posterpluginsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Config options for the [Poster](./player.poster.md) plugin
+
+
 </td></tr>
 <tr><td>
 
@@ -727,15 +762,6 @@ Description
 **_(BETA)_**
 
 
-</td></tr>
-<tr><td>
-
-[ClapprStatsSettings](./player.clapprstatssettings.md)
-
-
-</td><td>
-
-
 </td></tr>
 <tr><td>
 
@@ -747,17 +773,6 @@ Description
 **_(BETA)_** Configuration options for the [ClosedCaptions](./player.closedcaptions.md) plugin.
 
 
-</td></tr>
-<tr><td>
-
-[CmcdConfigPluginSettings](./player.cmcdconfigpluginsettings.md)
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 
@@ -1038,15 +1053,6 @@ A media source to fetch the media data from
 
 
 
-</td></tr>
-<tr><td>
-
-[PosterPluginSettings](./player.posterpluginsettings.md)
-
-
-</td><td>
-
-
 </td></tr>
 <tr><td>
 

package/docs/api/player.mediacontrol.getavailableheight.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [getAvailableHeight](./player.mediacontrol.getavailableheight.md)
+
+## MediaControl.getAvailableHeight() 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
+getAvailableHeight(): number;
+```
+**Returns:**
+
+number
+
+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
+

package/docs/api/player.mediacontrol.md

@@ -223,6 +223,20 @@ Description
 **_(BETA)_** Enable the user interaction disabled earlier
 
 
+</td></tr>
+<tr><td>
+
+[getAvailableHeight()](./player.mediacontrol.getavailableheight.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/{player.cmcdconfig.name.md → player.posterpluginsettings.custom.md}

@@ -1,15 +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; [name](./player.cmcdconfig.name.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PosterPluginSettings](./player.posterpluginsettings.md) &gt; [custom](./player.posterpluginsettings.custom.md)
 
-## CmcdConfig.name property
+## PosterPluginSettings.custom 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.
 > 
 
+Custom CSS background
 
 **Signature:**
 
 ```typescript
-get name(): string;
+custom?: string;
 ```