@gcorevideo/player 2.19.14 → 2.19.15

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

@@ -0,0 +1,56 @@
+<!-- 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; [getElement](./player.bottomgear.getelement.md)
+
+## BottomGear.getElement() 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
+getElement(name: GearItemElement): ZeptoResult | null;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+name
+
+
+</td><td>
+
+[GearItemElement](./player.gearitemelement.md)
+
+
+</td><td>
+
+Name of a gear menu placeholder item to attach custom UI
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[ZeptoResult](./player.zeptoresult.md) \| null
+
+Zepto result of the element
+

package/docs/api/player.bottomgear.md

@@ -20,3 +20,54 @@ export declare class BottomGear extends UICorePlugin
 
 The plugins provides a base for attaching custom settings UI in the gear menu
 
+Depends on:
+
+- [media\_control](./player.mediacontrol.md)
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getElement(name)](./player.bottomgear.getelement.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[setContent(content)](./player.bottomgear.setcontent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Replaces the content of the gear menu
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,56 @@
+<!-- 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; [setContent](./player.bottomgear.setcontent.md)
+
+## BottomGear.setContent() 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.
+> 
+
+Replaces the content of the gear menu
+
+**Signature:**
+
+```typescript
+setContent(content: ZeptoResult): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+content
+
+
+</td><td>
+
+[ZeptoResult](./player.zeptoresult.md)
+
+
+</td><td>
+
+Zepto result of the element
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/{player.subtitles.levelelement.md → player.gearevents.md}

@@ -1,25 +1,27 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Subtitles](./player.subtitles.md) &gt; [levelElement](./player.subtitles.levelelement.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [GearEvents](./player.gearevents.md)
 
-## Subtitles.levelElement() method
+## GearEvents enum
+
+Custom events emitted by the plugin
 
 **Signature:**
 
 ```typescript
-levelElement(id?: string): ZeptoResult;
+export declare enum GearEvents 
 ```
 
-## Parameters
+## Enumeration Members
 
 <table><thead><tr><th>
 
-Parameter
+Member
 
 
 </th><th>
 
-Type
+Value
 
 
 </th><th>
@@ -30,22 +32,18 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-id
+MEDIACONTROL\_GEAR\_RENDERED
 
 
 </td><td>
 
-string
+`"mediacontrol:gear:rendered"`
 
 
 </td><td>
 
-_(Optional)_
+Emitted when the gear menu is rendered
 
 
 </td></tr>
 </tbody></table>
-**Returns:**
-
-[ZeptoResult](./player.zeptoresult.md)
-

package/docs/api/{player.sourcecontroller.name.md → player.gearitemelement.md}

@@ -1,14 +1,16 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [SourceController](./player.sourcecontroller.md) &gt; [name](./player.sourcecontroller.name.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [GearItemElement](./player.gearitemelement.md)
 
-## SourceController.name property
+## GearItemElement 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 element inside the gear menu
+
 **Signature:**
 
 ```typescript
-get name(): string;
+export type GearItemElement = 'quality' | 'rate' | 'nerd';
 ```

package/docs/api/player.levelselector.md

@@ -18,7 +18,15 @@ export declare class LevelSelector extends UICorePlugin
 
 ## Remarks
 
-The plugin is rendered as a button in the [gear menu](./player.bottomgear.md)<!-- -->. When clicked, it shows a list of quality levels to choose from.
+Depends on:
+
+- [MediaControl](./player.mediacontrol.md)
+
+- [BottomGear](./player.bottomgear.md)
+
+The plugin is rendered as an item in the gear menu.
+
+When clicked, it shows a list of quality levels to choose from.
 
 Configuration options:
 

package/docs/api/player.md

@@ -277,6 +277,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Shows a pending operation indicator when playback is buffering or in other appropriate cases
+
 
 </td></tr>
 <tr><td>
@@ -295,6 +297,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** A [media control](./player.mediacontrol.md) plugin that provides a UI to select the subtitles when available.
+
 
 </td></tr>
 <tr><td>
@@ -334,6 +338,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[GearEvents](./player.gearevents.md)
+
+
+</td><td>
+
+Custom events emitted by the plugin
+
+
+</td></tr>
+<tr><td>
+
 [PlaybackErrorCode](./player.playbackerrorcode.md)
 
 
@@ -353,6 +368,17 @@ Description
 **_(BETA)_** A top-level event on the player object
 
 
+</td></tr>
+<tr><td>
+
+[SpinnerEvents](./player.spinnerevents.md)
+
+
+</td><td>
+
+Custom events emitted by the plugin
+
+
 </td></tr>
 <tr><td>
 
@@ -508,6 +534,17 @@ Description
 **_(BETA)_** Levels of severity of errors. Non-fatal errors usually can be ignored.
 
 
+</td></tr>
+<tr><td>
+
+[GearItemElement](./player.gearitemelement.md)
+
+
+</td><td>
+
+**_(BETA)_** An element inside the gear menu
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/{player.sourcecontroller.supportedversion.md → player.mediacontrol.getrightpanel.md}

@@ -1,16 +1,22 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [SourceController](./player.sourcecontroller.md) &gt; [supportedVersion](./player.sourcecontroller.supportedversion.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [getRightPanel](./player.mediacontrol.getrightpanel.md)
 
-## SourceController.supportedVersion property
+## MediaControl.getRightPanel() 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.
 > 
 
+Get the right panel area to append custom elements to
+
 **Signature:**
 
 ```typescript
-get supportedVersion(): {
-        min: string;
-    };
+getRightPanel(): any;
 ```
+**Returns:**
+
+any
+
+ZeptoSelector of the right panel element
+

package/docs/api/player.mediacontrol.md

@@ -217,6 +217,20 @@ Description
 **_(BETA)_** Get a media control element DOM node
 
 
+</td></tr>
+<tr><td>
+
+[getRightPanel()](./player.mediacontrol.getrightpanel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Get the right panel area to append custom elements to
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/player.mediacontrolelement.md

@@ -12,5 +12,5 @@ Media control elements, mount points for additional plugins
 **Signature:**
 
 ```typescript
-export type MediaControlElement = 'bottomGear' | 'clipText' | 'pip' | 'playbackRate' | 'seekBarContainer';
+export type MediaControlElement = 'bottomGear' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'subtitlesSelector';
 ```

package/docs/api/player.sourcecontroller.md

@@ -62,95 +62,5 @@ Description
 **_(BETA)_** Constructs a new instance of the `SourceController` class
 
 
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[name](./player.sourcecontroller.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.sourcecontroller.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[version](./player.sourcecontroller.version.md)
-
-
-</td><td>
-
-`static`
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 </tbody></table>

package/docs/api/player.spinnerevents.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [SpinnerEvents](./player.spinnerevents.md)
+
+## SpinnerEvents enum
+
+Custom events emitted by the plugin
+
+**Signature:**
+
+```typescript
+export declare enum SpinnerEvents 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+SYNC
+
+
+</td><td>
+
+`"plugins:spinner:sync"`
+
+
+</td><td>
+
+Emitted at the end of the spinner animation cycle to facilitate smooth UI updates, e.g. [SourceController](./player.sourcecontroller.md) listens to this event to reload the source when the spinner is hidden
+
+
+</td></tr>
+</tbody></table>

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

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

package/docs/api/player.spinnerthreebounce.hide.md

@@ -4,6 +4,11 @@
 
 ## SpinnerThreeBounce.hide() 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.
+> 
+
+Hides the spinner
+
 **Signature:**
 
 ```typescript

package/docs/api/player.spinnerthreebounce.md

@@ -4,6 +4,11 @@
 
 ## SpinnerThreeBounce class
 
+> 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.
+> 
+
+Shows a pending operation indicator when playback is buffering or in other appropriate cases
+
 **Signature:**
 
 ```typescript
@@ -11,6 +16,10 @@ export declare class SpinnerThreeBounce extends UIContainerPlugin
 ```
 **Extends:** UIContainerPlugin
 
+## Remarks
+
+The plugin emits
+
 ## Constructors
 
 <table><thead><tr><th>
@@ -39,89 +48,7 @@ Description
 
 </td><td>
 
-Constructs a new instance of the `SpinnerThreeBounce` class
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[attributes](./player.spinnerthreebounce.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'data-spinner': string; class: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.spinnerthreebounce.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.spinnerthreebounce.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
+**_(BETA)_** Constructs a new instance of the `SpinnerThreeBounce` class
 
 
 </td></tr>
@@ -155,23 +82,13 @@ Description
 
 </td><td>
 
-
-</td></tr>
-<tr><td>
-
-[render()](./player.spinnerthreebounce.render.md)
-
-
-</td><td>
-
-
-</td><td>
+**_(BETA)_** Hides the spinner
 
 
 </td></tr>
 <tr><td>
 
-[show(immediate)](./player.spinnerthreebounce.show.md)
+[show()](./player.spinnerthreebounce.show.md)
 
 
 </td><td>
@@ -179,6 +96,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Shows the spinner
+
 
 </td></tr>
 </tbody></table>