@gcorevideo/player 2.20.8 → 2.20.11

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

@@ -0,0 +1,20 @@
+<!-- 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; [refresh](./player.bottomgear.refresh.md)
+
+## BottomGear.refresh() 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.
+> 
+
+Re-renders the gear menu. It fires the [MEDIACONTROL\_GEAR\_RENDERED](./player.mediacontrolevents.md) event, which the plugins that attach to the gear menu can listen to to re-render themselves.
+
+**Signature:**
+
+```typescript
+refresh(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.clapprnerdstats.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.
 > 
 
-Displays useful network-related statistics.
+`PLUGIN` that displays useful network-related statistics.
 
 **Signature:**
 

package/docs/api/player.clapprstats.exportmetrics.md

@@ -18,5 +18,5 @@ exportMetrics(): Metrics;
 
 Metrics
 
-The collected metrics
+Currently collected metrics
 

package/docs/api/player.clapprstats.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.
 > 
 
-Collects useful statistics about playback performance.
+`PLUGIN` that collects useful statistics about playback performance.
 
 **Signature:**
 
@@ -85,20 +85,6 @@ Description
 **_(BETA)_** Returns the collected metrics.
 
 
-</td></tr>
-<tr><td>
-
-[onBitrate(newBitrate)](./player.clapprstats.onbitrate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 

package/docs/api/player.clapprstats.setupdatemetrics.md

@@ -45,6 +45,8 @@ MetricsUpdateFn
 
 </td><td>
 
+The callback to receive the metrics
+
 
 </td></tr>
 </tbody></table>

package/docs/api/player.clicktopause.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.
 > 
 
-Adds a behavior of toggling the playback state on click over the container
+`PLUGIN` that adds a behavior of toggling the playback state on click over the container
 
 **Signature:**
 

package/docs/api/player.clipsplugin.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.
 > 
 
-Adds a behavior of showing a text over the seekbar to indicate the current clip.
+`PLUGIN` that shows text over the seekbar to indicate the current clip.
 
 **Signature:**
 

package/docs/api/player.clipspluginsettings.md

@@ -4,7 +4,10 @@
 
 ## ClipsPluginSettings interface
 
-Configuration options
+> 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.
+> 
+
+Configuration options for the [clips](./player.clipsplugin.md) plugin.
 
 **Signature:**
 
@@ -50,7 +53,7 @@ string
 
 </td><td>
 
-The text to display over the seekbar.
+**_(BETA)_** The text to display over the seekbar.
 
 
 </td></tr>

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

@@ -4,6 +4,9 @@
 
 ## ClipsPluginSettings.text 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 text to display over the seekbar.
 
 **Signature:**

package/docs/api/player.containerpluginconstructor.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContainerPluginConstructor](./player.containerpluginconstructor.md)
+
+## ContainerPluginConstructor type
+
+
+**Signature:**
+
+```typescript
+export type ContainerPluginConstructor = {
+    new (container: Container): PlayerPlugin;
+    type: string;
+};
+```
+**References:** [PlayerPlugin](./player.playerplugin.md)
+

package/docs/api/player.containersize.md

@@ -4,9 +4,6 @@
 
 ## ContainerSize type
 
-> 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.
-> 
-
 Dimensions of the player container DOM element.
 
 **Signature:**

package/docs/api/player.contextmenu.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.
 > 
 
-Displays a small context menu when clicked on the player container.
+`PLUGIN` that displays a small context menu when clicked on the player container.
 
 **Signature:**
 

package/docs/api/player.corepluginconstructor.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [CorePluginConstructor](./player.corepluginconstructor.md)
+
+## CorePluginConstructor type
+
+
+**Signature:**
+
+```typescript
+export type CorePluginConstructor = {
+    new (core: Core): PlayerPlugin;
+    type: string;
+};
+```
+**References:** [PlayerPlugin](./player.playerplugin.md)
+

package/docs/api/player.dashsettings.md

@@ -4,9 +4,6 @@
 
 ## DashSettings type
 
-> 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 plain JS object that must conform to the DASH.js settings schema.
 
 [DASH.js settings](https://cdn.dashjs.org/latest/jsdoc/module-Settings.html)

package/docs/api/player.dvrcontrols.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.
 > 
 
-Adds the DVR controls to the media control UI
+`PLUGIN` that adds the DVR controls to the media control UI
 
 **Signature:**
 
@@ -22,38 +22,5 @@ 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.
+The plugin renders live stream indicator. If DVR is enabled, the indicator shows whether the current position is at the live edge of the stream or not. In the latter case, the indicator can be clicked to seek to the live edge.
 
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(core)](./player.dvrcontrols._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Constructs a new instance of the `DvrControls` class
-
-
-</td></tr>
-</tbody></table>

package/docs/api/player.errorlevel.md

@@ -4,9 +4,6 @@
 
 ## ErrorLevel type
 
-> 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.
-> 
-
 Levels of severity of errors. Non-fatal errors usually can be ignored.
 
 **Signature:**

package/docs/api/player.errorscreen.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.
 > 
 
-Displays a descriptive error in the overlay on top of the player.
+`PLUGIN` that displays errors nicely in the overlay on top of the player.
 
 **Signature:**
 
@@ -16,222 +16,3 @@ export declare class ErrorScreen 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.errorscreen.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ class: string; 'data-error-screen': string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[container](./player.errorscreen.container.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.errorscreen.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.errorscreen.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[template](./player.errorscreen.template.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</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.errorscreen.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[hide()](./player.errorscreen.hide.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[render()](./player.errorscreen.render.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[show(err)](./player.errorscreen.show.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[unBindEvents()](./player.errorscreen.unbindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-</tbody></table>

package/docs/api/{player.errorscreen.render.md → player.errorscreenpluginsettings.md}

@@ -1,18 +1,18 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ErrorScreen](./player.errorscreen.md) &gt; [render](./player.errorscreen.render.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ErrorScreenPluginSettings](./player.errorscreenpluginsettings.md)
 
-## ErrorScreen.render() method
+## ErrorScreenPluginSettings type
 
 > 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.
 > 
 
+Configuration options for the [error screen](./player.errorscreen.md) plugin.
+
 **Signature:**
 
 ```typescript
