@gcorevideo/player 2.19.14 → 2.20.1

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.subtitles.hide.md

@@ -4,6 +4,11 @@
 
 ## Subtitles.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 subtitles menu and the subtitles.
+
 **Signature:**
 
 ```typescript

package/docs/api/player.subtitles.md

@@ -4,6 +4,11 @@
 
 ## Subtitles 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.
+> 
+
+A [media control](./player.mediacontrol.md) plugin that provides a UI to select the subtitles when available.
+
 **Signature:**
 
 ```typescript
@@ -11,184 +16,31 @@ export declare class Subtitles extends UICorePlugin
 ```
 **Extends:** UICorePlugin
 
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
+## Remarks
 
+Depends on:
 
-</th><th>
+- [MediaControl](./player.mediacontrol.md)
 
-Description
+Configuration options:
 
+- subtitles.language - The language of the subtitles to select by default.
 
-</th></tr></thead>
-<tbody><tr><td>
-
-[attributes](./player.subtitles.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ class: string; 'data-subtitles': string; }
-
-
-</td><td>
-
+## Example
 
-</td></tr>
-<tr><td>
-
-[events](./player.subtitles.events.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'click \[data-subtitles-select\]': string; 'click \[data-subtitles-button\]': string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[name](./player.subtitles.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[preselectedLanguage](./player.subtitles.preselectedlanguage.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.subtitles.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[template](./player.subtitles.template.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[templateString](./player.subtitles.templatestring.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
 
-any
+```ts
+import { Subtitles } from '@gcorevideo/player'
 
+Player.registerPlugin(Subtitles)
 
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[version](./player.subtitles.version.md)
-
-
-</td><td>
-
-`static`
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
+new Player({
+  ...
+  subtitles: {
+    language: 'en',
+  },
+})
+```
 
 ## Methods
 
@@ -210,30 +62,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[bindEvents()](./player.subtitles.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[buttonElement()](./player.subtitles.buttonelement.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
 [hide()](./player.subtitles.hide.md)
 
 
@@ -242,53 +70,7 @@ Description
 
 </td><td>
 
-
-</td></tr>
-<tr><td>
-
-[levelElement(id)](./player.subtitles.levelelement.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[reload()](./player.subtitles.reload.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[render()](./player.subtitles.render.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[selectSubtitles()](./player.subtitles.selectsubtitles.md)
-
-
-</td><td>
-
-
-</td><td>
+**_(BETA)_** Hides the subtitles menu and the subtitles.
 
 
 </td></tr>
@@ -302,41 +84,7 @@ Description
 
 </td><td>
 
-
-</td></tr>
-<tr><td>
-
-[startLevelSwitch()](./player.subtitles.startlevelswitch.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[stopLevelSwitch()](./player.subtitles.stoplevelswitch.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[unBindEvents()](./player.subtitles.unbindevents.md)
-
-
-</td><td>
-
-
-</td><td>
+**_(BETA)_** Shows the subtitles menu and the subtitles.
 
 
 </td></tr>

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

@@ -4,6 +4,11 @@
 
 ## Subtitles.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 subtitles menu and the subtitles.
+
 **Signature:**
 
 ```typescript

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:**