@gcorevideo/player 2.19.15 → 2.20.3

package/docs/api/player.clipsplugin.gettext.md

@@ -4,6 +4,11 @@
 
 ## ClipsPlugin.getText() 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.
+> 
+
+Returns the text of the current clip.
+
 **Signature:**
 
 ```typescript
@@ -40,6 +45,8 @@ number
 
 </td><td>
 
+The current time of the player.
+
 
 </td></tr>
 </tbody></table>
@@ -47,3 +54,5 @@ number
 
 string
 
+The text of the current clip.
+

package/docs/api/player.clipsplugin.md

@@ -4,6 +4,11 @@
 
 ## ClipsPlugin 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.
+> 
+
+Adds a behavior of showing a text over the seekbar to indicate the current clip.
+
 **Signature:**
 
 ```typescript
@@ -11,68 +16,13 @@ export declare class ClipsPlugin extends UICorePlugin
 ```
 **Extends:** UICorePlugin
 
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[attributes](./player.clipsplugin.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ class: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.clipsplugin.name.md)
-
+## Remarks
 
-</td><td>
-
-`readonly`
-
-
-</td><td>
+Depends on:
 
-string
+- [MediaControl](./player.mediacontrol.md)
 
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
+Configuration options - [ClipsPluginSettings](./player.clipspluginsettings.md)
 
 ## Methods
 
@@ -94,18 +44,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[bindEvents()](./player.clipsplugin.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
 [getText(time)](./player.clipsplugin.gettext.md)
 
 
@@ -114,29 +52,7 @@ Description
 
 </td><td>
 
-
-</td></tr>
-<tr><td>
-
-[makeSvg(duration)](./player.clipsplugin.makesvg.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[unbindEvents()](./player.clipsplugin.unbindevents.md)
-
-
-</td><td>
-
-
-</td><td>
+**_(BETA)_** Returns the text of the current clip.
 
 
 </td></tr>

package/docs/api/{player.playbackrate.setselectedrate.md → player.clipspluginsettings.md}

@@ -1,20 +1,27 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlaybackRate](./player.playbackrate.md) &gt; [setSelectedRate](./player.playbackrate.setselectedrate.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClipsPluginSettings](./player.clipspluginsettings.md)
 
-## PlaybackRate.setSelectedRate() method
+## ClipsPluginSettings interface
+
+Configuration options
 
 **Signature:**
 
 ```typescript
-setSelectedRate(rate: string): void;
+export interface ClipsPluginSettings 
 ```
 
-## Parameters
+## Properties
 
 <table><thead><tr><th>
 
-Parameter
+Property
+
+
+</th><th>
+
+Modifiers
 
 
 </th><th>
@@ -30,7 +37,10 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-rate
+[text](./player.clipspluginsettings.text.md)
+
+
+</td><td>
 
 
 </td><td>
@@ -40,10 +50,8 @@ string
 
 </td><td>
 
+The text to display over the seekbar.
+
 
 </td></tr>
 </tbody></table>
-**Returns:**
-
-void
-

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClipsPluginSettings](./player.clipspluginsettings.md) &gt; [text](./player.clipspluginsettings.text.md)
+
+## ClipsPluginSettings.text property
+
+The text to display over the seekbar.
+
+**Signature:**
+
+```typescript
+text: string;
+```

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

@@ -4,12 +4,15 @@
 
 ## ContextMenu.(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 `ContextMenu` class
 
 **Signature:**
 
 ```typescript
-constructor(core: Core);
+constructor(container: Container);
 ```
 
 ## Parameters
@@ -32,12 +35,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-core
+container
 
 
 </td><td>
 
-Core
+Container
 
 
 </td><td>

package/docs/api/player.contextmenu.md

@@ -4,248 +4,27 @@
 
 ## ContextMenu 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.
+> 
+
+Displays a small context menu when clicked on the player container.
+
 **Signature:**
 
 ```typescript
-export declare class ContextMenu extends UICorePlugin 
+export declare class ContextMenu extends UIContainerPlugin 
 ```
-**Extends:** UICorePlugin
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(core)](./player.contextmenu._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `ContextMenu` class
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
+**Extends:** UIContainerPlugin
 
-</th></tr></thead>
-<tbody><tr><td>
-
-[attributes](./player.contextmenu.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ class: string; }
-
-
-</td><td>
+## Remarks
 
+Configuration options - [ContextMenuPluginSettings](./player.contextmenupluginsettings.md)
 
-</td></tr>
-<tr><td>
-
-[events](./player.contextmenu.events.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'click \[data-version\]': string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[exposeVersion](./player.contextmenu.exposeversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ label: string; name: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[label](./player.contextmenu.label.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[mediaControl](./player.contextmenu.mediacontrol.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.contextmenu.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.contextmenu.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[template](./player.contextmenu.template.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[url](./player.contextmenu.url.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
+## Constructors
 
 <table><thead><tr><th>
 
-Method
+Constructor
 
 
 </th><th>
@@ -261,19 +40,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[bindEvents()](./player.contextmenu.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[destroy()](./player.contextmenu.destroy.md)
+[(constructor)(container)](./player.contextmenu._constructor_.md)
 
 
 </td><td>
@@ -281,17 +48,7 @@ Description
 
 </td><td>
 
-
-</td></tr>
-<tr><td>
-
-[render()](./player.contextmenu.render.md)
-
-
-</td><td>
-
-
-</td><td>
+**_(BETA)_** Constructs a new instance of the `ContextMenu` class
 
 
 </td></tr>

package/docs/api/player.contextmenupluginsettings.label.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md) &gt; [label](./player.contextmenupluginsettings.label.md)
+
+## ContextMenuPluginSettings.label property
+
+**Signature:**
+
+```typescript
+label?: string;
+```

package/docs/api/player.contextmenupluginsettings.md

@@ -0,0 +1,93 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md)
+
+## ContextMenuPluginSettings interface
+
+**Signature:**
+
+```typescript
+export interface ContextMenuPluginSettings 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[label?](./player.contextmenupluginsettings.label.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[preventShowContextMenu?](./player.contextmenupluginsettings.preventshowcontextmenu.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[url?](./player.contextmenupluginsettings.url.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.contextmenupluginsettings.preventshowcontextmenu.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md) &gt; [preventShowContextMenu](./player.contextmenupluginsettings.preventshowcontextmenu.md)
+
+## ContextMenuPluginSettings.preventShowContextMenu property
+
+**Signature:**
+
+```typescript
+preventShowContextMenu?: boolean;
+```

package/docs/api/player.contextmenupluginsettings.url.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md) &gt; [url](./player.contextmenupluginsettings.url.md)
+
+## ContextMenuPluginSettings.url property
+
+**Signature:**
+
+```typescript
+url?: string;
+```

package/docs/api/player.dvrcontrols.md

@@ -18,7 +18,11 @@ export declare class DvrControls extends UICorePlugin
 
 ## Remarks
 
-The plugin is rendered in the [media control](./player.mediacontrol.md) UI. It renders the live stream indicator and the DVR seek bar if DVR is enabled.
+Depends on:
+
+- [MediaControl](./player.mediacontrol.md)
+
+The plugin renders the live stream indicator and the DVR seek bar, if DVR is enabled, in the media control UI.
 
 ## Constructors
 

package/docs/api/player.errorscreen.attributes.md

@@ -4,6 +4,9 @@
 
 ## ErrorScreen.attributes 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