@gcorevideo/player 2.20.8 → 2.20.11

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:**
 
@@ -18,7 +18,7 @@ export declare class MediaControl extends UICorePlugin
 
 ## Remarks
 
-The methods exposed are to be used by the other plugins that extend the media control UI. The plugin registration should be arranged so that MediaControl is initialized before every other plugin that depends on it.
+The methods exposed are to be used by the other plugins that extend the media control UI. The plugin registration should be arranged so that MediaControl is initialized before every other `PLUGIN` that depends on it.
 
 ## Example
 
@@ -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.pictureinpicture.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.
 > 
 
-Enables picture in picture mode.
+`PLUGIN` that enables picture in picture mode.
 
 **Signature:**
 

package/docs/api/player.playbackerror.code.md

@@ -4,9 +4,6 @@
 
 ## PlaybackError.code 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.
-> 
-
 Error code.
 
 **Signature:**

package/docs/api/player.playbackerror.description.md

@@ -4,9 +4,6 @@
 
 ## PlaybackError.description 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.
-> 
-
 Detailed description of the error.
 
 **Signature:**

package/docs/api/player.playbackerror.level.md

@@ -4,9 +4,6 @@
 
 ## PlaybackError.level 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.
-> 
-
 Level of severity of the error.
 
 **Signature:**

package/docs/api/player.playbackerror.md

@@ -4,9 +4,6 @@
 
 ## PlaybackError 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.
-> 
-
 An error occurred during the playback.
 
 **Signature:**
@@ -53,7 +50,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Error code.
+Error code.
 
 
 </td></tr>
@@ -72,7 +69,7 @@ string
 
 </td><td>
 
-**_(BETA)_** Detailed description of the error.
+Detailed description of the error.
 
 
 </td></tr>
@@ -91,7 +88,7 @@ string
 
 </td><td>
 
-**_(BETA)_** Level of severity of the error.
+Level of severity of the error.
 
 
 </td></tr>
@@ -110,7 +107,7 @@ string
 
 </td><td>
 
-**_(BETA)_** Error message. Non-fatal usually can be ignored.
+Error message. Non-fatal usually can be ignored.
 
 
 </td></tr>
@@ -129,7 +126,7 @@ string
 
 </td><td>
 
-**_(BETA)_** Exact component that originated the error.
+Exact component that originated the error.
 
 
 </td></tr>
@@ -148,7 +145,26 @@ string
 
 </td><td>
 
-**_(BETA)_** Component subsystem of the error origin
+Component subsystem of the error origin
+
+
+</td></tr>
+<tr><td>
+
+[UI?](./player.playbackerror.ui.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ title: string; message: string; icon?: string; }
+
+
+</td><td>
+
+_(Optional)_ UI description of the error.
 
 
 </td></tr>

package/docs/api/player.playbackerror.message.md

@@ -4,9 +4,6 @@
 
 ## PlaybackError.message 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.
-> 
-
 Error message. Non-fatal usually can be ignored.
 
 **Signature:**

package/docs/api/player.playbackerror.origin.md

@@ -4,9 +4,6 @@
 
 ## PlaybackError.origin 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.
-> 
-
 Exact component that originated the error.
 
 **Signature:**

package/docs/api/player.playbackerror.scope.md

@@ -4,9 +4,6 @@
 
 ## PlaybackError.scope 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.
-> 
-
 Component subsystem of the error origin
 
 **Signature:**

package/docs/api/player.playbackerror.ui.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; [PlaybackError](./player.playbackerror.md) &gt; [UI](./player.playbackerror.ui.md)
+
+## PlaybackError.UI property
+
+UI description of the error.
+
+**Signature:**
+
+```typescript
+UI?: {
+        title: string;
+        message: string;
+        icon?: string;
+    };
+```

package/docs/api/player.playbackerrorcode.md

@@ -4,9 +4,6 @@
 
 ## PlaybackErrorCode 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.
-> 
-
 Codes of errors occurring within the playback component.
 
 **Signature:**
