@gcorevideo/player 2.22.16 → 2.22.17

package/docs/api/player.clapprstats.exportmetrics.md

@@ -18,5 +18,5 @@ exportMetrics(): Metrics;
 
 Metrics
 
-Currently collected metrics
+Measurements collected so far
 

package/docs/api/player.clapprstats.md

@@ -7,7 +7,7 @@
 > 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.
 > 
 
-`PLUGIN` that collects useful statistics about playback performance.
+`PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.
 
 **Signature:**
 
@@ -20,6 +20,10 @@ export declare class ClapprStats extends ContainerPlugin
 
 This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.
 
+Configuration options - [ClapprStatsSettings](./player.clapprstatssettings.md)
+
+Events - 
+
 ## Constructors
 
 <table><thead><tr><th>
@@ -85,19 +89,5 @@ Description
 **_(BETA)_** Returns the collected metrics.
 
 
-</td></tr>
-<tr><td>
-
-[setUpdateMetrics(updateMetricsFn)](./player.clapprstats.setupdatemetrics.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Registers a callback to receive the metrics.
-
-
 </td></tr>
 </tbody></table>

package/docs/api/player.clapprstatssettings.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; [ClapprStatsSettings](./player.clapprstatssettings.md)
+
+## ClapprStatsSettings type
+
+**Signature:**
+
+```typescript
+export type ClapprStatsSettings = {
+    runEach?: number;
+};
+```

package/docs/api/player.clips.destroy.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Clips](./player.clips.md) &gt; [destroy](./player.clips.destroy.md)
+
+## Clips.destroy() 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
+destroy(): import("@clappr/core").UIObject;
+```
+**Returns:**
+
+import("@clappr/core").UIObject
+

