@gcorevideo/player 2.19.14 → 2.20.1

package/docs/api/player.bottomgear.getelement.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [BottomGear](./player.bottomgear.md) &gt; [getElement](./player.bottomgear.getelement.md)
+
+## BottomGear.getElement() 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
+getElement(name: GearItemElement): ZeptoResult | null;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+name
+
+
+</td><td>
+
+[GearItemElement](./player.gearitemelement.md)
+
+
+</td><td>
+
+Name of a gear menu placeholder item to attach custom UI
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[ZeptoResult](./player.zeptoresult.md) \| null
+
+Zepto result of the element
+

package/docs/api/player.bottomgear.md

@@ -20,3 +20,54 @@ export declare class BottomGear extends UICorePlugin
 
 The plugins provides a base for attaching custom settings UI in the gear menu
 
+Depends on:
+
+- [media\_control](./player.mediacontrol.md)
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getElement(name)](./player.bottomgear.getelement.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[setContent(content)](./player.bottomgear.setcontent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Replaces the content of the gear menu
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.bottomgear.setcontent.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [BottomGear](./player.bottomgear.md) &gt; [setContent](./player.bottomgear.setcontent.md)
+
+## BottomGear.setContent() 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.
+> 
+
+Replaces the content of the gear menu
+
+**Signature:**
+
+```typescript
+setContent(content: ZeptoResult): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+content
+
+
+</td><td>
+
+[ZeptoResult](./player.zeptoresult.md)
+
+
+</td><td>
+
+Zepto result of the element
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.clapprnerdstats.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.
 > 
 
+Displays useful network-related statistics.
 
 **Signature:**
 
@@ -15,259 +16,25 @@ export declare class ClapprNerdStats extends UICorePlugin
 ```
 **Extends:** UICorePlugin
 
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
+## Remarks
 
-Modifiers
+Depends on:
 
+- [MediaControl](./player.mediacontrol.md)
 
-</th><th>
+- [BottomGear](./player.bottomgear.md)
 
-Description
+- [ClapprStats](./player.clapprstats.md)
 
+The plugin is rendered as an item in the gear menu.
 
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(core)](./player.clapprnerdstats._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Constructs a new instance of the `ClapprNerdStats` 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.clapprnerdstats.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'data-clappr-nerd-stats': string; class: string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[events](./player.clapprnerdstats.events.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'click \[data-show-stats-button\]': string; 'click \[data-close-button\]': string; 'click \[data-refresh-button\]': string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.clapprnerdstats.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[playerHeight](./player.clapprnerdstats.playerheight.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
+When clicked, it shows an overlay window with the information about the network speed, latency, etc, and recommended quality level.
 
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[playerWidth](./player.clapprnerdstats.playerwidth.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[statsBoxElem](./player.clapprnerdstats.statsboxelem.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[statsBoxWidthThreshold](./player.clapprnerdstats.statsboxwidththreshold.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.clapprnerdstats.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[template](./player.clapprnerdstats.template.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
+## Constructors
 
 <table><thead><tr><th>
 
-Method
+Constructor
 
 
 </th><th>
@@ -283,21 +50,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[bindEvents()](./player.clapprnerdstats.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[render()](./player.clapprnerdstats.render.md)
+[(constructor)(core)](./player.clapprnerdstats._constructor_.md)
 
 
 </td><td>
@@ -305,7 +58,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Constructs a new instance of the `ClapprNerdStats` class
 
 
 </td></tr>

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:
+
+- [media\_control](./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

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

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

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

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

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

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

package/docs/api/player.errorscreen.md

@@ -4,6 +4,13 @@
 
 ## ErrorScreen 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 descriptive error in the overlay on top of the player.
+
+TODO
+
 **Signature:**
 
 ```typescript
@@ -51,6 +58,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -70,6 +79,8 @@ any
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -89,6 +100,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -108,6 +121,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -127,6 +142,8 @@ any
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>
@@ -159,6 +176,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -171,6 +190,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -183,6 +204,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -195,6 +218,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -207,6 +232,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>

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

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

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

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

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

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

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

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

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

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

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

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