@@ -40,12 +37,12 @@ Generic
 
 </td><td>
 
-`0`
+`"GENERIC_ERROR"`
 
 
 </td><td>
 
-**_(BETA)_** An unknown or uncategorised error.
+An unknown or uncategorised error.
 
 
 </td></tr>
@@ -56,12 +53,12 @@ MediaSourceAccessDenied
 
 </td><td>
 
-`3`
+`"MEDIA_SOURCE_ACCESS_DENIED"`
 
 
 </td><td>
 
-**_(BETA)_** The media source is not accessible due to some protection policy.
+The media source is not accessible due to some protection policy.
 
 
 </td></tr>
@@ -72,12 +69,12 @@ MediaSourceUnavailable
 
 </td><td>
 
-`1`
+`"MEDIA_SOURCE_UNAVAILABLE"`
 
 
 </td><td>
 
-**_(BETA)_** The media source is not available. Typically a network error.
+The media source is not available. Typically a network error.
 
 
 </td></tr>

package/docs/api/player.playbackmodule.md

@@ -4,9 +4,6 @@
 
 ## PlaybackModule 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.
-> 
-
 Module to perform the playback.
 
 **Signature:**

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

@@ -1,13 +1,13 @@
 <!-- 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; [PlaybackRate](./player.playbackrate.md) &gt; [(constructor)](./player.playbackrate._constructor_.md)
 
-## DvrControls.(constructor)
+## 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 `DvrControls` class
+Constructs a new instance of the `PlaybackRate` class
 
 **Signature:**
 

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.playbacktype.md

@@ -4,10 +4,7 @@
 
 ## PlaybackType 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.
-> 
-
-Type of a stream playback
+Type of a stream
 
 **Signature:**
 

package/docs/api/player.player._constructor_.md

@@ -4,9 +4,6 @@
 
 ## Player.(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 `Player` class
 
 **Signature:**

package/docs/api/player.player.attachto.md

@@ -4,9 +4,6 @@
 
 ## Player.attachTo() 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.
-> 
-
 Initializes the player at the given container element.
 
 **Signature:**

package/docs/api/player.player.configure.md

@@ -4,9 +4,6 @@
 
 ## Player.configure() 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.
-> 
-
 Configures the player.
 
 **Signature:**

package/docs/api/player.player.destroy.md

@@ -4,9 +4,6 @@
 
 ## Player.destroy() 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.
-> 
-
 Destroys the player, releasing all resources and unmounting its UI from the DOM.
 
 **Signature:**

package/docs/api/player.player.getcurrenttime.md

@@ -4,9 +4,6 @@
 
 ## Player.getCurrentTime() 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.
-> 
-
 Current playback (time since the beginning of the stream), if appropriate.
 
 **Signature:**

package/docs/api/player.player.getduration.md

@@ -4,9 +4,6 @@
 
 ## Player.getDuration() 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.
-> 
-
 Duration of the current media in seconds, if appropriate.
 
 **Signature:**

package/docs/api/player.player.getvolume.md

@@ -4,9 +4,6 @@
 
 ## Player.getVolume() 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.
-> 
-
 Gets the current volume of the media content being played.
 
 **Signature:**

package/docs/api/player.player.isdvrenabled.md

@@ -4,9 +4,6 @@
 
 ## Player.isDvrEnabled() 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.
-> 
-
 Indicates whether DVR is enabled.
 
 **Signature:**

package/docs/api/player.player.isdvrinuse.md

@@ -4,9 +4,6 @@
 
 ## Player.isDvrInUse() 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.
-> 
-
 Indicates whether DVR is in use.
 
 **Signature:**

package/docs/api/player.player.ismuted.md

@@ -4,9 +4,6 @@
 
 ## Player.isMuted() 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.
-> 
-
 Indicates muted state of the video.
 
 **Signature:**

package/docs/api/player.player.isplaying.md

@@ -4,9 +4,6 @@
 
 ## Player.isPlaying() 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.
-> 
-
 Indicates the playing state.
 
 **Signature:**