@gcorevideo/player 2.20.8 → 2.20.9

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.bindevents.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; [bindEvents](./player.errorscreen.bindevents.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ErrorScreenPluginSettings](./player.errorscreenpluginsettings.md)
 
-## ErrorScreen.bindEvents() 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
-bindEvents(): void;
+export type ErrorScreenPluginSettings = {
+    noReload?: boolean;
+};
 ```
-**Returns:**
-
-void
-

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.levelselectorpluginsettings.labels.md

@@ -0,0 +1,24 @@
+<!-- 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) &gt; [labels](./player.levelselectorpluginsettings.labels.md)
+
+## 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
+labels?: Record<number, string>;
+```
+
+## 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>

package/docs/api/player.levelselectorpluginsettings.restrictresolution.md

@@ -0,0 +1,16 @@
+<!-- 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) &gt; [restrictResolution](./player.levelselectorpluginsettings.restrictresolution.md)
+
+## LevelSelectorPluginSettings.restrictResolution 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 maximum resolution to allow in the level selector.
+
+**Signature:**
+
+```typescript
+restrictResolution?: number;
+```

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.hide.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; [hide](./player.errorscreen.hide.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [currentSeekPos](./player.mediacontrol.currentseekpos.md)
 
-## ErrorScreen.hide() method
+## 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,9 +10,5 @@
 **Signature:**
 
 ```typescript
-hide(): void;
+get currentSeekPos(): number;
 ```
-**Returns:**
-
-void
-

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:**