@gcorevideo/player 2.19.15 → 2.20.3

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.clapprstats.exportmetrics.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 collected metrics.
+
 **Signature:**
 
 ```typescript
@@ -16,3 +18,5 @@ exportMetrics(): Metrics;
 
 Metrics
 
+The collected metrics
+

package/docs/api/player.clapprstats.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.
 > 
 
+Collects useful statistics about playback performance.
 
 **Signature:**
 
@@ -15,6 +16,10 @@ export declare class ClapprStats extends ContainerPlugin
 ```
 **Extends:** ContainerPlugin
 
+## Remarks
+
+This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.
+
 ## Constructors
 
 <table><thead><tr><th>
@@ -46,115 +51,6 @@ Description
 **_(BETA)_** Constructs a new instance of the `ClapprStats` 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>
-
-[\_playbackName](./player.clapprstats._playbackname.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[\_playbackType](./player.clapprstats._playbacktype.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.clapprstats.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.clapprstats.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 </tbody></table>
 
@@ -178,62 +74,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[\_buildReport()](./player.clapprstats._buildreport.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[\_defaultReport(metrics)](./player.clapprstats._defaultreport.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[bindEvents()](./player.clapprstats.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[destroy()](./player.clapprstats.destroy.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
 [exportMetrics()](./player.clapprstats.exportmetrics.md)
 
 
@@ -242,7 +82,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Returns the collected metrics.
 
 
 </td></tr>
@@ -259,34 +99,6 @@ Description
 **_(BETA)_**
 
 
-</td></tr>
-<tr><td>
-
-[onFirstPlaying()](./player.clapprstats.onfirstplaying.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[playAfterPause()](./player.clapprstats.playafterpause.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 
@@ -298,35 +110,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[startTimers()](./player.clapprstats.starttimers.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[stopReporting()](./player.clapprstats.stopreporting.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
+**_(BETA)_** Registers a callback to receive the metrics.
 
 
 </td></tr>

package/docs/api/player.clapprstats.setupdatemetrics.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.
 > 
 
+Registers a callback to receive the metrics.
+
 **Signature:**
 
 ```typescript

package/docs/api/player.clicktopause.md

@@ -4,6 +4,11 @@
 
 ## ClickToPause 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 toggling the playback state on click over the container
+
 **Signature:**
 
 ```typescript
@@ -11,116 +16,3 @@ export declare class ClickToPause extends ContainerPlugin
 ```
 **Extends:** ContainerPlugin
 
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[config](./player.clicktopause.config.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.clicktopause.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.clicktopause.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</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.clicktopause.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>