@gcorevideo/player 2.20.8 → 2.20.9

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

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

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

@@ -4,7 +4,10 @@
 
 ## Share class
 
-The plugin adds a share button to the media control UI.
+> 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 adds a share button to the media control UI.
 
 **Signature:**
 
@@ -53,6 +56,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -72,6 +77,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -91,6 +98,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -110,6 +119,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -129,6 +140,8 @@ any
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>
@@ -161,6 +174,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -173,6 +188,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -185,6 +202,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -197,6 +216,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -209,6 +230,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -221,6 +244,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -233,6 +258,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -245,6 +272,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -257,6 +286,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -269,6 +300,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -281,6 +314,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -293,6 +328,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -305,6 +342,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>

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

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

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

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

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

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

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

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

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

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

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