@gcorevideo/player 2.22.15 → 2.22.17

package/docs/api/{player.audioselector.md → player.audiotracks.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)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [AudioTracks](./player.audiotracks.md)
 
-## AudioSelector class
+## AudioTracks 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 AudioSelector extends UICorePlugin 
+export declare class AudioTracks extends UICorePlugin 
 ```
 **Extends:** UICorePlugin
 

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.contextmenupluginsettings.preventshowcontextmenu.md → player.clips.destroy.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; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md) &gt; [preventShowContextMenu](./player.contextmenupluginsettings.preventshowcontextmenu.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Clips](./player.clips.md) &gt; [destroy](./player.clips.destroy.md)
 
-## ContextMenuPluginSettings.preventShowContextMenu property
+## 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.
 > 
@@ -10,5 +10,9 @@
 **Signature:**
 
 ```typescript
-preventShowContextMenu?: boolean;
+destroy(): import("@clappr/core").UIObject;
 ```
+**Returns:**
+
+import("@clappr/core").UIObject
+

package/docs/api/{player.contextmenupluginsettings.label.md → player.clips.disable.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; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md) &gt; [label](./player.contextmenupluginsettings.label.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Clips](./player.clips.md) &gt; [disable](./player.clips.disable.md)
 
-## ContextMenuPluginSettings.label property
+## 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.
 > 
@@ -10,5 +10,9 @@
 **Signature:**
 
 ```typescript
-label?: string;
+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.contextmenu.md

@@ -20,6 +20,8 @@ export declare class ContextMenu extends UIContainerPlugin
 
 Configuration options - [ContextMenuPluginSettings](./player.contextmenupluginsettings.md)
 
+Should not be used together with [ClickToPause](./player.clicktopause.md) plugin
+
 ## Constructors
 
 <table><thead><tr><th>

package/docs/api/player.contextmenupluginsettings.md

@@ -40,7 +40,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[label?](./player.contextmenupluginsettings.label.md)
+[options?](./player.contextmenupluginsettings.options.md)
 
 
 </td><td>
@@ -48,45 +48,7 @@ Description
 
 </td><td>
 
-string
-
-
-</td><td>
-
-**_(BETA)_** _(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[preventShowContextMenu?](./player.contextmenupluginsettings.preventshowcontextmenu.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(BETA)_** _(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[url?](./player.contextmenupluginsettings.url.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
+[MenuOption](./player.menuoption.md)<!-- -->\[\]
 
 
 </td><td>

package/docs/api/{player.contextmenupluginsettings.url.md → player.contextmenupluginsettings.options.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; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md) &gt; [url](./player.contextmenupluginsettings.url.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md) &gt; [options](./player.contextmenupluginsettings.options.md)
 
-## ContextMenuPluginSettings.url property
+## ContextMenuPluginSettings.options 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
-url?: string;
+options?: MenuOption[];
 ```