@gcorevideo/player 2.19.15 → 2.20.3

package/docs/api/player.seektime.mediacontrol.md

@@ -4,6 +4,9 @@
 
 ## SeekTime.mediaControl 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.seektime.mediacontrolcontainer.md

@@ -4,6 +4,9 @@
 
 ## SeekTime.mediaControlContainer 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.seektime.name.md

@@ -4,6 +4,9 @@
 
 ## SeekTime.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.seektime.render.md

@@ -4,6 +4,9 @@
 
 ## SeekTime.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.seektime.shouldbevisible.md

@@ -4,6 +4,9 @@
 
 ## SeekTime.shouldBeVisible() 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.seektime.supportedversion.md

@@ -4,6 +4,9 @@
 
 ## SeekTime.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.seektime.template.md

@@ -4,6 +4,9 @@
 
 ## SeekTime.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.seektime.update.md

@@ -4,6 +4,9 @@
 
 ## SeekTime.update() 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.share.md

@@ -4,6 +4,8 @@
 
 ## Share class
 
+The plugin adds a share button to the media control UI.
+
 **Signature:**
 
 ```typescript

package/docs/api/player.skiptime.md

@@ -4,6 +4,8 @@
 
 ## SkipTime class
 
+The plugin adds skip controls to the media control UI.
+
 **Signature:**
 
 ```typescript

package/docs/api/{player.clapprstats.destroy.md → player.stalleventdata.count.md}

@@ -1,18 +1,16 @@
 <!-- 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; [destroy](./player.clapprstats.destroy.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StallEventData](./player.stalleventdata.md) &gt; [count](./player.stalleventdata.count.md)
 
-## ClapprStats.destroy() method
+## StallEventData.count 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.
 > 
 
+Number of stalls
+
 **Signature:**
 
 ```typescript
-destroy(): void;
+count: number;
 ```
-**Returns:**
-
-void
-

