@gcorevideo/player 2.19.15 → 2.20.3

package/docs/api/player.googleanalytics.onseek.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onSeek() 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

package/docs/api/player.googleanalytics.onstop.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onStop() 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

package/docs/api/player.googleanalytics.onvolumechanged.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onVolumeChanged() 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

package/docs/api/player.googleanalytics.push.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.push() 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

package/docs/api/player.googleanalytics.supportedversion.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.supportedVersion 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.
+> 
+
 **Signature:**
 
 ```typescript

package/docs/api/{player.clapprstats.name.md → player.initeventdata.event.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; [ClapprStats](./player.clapprstats.md) &gt; [name](./player.clapprstats.name.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [InitEventData](./player.initeventdata.md) &gt; [event](./player.initeventdata.event.md)
 
-## ClapprStats.name property
+## InitEventData.event 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,5 +10,5 @@
 **Signature:**
 
 ```typescript
-get name(): string;
+event: TelemetryEvent.Init;
 ```

package/docs/api/player.initeventdata.md

@@ -0,0 +1,60 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [InitEventData](./player.initeventdata.md)
+
+## InitEventData 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.
+> 
+
+Telemetry init event data
+
+**Signature:**
+
+```typescript
+export interface InitEventData 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[event](./player.initeventdata.event.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[TelemetryEvent.Init](./player.telemetryevent.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>

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

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

package/docs/api/player.logo.attributes.md

@@ -4,6 +4,9 @@
 
 ## Logo.attributes 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.
+> 
+
 **Signature:**
 
 ```typescript

package/docs/api/player.logo.bindevents.md

@@ -4,6 +4,9 @@
 
 ## Logo.bindEvents() 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

package/docs/api/player.logo.md

@@ -4,6 +4,11 @@
 
 ## Logo 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.
+> 
+
+The plugin adds custom logo to the player.
+
 **Signature:**
 
 ```typescript
@@ -39,7 +44,7 @@ Description
 
 </td><td>
 
-Constructs a new instance of the `Logo` class
+**_(BETA)_** Constructs a new instance of the `Logo` class
 
 
 </td></tr>
@@ -85,6 +90,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -104,6 +111,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -123,6 +132,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -142,6 +153,8 @@ any
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>
@@ -174,6 +187,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -186,6 +201,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -198,6 +215,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>

package/docs/api/player.logo.name.md

@@ -4,6 +4,9 @@
 
 ## Logo.name 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.
+> 
+
 **Signature:**
 
 ```typescript

package/docs/api/player.logo.render.md

@@ -4,6 +4,9 @@
 
 ## Logo.render() 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

package/docs/api/player.logo.stoplistening.md

@@ -4,6 +4,9 @@
 
 ## Logo.stopListening() 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

package/docs/api/player.logo.supportedversion.md

@@ -4,6 +4,9 @@
 
 ## Logo.supportedVersion 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.
+> 
+
 **Signature:**
 
 ```typescript

package/docs/api/player.logo.template.md

@@ -4,6 +4,9 @@
 
 ## Logo.template 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.
+> 
+
 **Signature:**
 
 ```typescript

package/docs/api/player.md

@@ -30,7 +30,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Adds an audio track selector to the media control UI.
 
 
 </td></tr>
@@ -41,7 +41,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Displays a big mute button over the video when it's muted. Once pressed, it unmutes the video.
 
 
 </td></tr>
@@ -63,7 +63,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Displays useful network-related statistics.
 
 
 </td></tr>
@@ -74,7 +74,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Collects useful statistics about playback performance.
 
 
 </td></tr>
@@ -85,6 +85,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Adds a behavior of toggling the playback state on click over the container
+
 
 </td></tr>
 <tr><td>
@@ -94,6 +96,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Adds a behavior of showing a text over the seekbar to indicate the current clip.
+
 
 </td></tr>
 <tr><td>
@@ -103,14 +107,7 @@ Description
 
 </td><td>
 
-
-</td></tr>
-<tr><td>
-
-[DisableControls](./player.disablecontrols.md)
-
-
-</td><td>
+**_(BETA)_** Displays a small context menu when clicked on the player container.
 
 
 </td></tr>
@@ -132,6 +129,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Displays a descriptive error in the overlay on top of the player.
+
 
 </td></tr>
 <tr><td>
@@ -141,6 +140,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** The plugin adds custom favicon to the player's tab.
+
 
 </td></tr>
 <tr><td>
@@ -150,6 +151,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** An example Google Analytics integration plugin
+
 
 </td></tr>
 <tr><td>
@@ -170,6 +173,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** The plugin adds custom logo to the player.
+
 
 </td></tr>
 <tr><td>
@@ -190,6 +195,8 @@ Description
 
 </td><td>
 
+The plugin adds support for loading multiple streams and switching between them using the media control UI.
+
 
 </td></tr>
 <tr><td>
@@ -199,6 +206,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Enables picture in picture mode.
+
 
 </td></tr>
 <tr><td>
@@ -208,6 +217,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Allows changing the playback speed of the video.
+
 
 </td></tr>
 <tr><td>
@@ -239,6 +250,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** The plugin adds a seek time indicator to the media control UI.
+
 
 </td></tr>
 <tr><td>
@@ -248,6 +261,8 @@ Description
 
 </td><td>
 
+The plugin adds a share button to the media control UI.
+
 
 </td></tr>
 <tr><td>
@@ -257,6 +272,8 @@ Description
 
 </td><td>
 
+The plugin adds skip controls to the media control UI.
+
 
 </td></tr>
 <tr><td>
@@ -283,21 +300,23 @@ Description
 </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)_** A [media control](./player.mediacontrol.md) plugin that provides a UI to select the subtitles when available.
+**_(BETA)_** Collects and reports the performance statistics.
 
 
 </td></tr>
@@ -308,6 +327,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Displays the thumbnails of the video when available.
+
 
 </td></tr>
 <tr><td>
@@ -317,7 +338,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Applies fade effect to the player's volume change.
 
 
 </td></tr>
@@ -343,7 +364,7 @@ Description
 
 </td><td>
 
-Custom events emitted by the plugin
+**_(BETA)_** Custom events emitted by the plugin
 
 
 </td></tr>
@@ -379,6 +400,17 @@ Custom events emitted by the plugin
 Custom events emitted by the plugin
 
 
+</td></tr>
+<tr><td>
+
+[TelemetryEvent](./player.telemetryevent.md)
+
+
+</td><td>
+
+**_(BETA)_** Telemetry event type
+
+
 </td></tr>
 <tr><td>
 
@@ -432,6 +464,37 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[ClipsPluginSettings](./player.clipspluginsettings.md)
+
+
+</td><td>
+
+Configuration options
+
+
+</td></tr>
+<tr><td>
+
+[ContextMenuPluginSettings](./player.contextmenupluginsettings.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[InitEventData](./player.initeventdata.md)
+
+
+</td><td>
+
+**_(BETA)_** Telemetry init event data
+
+
+</td></tr>
+<tr><td>
+
 [PlaybackError](./player.playbackerror.md)
 
 
@@ -473,6 +536,39 @@ Description
 **_(BETA)_** A level of quality within a media source.
 
 
+</td></tr>
+<tr><td>
+
+[StallEventData](./player.stalleventdata.md)
+
+
+</td><td>
+
+**_(BETA)_** Playback stall event data
+
+
+</td></tr>
+<tr><td>
+
+[StartEventData](./player.starteventdata.md)
+
+
+</td><td>
+
+**_(BETA)_** Telemetry start event data
+
+
+</td></tr>
+<tr><td>
+
+[TelemetryPluginSettings](./player.telemetrypluginsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Plugin settings
+
+
 </td></tr>
 <tr><td>
 
@@ -484,6 +580,17 @@ Description
 **_(BETA)_** Current playback time and total duration of the media.
 
 
+</td></tr>
+<tr><td>
+
+[WatchEventData](./player.watcheventdata.md)
+
+
+</td><td>
+
+**_(BETA)_** Telemetry watch event data
+
+
 </td></tr>
 </tbody></table>
 
@@ -680,11 +787,35 @@ Description
 </td></tr>
 <tr><td>
 
-[PluginSettings](./player.pluginsettings.md)
+[TelemetryEventData](./player.telemetryeventdata.md)
+
+
+</td><td>
+
+**_(BETA)_** Telemetry event data
+
+
+</td></tr>
+<tr><td>
+
+[TelemetryRecord](./player.telemetryrecord.md)
 
 
 </td><td>
 
+**_(BETA)_** Telemetry record
+
+
+</td></tr>
+<tr><td>
+
+[ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Plugin configuration options for the thumbnails plugin.
+
 
 </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' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'subtitlesSelector';
+export type MediaControlElement = 'audioTracksSelector' | 'bottomGear' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'subtitlesSelector';
 ```

package/docs/api/player.multicamera.md

@@ -4,6 +4,8 @@
 
 ## MultiCamera class
 
+The plugin adds support for loading multiple streams and switching between them using the media control UI.
+
 **Signature:**
 
 ```typescript