@gcorevideo/player 2.20.9 → 2.20.12

package/docs/api/player.corepluginconstructor.md

@@ -4,15 +4,13 @@
 
 ## CorePluginConstructor 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.
-> 
-
 
 **Signature:**
 
 ```typescript
-export type CorePluginConstructor = ((core: unknown) => PlayerPlugin) & {
-    type: 'core';
+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.
 > 
 
-PLUGIN that displays errors nicely in the overlay on top of the player.
+`PLUGIN` that displays errors nicely in the overlay on top of the player.
 
 **Signature:**
 

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 changes the favicon according to the player's state.
 
 **Signature:**
 
@@ -16,179 +16,9 @@ export declare class Favicon extends CorePlugin
 ```
 **Extends:** CorePlugin
 
-## Constructors
+## Remarks
 
-<table><thead><tr><th>
+There are three states: stopped, playing and paused.
 
-Constructor
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Favicon` class.
 
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(core)](./player.favicon._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Constructs a new instance of the `Favicon` 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>
-
-[name](./player.favicon.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.favicon.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: 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.favicon.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[configure()](./player.favicon.configure.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[destroy()](./player.favicon.destroy.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[disable()](./player.favicon.disable.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-</tbody></table>

package/docs/api/{player.favicon.disable.md → player.faviconpluginsettings.faviconcolor.md}

@@ -1,18 +1,16 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Favicon](./player.favicon.md) &gt; [disable](./player.favicon.disable.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [FaviconPluginSettings](./player.faviconpluginsettings.md) &gt; [faviconColor](./player.faviconpluginsettings.faviconcolor.md)
 
-## Favicon.disable() method
+## FaviconPluginSettings.faviconColor 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.
 > 
 
+CSS color of the favicon.
+
 **Signature:**
 
 ```typescript
-disable(): void;
+faviconColor?: string;
 ```
-**Returns:**
-
-void
-

package/docs/api/{player.dvrcontrols._constructor_.md → player.faviconpluginsettings.md}

@@ -1,25 +1,29 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [DvrControls](./player.dvrcontrols.md) &gt; [(constructor)](./player.dvrcontrols._constructor_.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [FaviconPluginSettings](./player.faviconpluginsettings.md)
 
-## DvrControls.(constructor)
+## FaviconPluginSettings 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.
 > 
 
-Constructs a new instance of the `DvrControls` class
 
 **Signature:**
 
 ```typescript
-constructor(core: Core);
+export interface FaviconPluginSettings 
 ```
 
-## Parameters
+## Properties
 
 <table><thead><tr><th>
 
-Parameter
+Property
+
+
+</th><th>
+
+Modifiers
 
 
 </th><th>
@@ -35,16 +39,21 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-core
+[faviconColor?](./player.faviconpluginsettings.faviconcolor.md)
 
 
 </td><td>
 
-Core
+
+</td><td>
+
+string
 
 
 </td><td>
 
+**_(BETA)_** _(Optional)_ CSS color of the favicon.
+
 
 </td></tr>
 </tbody></table>

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.
 > 
 
-PLUGIN that provides a UI to select the desired quality level of the playback.
+`PLUGIN` that provides a UI to select the desired quality level of the playback.
 
 **Signature:**
 

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