-render(): this;
+export type ErrorScreenPluginSettings = {
+    noReload?: boolean;
+};
 ```
-**Returns:**
-
-this
-

package/docs/api/player.favicon.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 plugin adds custom favicon to the player's tab.
+`PLUGIN` that adds custom favicon to the player's tab.
 
 **Signature:**
 

package/docs/api/player.googleanalytics.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.
 > 
 
-An example Google Analytics integration plugin
+`PLUGIN` that integrates with Google Analytics
 
 **Signature:**
 

package/docs/api/player.langtag.md

@@ -4,9 +4,6 @@
 
 ## LangTag type
 
-> 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.
-> 
-
 An ISO 639-1 language code.
 
 **Signature:**

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.
 > 
 
-A [media control](./player.mediacontrol.md) plugin that provides a UI to control the quality level of the playback.
+`PLUGIN` that provides a UI to select the desired quality level of the playback.
 
 **Signature:**
 
@@ -24,15 +24,9 @@ Depends on:
 
 - [BottomGear](./player.bottomgear.md)
 
-The plugin is rendered as an item in the gear menu.
+The plugin is rendered as an item in the gear menu, which, when clicked, shows a list of quality levels to choose from.
 
-When clicked, it shows a list of quality levels to choose from.
-
-Configuration options:
-
-- `labels`<!-- -->: The labels to show in the level selector. \[video resolution\]: string
-
-- `restrictResolution`<!-- -->: The maximum resolution to allow in the level selector.
+Configuration options - [LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md)
 
 ## Example
 

package/docs/api/{player.errorscreen.bindevents.md → player.levelselectorpluginsettings.labels.md}

@@ -1,18 +1,24 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ErrorScreen](./player.errorscreen.md) &gt; [bindEvents](./player.errorscreen.bindevents.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md) &gt; [labels](./player.levelselectorpluginsettings.labels.md)
 
-## ErrorScreen.bindEvents() method
+## LevelSelectorPluginSettings.labels 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 labels to show in the level selector.
+
 **Signature:**
 
 ```typescript
-bindEvents(): void;
+labels?: Record<number, string>;
 ```
-**Returns:**
 
-void
+## Example
+
+
+```ts
+{ 360: 'SD', 720: 'HD' }
+```
 

package/docs/api/player.levelselectorpluginsettings.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; [LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md)
+
+## LevelSelectorPluginSettings 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.
+> 
+
+Configuration options for the [level selector](./player.levelselector.md) plugin.
+
+**Signature:**
+
+```typescript
+export interface LevelSelectorPluginSettings 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[labels?](./player.levelselectorpluginsettings.labels.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Record&lt;number, string&gt;
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ The labels to show in the level selector.
+
+
+</td></tr>
+<tr><td>
+
+[restrictResolution?](./player.levelselectorpluginsettings.restrictresolution.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ The maximum resolution to allow in the level selector.
+
+
+</td></tr>
+</tbody></table>