@gcorevideo/player 2.20.7 → 2.20.9

package/docs/api/player.md

@@ -63,7 +63,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Displays useful network-related statistics.
+**_(BETA)_** PLUGIN that displays useful network-related statistics.
 
 
 </td></tr>
@@ -74,7 +74,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Collects useful statistics about playback performance.
+**_(BETA)_** PLIGIN that collects useful statistics about playback performance.
 
 
 </td></tr>
@@ -96,7 +96,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Adds a behavior of showing a text over the seekbar to indicate the current clip.
+**_(BETA)_** PLUGIN that shows text over the seekbar to indicate the current clip.
 
 
 </td></tr>
@@ -129,7 +129,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Displays a descriptive error in the overlay on top of the player.
+**_(BETA)_** PLUGIN that displays errors nicely in the overlay on top of the player.
 
 
 </td></tr>
@@ -162,7 +162,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** A [media control](./player.mediacontrol.md) plugin that provides a UI to control the quality level of the playback.
+**_(BETA)_** PLUGIN that provides a UI to select the desired quality level of the playback.
 
 
 </td></tr>
@@ -184,7 +184,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** The MediaControl provides a foundation for developing custom media controls UI.
+**_(BETA)_** PLUGIN that provides a foundation for developing custom media controls UI.
 
 
 </td></tr>
@@ -195,7 +195,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** The plugin adds support for loading multiple streams and switching between them using the media control UI.
+**_(BETA)_** PLUGIN that adds support for loading multiple streams and switching between them using the media control UI.
 
 
 </td></tr>
@@ -217,7 +217,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Allows changing the playback speed of the video.
+**_(BETA)_** PLUGIN that allows changing the playback speed of the video.
 
 
 </td></tr>
@@ -261,7 +261,7 @@ Description
 
 </td><td>
 
-The plugin adds a share button to the media control UI.
+**_(BETA)_** PLUGIN that adds a share button to the media control UI.
 
 
 </td></tr>
@@ -272,7 +272,7 @@ The plugin adds a share button to the media control UI.
 
 </td><td>
 
-The plugin adds skip controls to the media control UI.
+**_(BETA)_** PLUGIN that adds skip controls to the media control UI.
 
 
 </td></tr>
@@ -294,7 +294,7 @@ The plugin adds skip controls to the media control UI.
 
 </td><td>
 
-**_(BETA)_** Shows a pending operation indicator when playback is buffering or in other appropriate cases
+**_(BETA)_** PLUGIN that shows a pending operation indicator when playback is buffering or in a similar state
 
 
 </td></tr>
@@ -316,7 +316,7 @@ The plugin adds skip controls to the media control UI.
 
 </td><td>
 
-**_(BETA)_** Collects and reports the performance statistics.
+**_(BETA)_** PLUGIN that collects and reports the performance statistics.
 
 
 </td></tr>
@@ -359,12 +359,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[GearEvents](./player.gearevents.md)
+[MediaControlEvents](./player.mediacontrolevents.md)
 
 
 </td><td>
 
-**_(BETA)_** Custom events emitted by the plugin
+**_(BETA)_** Custom events emitted by the plugins to communicate with one another
 
 
 </td></tr>
@@ -397,7 +397,7 @@ Description
 
 </td><td>
 
-Custom events emitted by the plugin
+**_(BETA)_** Custom events emitted by the plugin
 
 
 </td></tr>
@@ -471,7 +471,7 @@ Description
 
 </td><td>
 
-Configuration options
+**_(BETA)_** Configuration options for the [clips](./player.clipsplugin.md) plugin.
 
 
 </td></tr>
@@ -496,6 +496,17 @@ Configuration options
 **_(BETA)_** Telemetry init event data
 
 
