@gcorevideo/player 2.19.14 → 2.20.1

package/docs/api/player.gearevents.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; [GearEvents](./player.gearevents.md)
+
+## GearEvents enum
+
+Custom events emitted by the plugin
+
+**Signature:**
+
+```typescript
+export declare enum GearEvents 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+MEDIACONTROL\_GEAR\_RENDERED
+
+
+</td><td>
+
+`"mediacontrol:gear:rendered"`
+
+
+</td><td>
+
+Emitted when the gear menu is rendered
+
+
+</td></tr>
+</tbody></table>

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.playbackrate.template.md → player.initeventdata.event.md}

@@ -1,11 +1,11 @@
 <!-- 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; [template](./player.playbackrate.template.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [InitEventData](./player.initeventdata.md) &gt; [event](./player.initeventdata.event.md)
 
-## PlaybackRate.template property
+## InitEventData.event property
 
 **Signature:**
 
 ```typescript
-get template(): any;
+event: TelemetryEvent.Init;
 ```

package/docs/api/{player.playbackrate.updateplaybackrate.md → player.initeventdata.md}

@@ -1,20 +1,25 @@
 <!-- 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; [updatePlaybackRate](./player.playbackrate.updateplaybackrate.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [InitEventData](./player.initeventdata.md)
 
-## PlaybackRate.updatePlaybackRate() method
+## InitEventData interface
 
 **Signature:**
 
 ```typescript
-updatePlaybackRate(rate: string): void;
+export interface InitEventData 
 ```
 
-## Parameters
+## Properties
 
 <table><thead><tr><th>
 
-Parameter
+Property
+
+
+</th><th>
+
+Modifiers
 
 
 </th><th>
@@ -30,12 +35,15 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-rate
+[event](./player.initeventdata.event.md)
 
 
 </td><td>
 
-string
+
+</td><td>
+
+[TelemetryEvent.Init](./player.telemetryevent.md)
 
 
 </td><td>
@@ -43,7 +51,3 @@ string
 
 </td></tr>
 </tbody></table>
-**Returns:**
-
-void
-

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

@@ -63,7 +63,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Displays useful network-related statistics.
 
 
 </td></tr>
@@ -132,6 +132,10 @@ Description
 
 </td><td>
 
+**_(BETA)_** Displays a descriptive error in the overlay on top of the player.
+
+TODO
+
 
 </td></tr>
 <tr><td>
@@ -199,6 +203,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Enables picture in picture mode.
+
 
 </td></tr>
 <tr><td>
@@ -208,6 +214,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Allows changing the playback speed of the video.
+
 
 </td></tr>
 <tr><td>
@@ -277,24 +285,30 @@ Description
 
 </td><td>
 
+**_(BETA)_** Shows a pending operation indicator when playback is buffering or in other appropriate cases
+
 
 </td></tr>
 <tr><td>
 
-[Statistics](./player.statistics.md)
+[Subtitles](./player.subtitles.md)
 
 
 </td><td>
 
+**_(BETA)_** A [media control](./player.mediacontrol.md) plugin that provides a UI to select the subtitles when available.
+
 
 </td></tr>
 <tr><td>
 
-[Subtitles](./player.subtitles.md)
+[Telemetry](./player.telemetry.md)
 
 
 </td><td>
 
+**_(BETA)_** Collects and reports the performance statistics.
+
 
 </td></tr>
 <tr><td>
@@ -334,6 +348,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 +378,28 @@ 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>
+
+[TelemetryEvent](./player.telemetryevent.md)
+
+
+</td><td>
+
+Telemetry event type
+
+
 </td></tr>
 <tr><td>
 
@@ -406,6 +453,15 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[InitEventData](./player.initeventdata.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
 [PlaybackError](./player.playbackerror.md)
 
 
@@ -447,6 +503,37 @@ Description
 **_(BETA)_** A level of quality within a media source.
 
 
+</td></tr>
+<tr><td>
+
+[StallEventData](./player.stalleventdata.md)
+
+
+</td><td>
+
+Playback stall event data
+
+
+</td></tr>
+<tr><td>
+
+[StartEventData](./player.starteventdata.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TelemetryPluginSettings](./player.telemetrypluginsettings.md)
+
+
+</td><td>
+
+Plugin settings
+
+
 </td></tr>
 <tr><td>
 
@@ -458,6 +545,15 @@ Description
 **_(BETA)_** Current playback time and total duration of the media.
 
 
+</td></tr>
+<tr><td>
+
+[WatchEventData](./player.watcheventdata.md)
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 
@@ -508,6 +604,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>
 
@@ -643,11 +750,24 @@ Description
 </td></tr>
 <tr><td>
 
-[PluginSettings](./player.pluginsettings.md)
+[TelemetryEventData](./player.telemetryeventdata.md)
+
+
+</td><td>
+
+Telemetry event data
+
+
+</td></tr>
+<tr><td>
+
+[TelemetryRecord](./player.telemetryrecord.md)
 
 
 </td><td>
 
+Telemetry record
+
 
 </td></tr>
 <tr><td>

package/docs/api/{player.clapprnerdstats.render.md → player.mediacontrol.getrightpanel.md}

@@ -1,18 +1,22 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprNerdStats](./player.clapprnerdstats.md) &gt; [render](./player.clapprnerdstats.render.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [getRightPanel](./player.mediacontrol.getrightpanel.md)
 
-## ClapprNerdStats.render() method
+## 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
-render(): this;
+getRightPanel(): any;
 ```
 **Returns:**
 
-this
+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.pictureinpicture.md

@@ -4,6 +4,11 @@
 
 ## PictureInPicture 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.
+> 
+
+Enables picture in picture mode.
+
 **Signature:**
 
 ```typescript
@@ -11,204 +16,11 @@ export declare class PictureInPicture 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>
-
-[events](./player.pictureinpicture.events.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'click button': string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.pictureinpicture.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.pictureinpicture.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[version](./player.pictureinpicture.version.md)
-
-
-</td><td>
-
-`static`
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[videoElement](./player.pictureinpicture.videoelement.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.pictureinpicture.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[exitPictureInPicture()](./player.pictureinpicture.exitpictureinpicture.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[render()](./player.pictureinpicture.render.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[requestPictureInPicture()](./player.pictureinpicture.requestpictureinpicture.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[togglePictureInPicture()](./player.pictureinpicture.togglepictureinpicture.md)
-
-
-</td><td>
+## Remarks
 
+Depends on:
 
-</td><td>
+- [MediaControl](./player.mediacontrol.md)
 
+It renders a button to toggle picture in picture mode in the media control UI.
 
-</td></tr>
-</tbody></table>