package/docs/api/player.clips.disable.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Clips](./player.clips.md) &gt; [disable](./player.clips.disable.md)
+
+## Clips.disable() 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
+disable(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.clips.enable.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Clips](./player.clips.md) &gt; [enable](./player.clips.enable.md)
+
+## Clips.enable() 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
+enable(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.clips.md

@@ -0,0 +1,170 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Clips](./player.clips.md)
+
+## Clips 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.
+> 
+
+`PLUGIN` that allows marking up the timeline of the video
+
+**Signature:**
+
+```typescript
+export declare class Clips extends UICorePlugin 
+```
+**Extends:** UICorePlugin
+
+## Remarks
+
+The plugin decorates the seekbar with notches to indicate the clips of the video and displays current clip text in the left panel
+
+Depends on:
+
+- [MediaControl](./player.mediacontrol.md)
+
+Configuration options - [ClipsPluginSettings](./player.clipspluginsettings.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[supportedVersion](./player.clips.supportedversion.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+{ min: string; }
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[version](./player.clips.version.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>
+
+[destroy()](./player.clips.destroy.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[disable()](./player.clips.disable.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[enable()](./player.clips.enable.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[render()](./player.clips.render.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Clips](./player.clips.md) &gt; [render](./player.clips.render.md)
+
+## Clips.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
+render(): this;
+```
+**Returns:**
+
+this
+

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

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Clips](./player.clips.md) &gt; [supportedVersion](./player.clips.supportedversion.md)
+
+## Clips.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
+get supportedVersion(): {
+        min: string;
+    };
+```

package/docs/api/player.clips.version.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Clips](./player.clips.md) &gt; [version](./player.clips.version.md)
+
+## Clips.version 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
+get version(): string;
+```

package/docs/api/player.clipspluginsettings.md

@@ -7,7 +7,7 @@
 > 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.
 > 
 
-Configuration options for the [clips](./player.clipsplugin.md) plugin.
+Configuration options for the  plugin.
 
 **Signature:**
 
@@ -53,7 +53,7 @@ string
 
 </td><td>
 
-**_(BETA)_** The text to display over the seekbar.
+**_(BETA)_** The compiled text of the clips description, one clip per line in format : `HH:MM:SS text` or `MM:SS text` or `SS text`
 
 
 </td></tr>

package/docs/api/player.clipspluginsettings.text.md

@@ -7,7 +7,7 @@
 > 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 text to display over the seekbar.
+The compiled text of the clips description, one clip per line in format : `HH:MM:SS text` or `MM:SS text` or `SS text`
 
 **Signature:**
 

package/docs/api/player.md

@@ -75,17 +75,6 @@ Description
 **_(BETA)_** `PLUGIN` that adds a button to extend the media controls UI with extra options.
 
 
-</td></tr>
-<tr><td>
-
-[ClapprNerdStats](./player.clapprnerdstats.md)
-
-
-</td><td>
-
-**_(BETA)_** `PLUGIN` that displays useful network-related statistics.
-
-
 </td></tr>
 <tr><td>
 
@@ -94,7 +83,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that collects useful statistics about playback performance.
+**_(BETA)_** `PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.
 
 
 </td></tr>
@@ -111,12 +100,12 @@ Description
 </td></tr>
 <tr><td>
 
-[ClipsPlugin](./player.clipsplugin.md)
+[Clips](./player.clips.md)
 
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that shows text over the seekbar to indicate the current clip.
+**_(BETA)_** `PLUGIN` that allows marking up the timeline of the video
 
 
 </td></tr>
@@ -218,6 +207,17 @@ Description
 **_(BETA)_** `PLUGIN` that adds support for loading multiple streams and switching between them using the media control UI.
 
 
+</td></tr>
+<tr><td>
+
+[NerdStats](./player.nerdstats.md)
+
+
+</td><td>
+
+**_(BETA)_** `PLUGIN` that displays useful network-related statistics.
+
+
 </td></tr>
 <tr><td>
 
@@ -491,7 +491,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Configuration options for the [clips](./player.clipsplugin.md) plugin.
+**_(BETA)_** Configuration options for the  plugin.
 
 
 </td></tr>
@@ -568,7 +568,7 @@ Describes a media source with its MIME type and URL.
 
 </td><td>
 
-A level of quality within a media source.
+A level of quality within a media source/representation.
 
 
 </td></tr>
@@ -655,6 +655,15 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[ClapprStatsSettings](./player.clapprstatssettings.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
 [ClosedCaptionsPluginSettings](./player.closedcaptionspluginsettings.md)
 
 
@@ -995,7 +1004,7 @@ A media source to fetch the media data from
 
 </td><td>
 
-**_(BETA)_** For the plugin development
+**_(BETA)_** Time progress information indicated by Clappr CONTAINER\_PROGRESS and PLAYBACK\_PROGRESS events.
 
 
 </td></tr>
@@ -1017,7 +1026,7 @@ A media source to fetch the media data from
 
 </td><td>
 
-Playback time in seconds since the beginning of the stream (or a segment for the live streams)
+Playback time position in seconds since the beginning of the stream. For the live streams this is limited to the length of a segment. When DVR is enabled, this refers to the
 
 
 </td></tr>

package/docs/api/player.mediacontrol.md

@@ -226,7 +226,7 @@ Description
 </td></tr>
 <tr><td>
 
-[getElement(name)](./player.mediacontrol.getelement.md)
+[mount(name, element)](./player.mediacontrol.mount.md)
 
 
 </td><td>

package/docs/api/{player.mediacontrol.getelement.md → player.mediacontrol.mount.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; [MediaControl](./player.mediacontrol.md) &gt; [getElement](./player.mediacontrol.getelement.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [mount](./player.mediacontrol.mount.md)
 
-## MediaControl.getElement() method
+## MediaControl.mount() 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.
 > 
@@ -17,7 +17,7 @@ Get a media control element DOM node
 **Signature:**
 
 ```typescript
-getElement(name: MediaControlElement): ZeptoResult | null;
+mount(name: MediaControlElement, element: ZeptoResult): void;
 ```
 
 ## Parameters
@@ -53,11 +53,25 @@ name
 The name of the media control element
 
 
+</td></tr>
+<tr><td>
+
+element
+
+
+</td><td>
+
+[ZeptoResult](./player.zeptoresult.md)
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 **Returns:**
 
-[ZeptoResult](./player.zeptoresult.md) \| null
+void
 
 The DOM node to render to or extend
 
@@ -71,9 +85,8 @@ Use this method to render custom media control UI in a plugin
 ```ts
 class MyPlugin extends UICorePlugin {
   override render() {
-    const mediaControl = this.core.getPlugin('media_control')
-    const clipText = mediaControl.getElement('clipText')
-    clipText?.el.text('Here we go')
+    this.$el.html('<div data-clips>Here we go</div>')
+    this.core.getPlugin('media_control').mount('clips', this.$el)
     return this
   }
 }

package/docs/api/player.mediacontrolleftelement.md

@@ -12,5 +12,5 @@ Media control elements that appear in the left area.
 **Signature:**
 
 ```typescript
-export type MediaControlLeftElement = 'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume';
+export type MediaControlLeftElement = 'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume' | 'clips';
 ```

package/docs/api/{player.clapprnerdstats._constructor_.md → player.nerdstats._constructor_.md}

@@ -1,13 +1,13 @@
 <!-- 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; [(constructor)](./player.clapprnerdstats._constructor_.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [NerdStats](./player.nerdstats.md) &gt; [(constructor)](./player.nerdstats._constructor_.md)
 
-## ClapprNerdStats.(constructor)
+## NerdStats.(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 `ClapprNerdStats` class
+Constructs a new instance of the `NerdStats` class
 
 **Signature:**
 

package/docs/api/{player.clapprnerdstats.md → player.nerdstats.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; [ClapprNerdStats](./player.clapprnerdstats.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [NerdStats](./player.nerdstats.md)
 
-## ClapprNerdStats class
+## NerdStats 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.
 > 
@@ -12,7 +12,7 @@
 **Signature:**
 
 ```typescript
-export declare class ClapprNerdStats extends UICorePlugin 
+export declare class NerdStats extends UICorePlugin 
 ```
 **Extends:** UICorePlugin
 
@@ -48,7 +48,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)(core)](./player.clapprnerdstats._constructor_.md)
+[(constructor)(core)](./player.nerdstats._constructor_.md)
 
 
 </td><td>
@@ -56,7 +56,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Constructs a new instance of the `ClapprNerdStats` class
+**_(BETA)_** Constructs a new instance of the `NerdStats` class
 
 
 </td></tr>

package/docs/api/player.qualitylevel.height.md

@@ -4,7 +4,7 @@
 
 ## QualityLevel.height property
 
-Height of the video, pixels.
+Height of the video frame, pixels.
 
 **Signature:**
 

package/docs/api/player.qualitylevel.level.md

@@ -4,7 +4,7 @@
 
 ## QualityLevel.level property
 
-Zero-based index of the quality level.
+Zero-based index of the quality level. Quality levels go from low to high
 
 **Signature:**
 

package/docs/api/player.qualitylevel.md

@@ -4,7 +4,7 @@
 
 ## QualityLevel interface
 
-A level of quality within a media source.
+A level of quality within a media source/representation.
 
 **Signature:**
 
@@ -69,7 +69,7 @@ number
 
 </td><td>
 
-Height of the video, pixels.
+Height of the video frame, pixels.
 
 
 </td></tr>
@@ -88,7 +88,7 @@ number
 
 </td><td>
 
-Zero-based index of the quality level.
+Zero-based index of the quality level. Quality levels go from low to high
 
 
 </td></tr>
@@ -107,7 +107,7 @@ number
 
 </td><td>
 
-Width of the video, pixels.
+Width of the video frame, pixels.
 
 
 </td></tr>

package/docs/api/player.qualitylevel.width.md

@@ -4,7 +4,7 @@
 
 ## QualityLevel.width property
 
-Width of the video, pixels.
+Width of the video frame, pixels.
 
 **Signature:**
 

package/docs/api/player.timeposition.current.md

@@ -4,7 +4,7 @@
 
 ## TimePosition.current property
 
-Current playback time, 0..duration, seconds.
+Current playback time, 0..duration
 
 **Signature:**