+</td></tr>
+<tr><td>
+
+[LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Configuration options for the [level selector](./player.levelselector.md) plugin.
+
+
 </td></tr>
 <tr><td>
 
@@ -613,6 +624,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[ContainerPluginConstructor](./player.containerpluginconstructor.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
 [ContainerSize](./player.containersize.md)
 
 
@@ -621,6 +643,17 @@ Description
 **_(BETA)_** Dimensions of the player container DOM element.
 
 
+</td></tr>
+<tr><td>
+
+[CorePluginConstructor](./player.corepluginconstructor.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
 </td></tr>
 <tr><td>
 
@@ -634,6 +667,17 @@ Description
 [DASH.js settings](https://cdn.dashjs.org/latest/jsdoc/module-Settings.html)
 
 
+</td></tr>
+<tr><td>
+
+[ErrorDesc](./player.errordesc.md)
+
+
+</td><td>
+
+**_(BETA)_** An error fired in the player and plugins code to be handled in the UI
+
+
 </td></tr>
 <tr><td>
 
@@ -645,6 +689,17 @@ Description
 **_(BETA)_** Levels of severity of errors. Non-fatal errors usually can be ignored.
 
 
+</td></tr>
+<tr><td>
+
+[ErrorScreenPluginSettings](./player.errorscreenpluginsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Configuration options for the [error screen](./player.errorscreen.md) plugin.
+
+
 </td></tr>
 <tr><td>
 
@@ -788,6 +843,17 @@ Description
 **_(BETA)_**
 
 
+</td></tr>
+<tr><td>
+
+[PlayerPluginConstructor](./player.playerpluginconstructor.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
 </td></tr>
 <tr><td>
 
@@ -810,6 +876,17 @@ Description
 **_(BETA)_** Telemetry record
 
 
+</td></tr>
+<tr><td>
+
+[TelemetrySendFn](./player.telemetrysendfn.md)
+
+
+</td><td>
+
+**_(BETA)_** Callback to send the telemetry record to the storage.
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/{player.errorscreen.container.md → player.mediacontrol.currentseekpos.md}

@@ -1,8 +1,8 @@
 <!-- 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; [container](./player.errorscreen.container.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [currentSeekPos](./player.mediacontrol.currentseekpos.md)
 
-## ErrorScreen.container property
+## MediaControl.currentSeekPos 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.
 > 
@@ -10,5 +10,5 @@
 **Signature:**
 
 ```typescript
-get container(): any;
+get currentSeekPos(): number;
 ```

package/docs/api/player.mediacontrol.disable.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.
 > 
 
-Disables the plugin and unmounts its UI
+Hides the media control UI
 
 **Signature:**
 

package/docs/api/player.mediacontrol.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 MediaControl provides a foundation for developing custom media controls UI.
+PLUGIN that provides a foundation for developing custom media controls UI.
 
 **Signature:**
 
@@ -88,6 +88,27 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[currentSeekPos](./player.mediacontrol.currentseekpos.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
 [muted](./player.mediacontrol.muted.md)
 
 
@@ -158,7 +179,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Disables the plugin and unmounts its UI
+**_(BETA)_** Hides the media control UI
 
 
 </td></tr>

package/docs/api/{player.gearevents.md → player.mediacontrolevents.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; [GearEvents](./player.gearevents.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControlEvents](./player.mediacontrolevents.md)
 
-## GearEvents enum
+## MediaControlEvents enum
 
 > 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.
 > 
 
-Custom events emitted by the plugin
+Custom events emitted by the plugins to communicate with one another
 
 **Signature:**
 
 ```typescript
-export declare enum GearEvents 
+export declare enum MediaControlEvents 
 ```
 
 ## Enumeration Members

package/docs/api/player.multicamera.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 support for loading multiple streams and switching between them using the media control UI.
+PLUGIN that adds support for loading multiple streams and switching between them using the media control UI.
 
 **Signature:**
 
@@ -248,34 +248,6 @@ Description
 **_(BETA)_**
 
 
-</td></tr>
-<tr><td>
-
-[getCamerasList()](./player.multicamera.getcameraslist.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[getCurrentCamera()](./player.multicamera.getcurrentcamera.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 

package/docs/api/player.playbackerror.md

@@ -151,5 +151,24 @@ string
 **_(BETA)_** Component subsystem of the error origin
 
 
+</td></tr>
+<tr><td>
+
+[UI?](./player.playbackerror.ui.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ title: string; message: string; }
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ UI description of the error.
+
+
 </td></tr>
 </tbody></table>

package/docs/api/{player.errorscreen.supportedversion.md → player.playbackerror.ui.md}

@@ -1,16 +1,19 @@
 <!-- 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; [supportedVersion](./player.errorscreen.supportedversion.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlaybackError](./player.playbackerror.md) &gt; [UI](./player.playbackerror.ui.md)
 
-## ErrorScreen.supportedVersion property
+## PlaybackError.UI 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.
 > 
 
+UI description of the error.
+
 **Signature:**
 
 ```typescript
-get supportedVersion(): {
-        min: string;
+UI?: {
+        title: string;
+        message: string;
     };
 ```

package/docs/api/player.playbackerrorcode.md

@@ -40,7 +40,7 @@ Generic
 
 </td><td>
 
-`0`
+`"GENERIC_ERROR"`
 
 
 </td><td>
@@ -56,7 +56,7 @@ MediaSourceAccessDenied
 
 </td><td>
 
-`3`
+`"MEDIA_SOURCE_ACCESS_DENIED"`
 
 
 </td><td>
@@ -72,7 +72,7 @@ MediaSourceUnavailable
 
 </td><td>
 
-`1`
+`"MEDIA_SOURCE_UNAVAILABLE"`
 
 
 </td><td>

package/docs/api/{player.errorscreen.show.md → player.playbackrate._constructor_.md}

@@ -1,16 +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; [show](./player.errorscreen.show.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlaybackRate](./player.playbackrate.md) &gt; [(constructor)](./player.playbackrate._constructor_.md)
 
-## ErrorScreen.show() method
+## PlaybackRate.(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 `PlaybackRate` class
+
 **Signature:**
 
 ```typescript
-show(err?: PresentationalError): void;
+constructor(core: Core);
 ```
 
 ## Parameters
@@ -33,22 +35,16 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-err
+core
 
 
 </td><td>
 
-PresentationalError
+Core
 
 
 </td><td>
 
-_(Optional)_
-
 
 </td></tr>
 </tbody></table>
-**Returns:**
-
-void
-

package/docs/api/player.playbackrate.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 changing the playback speed of the video.
+PLUGIN that allows changing the playback speed of the video.
 
 **Signature:**
 
@@ -24,5 +24,38 @@ Depends on:
 
 - [bottom\_gear](./player.bottomgear.md)
 
-It renders a button in the gear menu, which opens a dropdown with the available playback rates.
+It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate.
 
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(core)](./player.playbackrate._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Constructs a new instance of the `PlaybackRate` class
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.player.registerplugin.md

@@ -12,7 +12,7 @@ Registers a plugin.
 **Signature:**
 
 ```typescript
-static registerPlugin(plugin: PlayerPlugin): void;
+static registerPlugin(plugin: PlayerPluginConstructor): void;
 ```
 
 ## Parameters
@@ -40,7 +40,7 @@ plugin
 
 </td><td>
 
-[PlayerPlugin](./player.playerplugin.md)
+[PlayerPluginConstructor](./player.playerpluginconstructor.md)
 
 
 </td><td>

package/docs/api/player.player.unregisterplugin.md

@@ -12,7 +12,7 @@ Unregisters a plugin registered earlier with [Player.registerPlugin()](./player.
 **Signature:**
 
 ```typescript
-static unregisterPlugin(plugin: PlayerPlugin): void;
+static unregisterPlugin(plugin: PlayerPluginConstructor): void;
 ```
 
 ## Parameters
@@ -40,7 +40,7 @@ plugin
 
 </td><td>
 
-[PlayerPlugin](./player.playerplugin.md)
+[PlayerPluginConstructor](./player.playerpluginconstructor.md)
 
 
 </td><td>

package/docs/api/player.playerpluginconstructor.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; [PlayerPluginConstructor](./player.playerpluginconstructor.md)
+
+## PlayerPluginConstructor 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 PlayerPluginConstructor = CorePluginConstructor | ContainerPluginConstructor;
+```
+**References:** [CorePluginConstructor](./player.corepluginconstructor.md)<!-- -->, [ContainerPluginConstructor](./player.containerpluginconstructor.md)
+

package/docs/api/player.share.attributes.md

@@ -4,6 +4,9 @@
 
 ## Share.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.share.bindevents.md

@@ -4,6 +4,9 @@
 
 ## Share.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.share.canshowshare.md

@@ -4,6 +4,9 @@
 
 ## Share.canShowShare() 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.share.events.md

@@ -4,6 +4,9 @@
 
 ## Share.events 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.share.hideshare.md

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