@gcorevideo/player 2.19.12 → 2.19.14

package/docs/api/player.bottomgear.md

@@ -7,6 +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.
 > 
 
+Adds the gear button that triggers extra options menu on the right side of the [media control](./player.mediacontrol.md) UI
 
 **Signature:**
 
@@ -15,294 +16,7 @@ export declare class BottomGear extends UICorePlugin
 ```
 **Extends:** UICorePlugin
 
-## Properties
+## Remarks
 
-<table><thead><tr><th>
+The plugins provides a base for attaching custom settings UI in the gear menu
 
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[attributes](./player.bottomgear.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ class: string; 'data-track-selector': string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[container](./player.bottomgear.container.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[events](./player.bottomgear.events.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'click .button-gear': string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.bottomgear.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.bottomgear.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[template](./player.bottomgear.template.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[version](./player.bottomgear.version.md)
-
-
-</td><td>
-
-`static`
-
-`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.bottomgear.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[hide()](./player.bottomgear.hide.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[refresh()](./player.bottomgear.refresh.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[reload()](./player.bottomgear.reload.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[render()](./player.bottomgear.render.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[toggleGearMenu()](./player.bottomgear.togglegearmenu.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[unBindEvents()](./player.bottomgear.unbindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-</tbody></table>

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

@@ -4,6 +4,9 @@
 
 ## DvrControls.(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 `DvrControls` class
 
 **Signature:**

package/docs/api/player.dvrcontrols.md

@@ -4,6 +4,11 @@
 
 ## DvrControls 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 the DVR controls to the media control UI
+
 **Signature:**
 
 ```typescript
@@ -11,6 +16,10 @@ export declare class DvrControls extends UICorePlugin
 ```
 **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.
+
 ## Constructors
 
 <table><thead><tr><th>
@@ -39,207 +48,7 @@ Description
 
 </td><td>
 
-Constructs a new instance of the `DvrControls` 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>
-
-[attributes](./player.dvrcontrols.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ class: string; 'data-dvr-controls': string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[events](./player.dvrcontrols.events.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'click .live-button': string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.dvrcontrols.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.dvrcontrols.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[template](./player.dvrcontrols.template.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[bindEvents()](./player.dvrcontrols.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[click()](./player.dvrcontrols.click.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[render()](./player.dvrcontrols.render.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[settingsUpdate()](./player.dvrcontrols.settingsupdate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[shouldRender()](./player.dvrcontrols.shouldrender.md)
-
-
-</td><td>
-
-
-</td><td>
+**_(BETA)_** Constructs a new instance of the `DvrControls` class
 
 
 </td></tr>

package/docs/api/player.levelselector.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.
 > 
 
-Allows to control the quality level of the playback.
+A [media control](./player.mediacontrol.md) plugin that provides a UI to control the quality level of the playback.
 
 **Signature:**
 
@@ -18,22 +18,24 @@ export declare class LevelSelector extends UICorePlugin
 
 ## Remarks
 
-The plugin is rendered as a button in the gear menu. When clicked, it shows a list of quality levels to choose from.
+The plugin is rendered as a button in the [gear menu](./player.bottomgear.md)<!-- -->. When clicked, it shows a list of quality levels to choose from.
 
 Configuration options:
 
-- `labels`<!-- -->: The labels to show in the level selector. \[vertical resolution\]: string - `restrictResolution`<!-- -->: The maximum resolution to allow in the level selector.
+- `labels`<!-- -->: The labels to show in the level selector. \[video resolution\]: string
+
+- `restrictResolution`<!-- -->: The maximum resolution to allow in the level selector.
 
 ## Example
 
 
 ```ts
-{
+new Player({
   levelSelector: {
     restrictResolution: 360,
-    labels: { 360: '360p', 720: '720p' },
+    labels: { 360: 'SD', 720: 'HD' },
   },
-}
+})
 ```
 
 ## Properties
@@ -61,27 +63,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[attributes](./player.levelselector.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ class: string; 'data-level-selector': string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
 [events](./player.levelselector.events.md)
 
 
@@ -100,118 +81,5 @@ Description
 **_(BETA)_**
 
 
-</td></tr>
-<tr><td>
-
-[name](./player.levelselector.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.levelselector.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[version](./player.levelselector.version.md)
-
-
-</td><td>
-
-`static`
-
-`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.levelselector.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[render()](./player.levelselector.render.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 </tbody></table>