package/docs/api/{player.bigmutebutton.template.md → player.stalleventdata.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; [BigMuteButton](./player.bigmutebutton.md) &gt; [template](./player.bigmutebutton.template.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StallEventData](./player.stalleventdata.md) &gt; [event](./player.stalleventdata.event.md)
 
-## BigMuteButton.template property
+## StallEventData.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 template(): any;
+event: TelemetryEvent.Stall;
 ```

package/docs/api/player.stalleventdata.md

@@ -0,0 +1,117 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StallEventData](./player.stalleventdata.md)
+
+## StallEventData 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.
+> 
+
+Playback stall event data
+
+**Signature:**
+
+```typescript
+export interface StallEventData 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[count](./player.stalleventdata.count.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(BETA)_** Number of stalls
+
+
+</td></tr>
+<tr><td>
+
+[event](./player.stalleventdata.event.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[TelemetryEvent.Stall](./player.telemetryevent.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[time](./player.stalleventdata.time.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(BETA)_** Playback time when the stall is reported at the end of a stall measurement interval, s
+
+
+</td></tr>
+<tr><td>
+
+[total\_ms](./player.stalleventdata.total_ms.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(BETA)_** Accumulated buffering duration over the measurement interval, ms
+
+
+</td></tr>
+</tbody></table>

package/docs/api/{player.audioselector.onshowlevelselectmenu.md → player.stalleventdata.time.md}

@@ -1,18 +1,16 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [AudioSelector](./player.audioselector.md) &gt; [onShowLevelSelectMenu](./player.audioselector.onshowlevelselectmenu.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StallEventData](./player.stalleventdata.md) &gt; [time](./player.stalleventdata.time.md)
 
-## AudioSelector.onShowLevelSelectMenu() method
+## StallEventData.time 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.
 > 
 
+Playback time when the stall is reported at the end of a stall measurement interval, s
+
 **Signature:**
 
 ```typescript
-onShowLevelSelectMenu(): void;
+time: number;
 ```
-**Returns:**
-
-void
-

package/docs/api/{player.clapprstats.starttimers.md → player.stalleventdata.total_ms.md}

@@ -1,18 +1,16 @@
 <!-- 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; [startTimers](./player.clapprstats.starttimers.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StallEventData](./player.stalleventdata.md) &gt; [total\_ms](./player.stalleventdata.total_ms.md)
 
-## ClapprStats.startTimers() method
+## StallEventData.total\_ms 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.
 > 
 
+Accumulated buffering duration over the measurement interval, ms
+
 **Signature:**
 
 ```typescript
-startTimers(): void;
+total_ms: number;
 ```
-**Returns:**
-
-void
-

package/docs/api/{player.audioselector.template.md → player.starteventdata.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; [AudioSelector](./player.audioselector.md) &gt; [template](./player.audioselector.template.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StartEventData](./player.starteventdata.md) &gt; [event](./player.starteventdata.event.md)
 
-## AudioSelector.template property
+## StartEventData.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 template(): any;
+event: TelemetryEvent.Start;
 ```

package/docs/api/player.starteventdata.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; [StartEventData](./player.starteventdata.md)
+
+## StartEventData 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 start event data
+
+**Signature:**
+
+```typescript
+export interface StartEventData 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[event](./player.starteventdata.event.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[TelemetryEvent.Start](./player.telemetryevent.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>

package/docs/api/{player.clapprstats._defaultreport.md → player.telemetry._constructor_.md}

@@ -1,16 +1,18 @@
 <!-- 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; [\_defaultReport](./player.clapprstats._defaultreport.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Telemetry](./player.telemetry.md) &gt; [(constructor)](./player.telemetry._constructor_.md)
 
-## ClapprStats.\_defaultReport() method
+## Telemetry.(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 `Telemetry` class
+
 **Signature:**
 
 ```typescript
-_defaultReport(metrics: Metrics): void;
+constructor(container: Container);
 ```
 
 ## Parameters
@@ -33,12 +35,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-metrics
+container
 
 
 </td><td>
 
-Metrics
+Container
 
 
 </td><td>
@@ -46,7 +48,3 @@ Metrics
 
 </td></tr>
 </tbody></table>
-**Returns:**
-
-void
-

package/docs/api/player.telemetry.md

@@ -0,0 +1,146 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Telemetry](./player.telemetry.md)
+
+## Telemetry 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.
+> 
+
+Collects and reports the performance statistics.
+
+**Signature:**
+
+```typescript
+export declare class Telemetry extends ContainerPlugin 
+```
+**Extends:** ContainerPlugin
+
+## Remarks
+
+This plugin is experimental and its API is likely to change.
+
+Configuration options [TelemetryPluginSettings](./player.telemetrypluginsettings.md)
+
+## Example
+
+
+```ts
+import { Statistics } from '@gcorevideo/player'
+
+Player.registerPlugin(Statistics)
+
+const player = new Player({
+  statistics: {
+    send: (data) => {
+       fetch('/stats', {
+         method: 'POST',
+         body: JSON.stringify(data),
+         headers: { 'content-type': 'application/json' },
+       })
+    },
+  },
+  ...
+})
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(container)](./player.telemetry._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Constructs a new instance of the `Telemetry` 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.telemetry.name.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** The name of the plugin.
+
+
+</td></tr>
+<tr><td>
+
+[supportedVersion](./player.telemetry.supportedversion.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+{ min: string; }
+
+
+</td><td>
+
+**_(BETA)_** The supported version of the plugin.
+
+
+</td></tr>
+</tbody></table>

package/docs/api/{player.clapprnerdstats.name.md → player.telemetry.name.md}

@@ -1,12 +1,14 @@
 <!-- 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; [name](./player.clapprnerdstats.name.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Telemetry](./player.telemetry.md) &gt; [name](./player.telemetry.name.md)
 
-## ClapprNerdStats.name property
+## Telemetry.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.
 > 
 
+The name of the plugin.
+
 **Signature:**
 
 ```typescript

package/docs/api/{player.clapprstats.supportedversion.md → player.telemetry.supportedversion.md}

@@ -1,12 +1,14 @@
 <!-- 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; [supportedVersion](./player.clapprstats.supportedversion.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Telemetry](./player.telemetry.md) &gt; [supportedVersion](./player.telemetry.supportedversion.md)
 
-## ClapprStats.supportedVersion property
+## Telemetry.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.
 > 
 
+The supported version of the plugin.
+
 **Signature:**
 
 ```typescript