@gcorevideo/player 2.19.15 → 2.20.1

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
-

package/docs/api/{player.playbackrate.name.md → player.stalleventdata.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; [name](./player.playbackrate.name.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StallEventData](./player.stalleventdata.md) &gt; [event](./player.stalleventdata.event.md)
 
-## PlaybackRate.name property
+## StallEventData.event property
 
 **Signature:**
 
 ```typescript
-get name(): string;
+event: TelemetryEvent.Stall;
 ```

package/docs/api/player.stalleventdata.md

@@ -0,0 +1,112 @@
+<!-- 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
+
+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>
+
+Number of stalls
+
+
+</td></tr>
+<tr><td>
+
+[event](./player.stalleventdata.event.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[TelemetryEvent.Stall](./player.telemetryevent.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[time](./player.stalleventdata.time.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+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>
+
+Accumulated buffering duration over the measurement interval, ms
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.stalleventdata.time.md

@@ -0,0 +1,13 @@
+<!-- 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) &gt; [time](./player.stalleventdata.time.md)
+
+## StallEventData.time property
+
+Playback time when the stall is reported at the end of a stall measurement interval, s
+
+**Signature:**
+
+```typescript
+time: number;
+```

package/docs/api/player.stalleventdata.total_ms.md

@@ -0,0 +1,13 @@
+<!-- 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) &gt; [total\_ms](./player.stalleventdata.total_ms.md)
+
+## StallEventData.total\_ms property
+
+Accumulated buffering duration over the measurement interval, ms
+
+**Signature:**
+
+```typescript
+total_ms: number;
+```

package/docs/api/{player.pluginsettings.md → player.starteventdata.event.md}

@@ -1,13 +1,11 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PluginSettings](./player.pluginsettings.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StartEventData](./player.starteventdata.md) &gt; [event](./player.starteventdata.event.md)
 
-## PluginSettings type
+## StartEventData.event property
 
 **Signature:**
 
 ```typescript
-export type PluginSettings = {
-    send: (data: StatisticsRecord) => void;
-};
+event: TelemetryEvent.Start;
 ```

package/docs/api/{player.playbackrate.onrateselect.md → player.starteventdata.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; [onRateSelect](./player.playbackrate.onrateselect.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [StartEventData](./player.starteventdata.md)
 
-## PlaybackRate.onRateSelect() method
+## StartEventData interface
 
 **Signature:**
 
 ```typescript
-onRateSelect(event: MouseEvent): boolean;
+export interface StartEventData 
 ```
 
-## Parameters
+## Properties
 
 <table><thead><tr><th>
 
-Parameter
+Property
+
+
+</th><th>
+
+Modifiers
 
 
 </th><th>
@@ -30,12 +35,15 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-event
+[event](./player.starteventdata.event.md)
 
 
 </td><td>
 
-MouseEvent
+
+</td><td>
+
+[TelemetryEvent.Start](./player.telemetryevent.md)
 
 
 </td><td>
@@ -43,7 +51,3 @@ MouseEvent
 
 </td></tr>
 </tbody></table>
-**Returns:**
-
-boolean
-

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

@@ -1,10 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Statistics](./player.statistics.md) &gt; [(constructor)](./player.statistics._constructor_.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Telemetry](./player.telemetry.md) &gt; [(constructor)](./player.telemetry._constructor_.md)
 
-## Statistics.(constructor)
+## Telemetry.(constructor)
 
-Constructs a new instance of the `Statistics` 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.
+> 
+
+Constructs a new instance of the `Telemetry` class
 
 **Signature:**
 

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.volumefade.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; [VolumeFade](./player.volumefade.md) &gt; [name](./player.volumefade.name.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Telemetry](./player.telemetry.md) &gt; [name](./player.telemetry.name.md)
 
-## VolumeFade.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.clapprnerdstats.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; [ClapprNerdStats](./player.clapprnerdstats.md) &gt; [supportedVersion](./player.clapprnerdstats.supportedversion.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Telemetry](./player.telemetry.md) &gt; [supportedVersion](./player.telemetry.supportedversion.md)
 
-## ClapprNerdStats.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

package/docs/api/player.telemetryevent.md

@@ -0,0 +1,89 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [TelemetryEvent](./player.telemetryevent.md)
+
+## TelemetryEvent enum
+
+Telemetry event type
+
+**Signature:**
+
+```typescript
+export declare enum TelemetryEvent 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+Init
+
+
+</td><td>
+
+`1`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+Stall
+
+
+</td><td>
+
+`4`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+Start
+
+
+</td><td>
+
+`2`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+Watch
+
+
+</td><td>
+
+`3`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.telemetryeventdata.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [TelemetryEventData](./player.telemetryeventdata.md)
+
+## TelemetryEventData type
+
+Telemetry event data
+
+**Signature:**
+
+```typescript
+export type TelemetryEventData = StallEventData | InitEventData | StartEventData | WatchEventData;
+```
+**References:** [StallEventData](./player.stalleventdata.md)<!-- -->, [InitEventData](./player.initeventdata.md)<!-- -->, [StartEventData](./player.starteventdata.md)<!-- -->, [WatchEventData](./player.watcheventdata.md)
+

package/docs/api/player.telemetrypluginsettings.md

@@ -0,0 +1,57 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [TelemetryPluginSettings](./player.telemetrypluginsettings.md)
+
+## TelemetryPluginSettings interface
+
+Plugin settings
+
+**Signature:**
+
+```typescript
+export interface TelemetryPluginSettings 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[send](./player.telemetrypluginsettings.send.md)
+
+
+</td><td>
+
+
+</td><td>
+
+TelemetrySendFn
+
+
+</td><td>
+
+Sends the statistics record to the storage. The actual delivery is presumably async and batched.
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.telemetrypluginsettings.send.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [TelemetryPluginSettings](./player.telemetrypluginsettings.md) &gt; [send](./player.telemetrypluginsettings.send.md)
+
+## TelemetryPluginSettings.send property
+
+Sends the statistics record to the storage. The actual delivery is presumably async and batched.
+
+**Signature:**
+
+```typescript
+send: TelemetrySendFn;
+```

package/docs/api/player.telemetryrecord.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [TelemetryRecord](./player.telemetryrecord.md)
+
+## TelemetryRecord type
+
+Telemetry record
+
+**Signature:**
+
+```typescript
+export type TelemetryRecord = {
+    type: PlaybackType;
+} & TelemetryEventData;
+```
+**References:** [PlaybackType](./player.playbacktype.md)<!-- -->, [TelemetryEventData](./player.telemetryeventdata.md)
+