@gcorevideo/player 2.20.7 → 2.20.9

package/docs/api/player.bottomgear.md

@@ -55,6 +55,20 @@ Description
 **_(BETA)_**
 
 
+</td></tr>
+<tr><td>
+
+[refresh()](./player.bottomgear.refresh.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Re-renders the gear menu. It fires the [MEDIACONTROL\_GEAR\_RENDERED](./player.mediacontrolevents.md) event, which the plugins that attach to the gear menu can listen to to re-render themselves.
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/player.bottomgear.refresh.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [BottomGear](./player.bottomgear.md) &gt; [refresh](./player.bottomgear.refresh.md)
+
+## BottomGear.refresh() 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.
+> 
+
+Re-renders the gear menu. It fires the [MEDIACONTROL\_GEAR\_RENDERED](./player.mediacontrolevents.md) event, which the plugins that attach to the gear menu can listen to to re-render themselves.
+
+**Signature:**
+
+```typescript
+refresh(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.clapprnerdstats.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 useful network-related statistics.
+PLUGIN that displays useful network-related statistics.
 
 **Signature:**
 

package/docs/api/player.clapprstats.exportmetrics.md

@@ -18,5 +18,5 @@ exportMetrics(): Metrics;
 
 Metrics
 
-The collected metrics
+Currently collected metrics
 

package/docs/api/player.clapprstats.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.
 > 
 
-Collects useful statistics about playback performance.
+PLIGIN that collects useful statistics about playback performance.
 
 **Signature:**
 
@@ -85,20 +85,6 @@ Description
 **_(BETA)_** Returns the collected metrics.
 
 
-</td></tr>
-<tr><td>
-
-[onBitrate(newBitrate)](./player.clapprstats.onbitrate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 

package/docs/api/player.clapprstats.setupdatemetrics.md

@@ -45,6 +45,8 @@ MetricsUpdateFn
 
 </td><td>
 
+The callback to receive the metrics
+
 
 </td></tr>
 </tbody></table>

package/docs/api/player.clipsplugin.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 a behavior of showing a text over the seekbar to indicate the current clip.
+PLUGIN that shows text over the seekbar to indicate the current clip.
 
 **Signature:**
 

package/docs/api/player.clipspluginsettings.md

@@ -4,7 +4,10 @@
 
 ## ClipsPluginSettings interface
 
-Configuration options
+> 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 [clips](./player.clipsplugin.md) plugin.
 
 **Signature:**
 
@@ -50,7 +53,7 @@ string
 
 </td><td>
 
-The text to display over the seekbar.
+**_(BETA)_** The text to display over the seekbar.
 
 
 </td></tr>

package/docs/api/player.clipspluginsettings.text.md

@@ -4,6 +4,9 @@
 
 ## ClipsPluginSettings.text 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 text to display over the seekbar.
 
 **Signature:**

package/docs/api/{player.errorscreen.bindevents.md → player.containerpluginconstructor.md}

@@ -1,18 +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; [bindEvents](./player.errorscreen.bindevents.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContainerPluginConstructor](./player.containerpluginconstructor.md)
 
-## ErrorScreen.bindEvents() method
+## ContainerPluginConstructor 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
-bindEvents(): void;
+export type ContainerPluginConstructor = ((container: unknown) => PlayerPlugin) & {
+    type: 'container';
+};
 ```
-**Returns:**
-
-void
+**References:** [PlayerPlugin](./player.playerplugin.md)
 

package/docs/api/{player.errorscreen.render.md → player.corepluginconstructor.md}

@@ -1,18 +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; [render](./player.errorscreen.render.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [CorePluginConstructor](./player.corepluginconstructor.md)
 
-## ErrorScreen.render() method
+## 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
-render(): this;
+export type CorePluginConstructor = ((core: unknown) => PlayerPlugin) & {
+    type: 'core';
+};
 ```
-**Returns:**
-
-this
+**References:** [PlayerPlugin](./player.playerplugin.md)
 

package/docs/api/player.errordesc.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ErrorDesc](./player.errordesc.md)
+
+## ErrorDesc 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 error fired in the player and plugins code to be handled in the UI
+
+**Signature:**
+
+```typescript
+export type ErrorDesc = {
+    description: string;
+    level: string;
+    code: string;
+    origin: string;
+    scope: string;
+    raw?: string;
+    UI?: {
+        icon?: string;
+        title: string;
+        message: string;
+    };
+};
+```

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.hide.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; [hide](./player.errorscreen.hide.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ErrorScreenPluginSettings](./player.errorscreenpluginsettings.md)
 
-## ErrorScreen.hide() 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
-hide(): 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;
+```