@gcorevideo/player 2.19.14 → 2.20.1

package/docs/api/player.playbackrate.md

@@ -4,6 +4,11 @@
 
 ## PlaybackRate 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.
+> 
+
+Allows changing the playback speed of the video.
+
 **Signature:**
 
 ```typescript
@@ -11,322 +16,13 @@ export declare class PlaybackRate 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.playbackrate.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ class: string; 'data-playback-rate-select': string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[events](./player.playbackrate.events.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'click .gear-sub-menu\_btn': string; 'click .gear-option': string; 'click .go-back': string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.playbackrate.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.playbackrate.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[template](./player.playbackrate.template.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[bindEvents()](./player.playbackrate.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[getTitle()](./player.playbackrate.gettitle.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[goBack()](./player.playbackrate.goback.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[highlightCurrentRate()](./player.playbackrate.highlightcurrentrate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[onFinishAd()](./player.playbackrate.onfinishad.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[onPlay()](./player.playbackrate.onplay.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[onRateSelect(event)](./player.playbackrate.onrateselect.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[onShowMenu()](./player.playbackrate.onshowmenu.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[onStartAd()](./player.playbackrate.onstartad.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[onStop()](./player.playbackrate.onstop.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[reload()](./player.playbackrate.reload.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[render()](./player.playbackrate.render.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[setSelectedRate(rate)](./player.playbackrate.setselectedrate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[unBindEvents()](./player.playbackrate.unbindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[updatePlaybackRate(rate)](./player.playbackrate.updateplaybackrate.md)
-
+## Remarks
 
-</td><td>
+Depends on:
 
+- [media\_control](./player.mediacontrol.md)
 
-</td><td>
+- [bottom\_gear](./player.bottomgear.md)
 
+It renders a button in the gear menu, which opens a dropdown with the available playback rates.
 
-</td></tr>
-</tbody></table>

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>

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

@@ -4,47 +4,16 @@
 
 ## SpinnerThreeBounce.show() 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.
+> 
+
+Shows the spinner
+
 **Signature:**
 
 ```typescript
-show(immediate?: boolean): void;
+show(): void;
 ```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-immediate
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
 **Returns:**
 
 void

package/docs/api/{player.playbackrate.onplay.md → player.stalleventdata.count.md}

@@ -1,15 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlaybackRate](./player.playbackrate.md) &gt; [onPlay](./player.playbackrate.onplay.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StallEventData](./player.stalleventdata.md) &gt; [count](./player.stalleventdata.count.md)
 
-## PlaybackRate.onPlay() method
+## StallEventData.count property
+
+Number of stalls
 
 **Signature:**
 
 ```typescript
-onPlay(): void;
+count: number;
 ```
-**Returns:**
-
-void
-