@gcorevideo/player 2.19.14 → 2.20.1

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

package/docs/api/player.volumefade.md

@@ -15,96 +15,3 @@ export declare class VolumeFade 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>
-
-[name](./player.volumefade.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[bindEvents()](./player.volumefade.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[unBindEvents()](./player.volumefade.unbindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-</tbody></table>

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

package/docs/api/{player.playbackrate.setselectedrate.md → player.watcheventdata.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; [setSelectedRate](./player.playbackrate.setselectedrate.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [WatchEventData](./player.watcheventdata.md)
 
-## PlaybackRate.setSelectedRate() method
+## WatchEventData interface
 
 **Signature:**
 
 ```typescript
-setSelectedRate(rate: string): void;
+export interface WatchEventData 
 ```
 
-## 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.watcheventdata.event.md)
 
 
 </td><td>
 
-string
+
+</td><td>
+
+[TelemetryEvent.Watch](./player.telemetryevent.md)
 
 
 </td><td>
@@ -43,7 +51,3 @@ string
 
 </td></tr>
 </tbody></table>
-**Returns:**
-
-void
-

package/lib/index.plugins.d.ts

@@ -24,9 +24,9 @@ export * from "./plugins/seek-time/SeekTime.js";
 export * from "./plugins/share/Share.js";
 export * from "./plugins/skip-time/SkipTime.js";
 export * from "./plugins/spinner-three-bounce/SpinnerThreeBounce.js";
-export * from "./plugins/statistics/Statistics.js";
+export * from "./plugins/source-controller/SourceController.js";
 export * from "./plugins/subtitles/Subtitles.js";
+export * from "./plugins/telemetry/Telemetry.js";
 export * from "./plugins/thumbnails/Thumbnails.js";
-export * from "./plugins/source-controller/SourceController.js";
 export * from "./plugins/volume-fade/VolumeFade.js";
 //# sourceMappingURL=index.plugins.d.ts.map

package/lib/index.plugins.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.plugins.d.ts","sourceRoot":"","sources":["../src/index.plugins.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC;AAEnC,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,qCAAqC,CAAC;AACpD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,0BAA0B,CAAC;AACzC,cAAc,uCAAuC,CAAC;AACtD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,8BAA8B,CAAC;AAE7C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yBAAyB,CAAC;AACxC,cAAc,2CAA2C,CAAC;AAC1D,cAAc,wBAAwB,CAAC;AACvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,kDAAkD,CAAC;AACjE,cAAc,yCAAyC,CAAC;AACxD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sDAAsD,CAAC;AACrE,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,oCAAoC,CAAC;AACnD,cAAc,iDAAiD,CAAC;AAGhE,cAAc,qCAAqC,CAAC"}
+{"version":3,"file":"index.plugins.d.ts","sourceRoot":"","sources":["../src/index.plugins.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC;AAEnC,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,qCAAqC,CAAC;AACpD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,0BAA0B,CAAC;AACzC,cAAc,uCAAuC,CAAC;AACtD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,8BAA8B,CAAC;AAE7C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yBAAyB,CAAC;AACxC,cAAc,2CAA2C,CAAC;AAC1D,cAAc,wBAAwB,CAAC;AACvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,kDAAkD,CAAC;AACjE,cAAc,yCAAyC,CAAC;AACxD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sDAAsD,CAAC;AACrE,cAAc,iDAAiD,CAAC;AAChE,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AACjD,cAAc,oCAAoC,CAAC;AAGnD,cAAc,qCAAqC,CAAC"}

package/lib/index.plugins.js

@@ -25,10 +25,10 @@ export * from "./plugins/seek-time/SeekTime.js";
 export * from "./plugins/share/Share.js";
 export * from "./plugins/skip-time/SkipTime.js";
 export * from "./plugins/spinner-three-bounce/SpinnerThreeBounce.js";
-export * from "./plugins/statistics/Statistics.js";
+export * from "./plugins/source-controller/SourceController.js";
 export * from "./plugins/subtitles/Subtitles.js";
+export * from "./plugins/telemetry/Telemetry.js";
 export * from "./plugins/thumbnails/Thumbnails.js";
-export * from "./plugins/source-controller/SourceController.js";
 // _ vast-ads
 // _ video360
 export * from "./plugins/volume-fade/VolumeFade.js";

package/lib/playback/hls-playback/HlsPlayback.js

@@ -581,9 +581,9 @@ export default class HlsPlayback extends HTML5Video {
     }
     play() {
         !this._hls && this._setup();
-        assert.ok(this._hls, 'Hls.js instance is not available');
         !this._manifestParsed &&
             !this.options.hlsPlayback.preload &&
+            // @ts-expect-error
             this._hls.loadSource(this.options.src);
         super.play();
         this._startTimeUpdateTimer();

package/lib/plugins/bottom-gear/BottomGear.d.ts

@@ -2,7 +2,13 @@ import { UICorePlugin } from '@clappr/core';
 import '../../../assets/bottom-gear/gear.scss';
 import '../../../assets/bottom-gear/gear-sub-menu.scss';
 import { ZeptoResult } from '../../utils/types.js';
-export declare enum Events {
+/**
+ * Custom events emitted by the plugin
+ */
+export declare enum GearEvents {
+    /**
+     * Emitted when the gear menu is rendered
+     */
     MEDIACONTROL_GEAR_RENDERED = "mediacontrol:gear:rendered"
 }
 /**
@@ -15,6 +21,10 @@ export type GearItemElement = 'quality' | 'rate' | 'nerd';
  * @beta
  * @remarks
  * The plugins provides a base for attaching custom settings UI in the gear menu
+ *
+ * Depends on:
+ *
+ * - {@link MediaControl | media_control}
  */
 export declare class BottomGear extends UICorePlugin {
     private isHd;
@@ -50,7 +60,16 @@ export declare class BottomGear extends UICorePlugin {
      * @internal
      */
     bindEvents(): void;
+    /**
+     * @param name - Name of a gear menu placeholder item to attach custom UI
+     * @returns Zepto result of the element
+     */
     getElement(name: GearItemElement): ZeptoResult | null;
+    /**
+     * Replaces the content of the gear menu
+     * @param content - Zepto result of the element
+     */
+    setContent(content: ZeptoResult): void;
     private onActiveContainerChanged;
     private bindContainerEvents;
     private highDefinitionUpdate;

package/lib/plugins/bottom-gear/BottomGear.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BottomGear.d.ts","sourceRoot":"","sources":["../../../src/plugins/bottom-gear/BottomGear.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoC,MAAM,cAAc,CAAC;AAO9E,OAAO,uCAAuC,CAAC;AAC/C,OAAO,gDAAgD,CAAC;AAGxD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAMnD,oBAAY,MAAM;IAChB,0BAA0B,+BAA+B;CAC1D;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1D;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,YAAY;IAC1C,OAAO,CAAC,IAAI,CAAS;IAErB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEvD;;OAEG;IACH,IAAa,UAAU;;;MAKtB;IAED;;OAEG;IACH,IAAa,MAAM;;MAIlB;IAED;;OAEG;IACM,UAAU;IAUnB,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI;IAIrD,OAAO,CAAC,wBAAwB;IAKhC,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,oBAAoB;IAU5B;;OAEG;IACM,MAAM;IAmBf,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,IAAI;CAGb"}
+{"version":3,"file":"BottomGear.d.ts","sourceRoot":"","sources":["../../../src/plugins/bottom-gear/BottomGear.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoC,MAAM,cAAc,CAAC;AAO9E,OAAO,uCAAuC,CAAC;AAC/C,OAAO,gDAAgD,CAAC;AAGxD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAMnD;;GAEG;AACH,oBAAY,UAAU;IACpB;;OAEG;IACH,0BAA0B,+BAA+B;CAC1D;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1D;;;;;;;;;GASG;AACH,qBAAa,UAAW,SAAQ,YAAY;IAC1C,OAAO,CAAC,IAAI,CAAS;IAErB;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEvD;;OAEG;IACH,IAAa,UAAU;;;MAKtB;IAED;;OAEG;IACH,IAAa,MAAM;;MAIlB;IAED;;OAEG;IACM,UAAU;IAUnB;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI;IAIrD;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW;IAI/B,OAAO,CAAC,wBAAwB;IAKhC,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,oBAAoB;IAU5B;;OAEG;IACM,MAAM;IAmBf,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,IAAI;CAGb"}