@gcorevideo/player 2.22.15 → 2.22.16

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

package/docs/api/player.md

@@ -45,7 +45,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[AudioSelector](./player.audioselector.md)
+[AudioTracks](./player.audiotracks.md)
 
 
 </td><td>
@@ -185,17 +185,6 @@ Description
 **_(BETA)_** `PLUGIN` that integrates with Google Analytics
 
 
-</td></tr>
-<tr><td>
-
-[LevelSelector](./player.levelselector.md)
-
-
-</td><td>
-
-**_(BETA)_** `PLUGIN` that provides a UI to select the desired quality level of the playback.
-
-
 </td></tr>
 <tr><td>
 
@@ -273,6 +262,17 @@ Description
 **_(BETA)_** `PLUGIN` that displays a poster image in the background and a big play button on top when playback is stopped
 
 
+</td></tr>
+<tr><td>
+
+[QualityLevels](./player.qualitylevels.md)
+
+
+</td><td>
+
+**_(BETA)_** `PLUGIN` that provides a UI to select the desired quality level of the playback.
+
+
 </td></tr>
 <tr><td>
 
@@ -530,56 +530,56 @@ Description
 </td></tr>
 <tr><td>
 
-[LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md)
+[PlaybackError](./player.playbackerror.md)
 
 
 </td><td>
 
-**_(BETA)_** Configuration options for the [level selector](./player.levelselector.md) plugin.
+An error occurred during the playback.
 
 
 </td></tr>
 <tr><td>
 
-[PlaybackError](./player.playbackerror.md)
+[PlayerConfig](./player.playerconfig.md)
 
 
 </td><td>
 
-An error occurred during the playback.
+Configuration options for the player
 
 
 </td></tr>
 <tr><td>
 
-[PlayerConfig](./player.playerconfig.md)
+[PlayerMediaSourceDesc](./player.playermediasourcedesc.md)
 
 
 </td><td>
 
-Configuration options for the player
+Describes a media source with its MIME type and URL.
 
 
 </td></tr>
 <tr><td>
 
-[PlayerMediaSourceDesc](./player.playermediasourcedesc.md)
+[QualityLevel](./player.qualitylevel.md)
 
 
 </td><td>
 
-Describes a media source with its MIME type and URL.
+A level of quality within a media source.
 
 
 </td></tr>
 <tr><td>
 
-[QualityLevel](./player.qualitylevel.md)
+[QualityLevelsPluginSettings](./player.qualitylevelspluginsettings.md)
 
 
 </td><td>
 
-A level of quality within a media source.
+**_(BETA)_** Configuration options for the [QualityLevels](./player.qualitylevels.md) plugin.
 
 
 </td></tr>
@@ -759,7 +759,62 @@ An ISO 639-1 language code.
 
 </td><td>
 
-**_(BETA)_** Media control elements, mount points for additional plugins
+**_(BETA)_** Built-in media control elements.
+
+
+</td></tr>
+<tr><td>
+
+[MediaControlLayerElement](./player.mediacontrollayerelement.md)
+
+
+</td><td>
+
+**_(BETA)_** Media control elements that appear in main layer, spanning the entire width of the player.
+
+
+</td></tr>
+<tr><td>
+
+[MediaControlLeftElement](./player.mediacontrolleftelement.md)
+
+
+</td><td>
+
+**_(BETA)_** Media control elements that appear in the left area.
+
+
+</td></tr>
+<tr><td>
+
+[MediaControlRightElement](./player.mediacontrolrightelement.md)
+
+
+</td><td>
+
+**_(BETA)_** Media control elements that appear in the right area.
+
+
+</td></tr>
+<tr><td>
+
+[MediaControlSettings](./player.mediacontrolsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Specifies the allowed media control elements in each area. Can be used to restrict rendered media control elements.
+
+
+</td></tr>
+<tr><td>
+
+[MenuOption](./player.menuoption.md)
+
+
+</td><td>
+
+**_(BETA)_**
 
 
 </td></tr>

package/docs/api/player.mediacontrol.md

@@ -20,6 +20,14 @@ export declare class MediaControl extends UICorePlugin
 
 The methods exposed are to be used by the other plugins that extend the media control UI.
 
+Configuration options:
+
+- `mediaControl`<!-- -->: [MediaControlSettings](./player.mediacontrolsettings.md) - specifies the allowed media control elements in each area
+
+- `persistConfig`<!-- -->: boolean - `common` option, makes the plugin persist the media control settings
+
+- `chromeless`<!-- -->: boolean
+
 ## Constructors
 
 <table><thead><tr><th>
@@ -229,20 +237,6 @@ Description
 **_(BETA)_** Get a media control element DOM node
 
 
-</td></tr>
-<tr><td>
-
-[handleCustomArea(handler)](./player.mediacontrol.handlecustomarea.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 

package/docs/api/player.mediacontrolelement.md

@@ -7,10 +7,12 @@
 > 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.
 > 
 
-Media control elements, mount points for additional plugins
+Built-in media control elements.
 
 **Signature:**
 
 ```typescript
-export type MediaControlElement = 'audiotracks' | 'cc' | 'clipText' | 'dvr' | 'duration' | 'fullscreen' | 'gear' | 'multicamera' | 'pip' | 'playbackRate' | 'position' | 'seekBarContainer' | 'vr' | 'volume';
+export type MediaControlElement = MediaControlLeftElement | MediaControlLayerElement | MediaControlRightElement;
 ```
+**References:** [MediaControlLeftElement](./player.mediacontrolleftelement.md)<!-- -->, [MediaControlLayerElement](./player.mediacontrollayerelement.md)<!-- -->, [MediaControlRightElement](./player.mediacontrolrightelement.md)
+

package/docs/api/{player.contextmenupluginsettings.preventshowcontextmenu.md → player.mediacontrollayerelement.md}

@@ -1,14 +1,16 @@
 <!-- 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; [MediaControlLayerElement](./player.mediacontrollayerelement.md)
 
-## ContextMenuPluginSettings.preventShowContextMenu property
+## MediaControlLayerElement type
 
 > 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.
 > 
 
+Media control elements that appear in main layer, spanning the entire width of the player.
+
 **Signature:**
 
 ```typescript
-preventShowContextMenu?: boolean;
+export type MediaControlLayerElement = 'seekbar' | 'seekBarContainer';
 ```

package/docs/api/player.mediacontrolleftelement.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; [MediaControlLeftElement](./player.mediacontrolleftelement.md)
+
+## MediaControlLeftElement type
+
+> 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.
+> 
+
+Media control elements that appear in the left area.
+
+**Signature:**
+
+```typescript
+export type MediaControlLeftElement = 'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume';
+```

package/docs/api/player.mediacontrolrightelement.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; [MediaControlRightElement](./player.mediacontrolrightelement.md)
+
+## MediaControlRightElement type
+
+> 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.
+> 
+
+Media control elements that appear in the right area.
+
+**Signature:**
+
+```typescript
+export type MediaControlRightElement = 'audiotracks' | 'cc' | 'fullscreen' | 'hd-indicator' | 'gear' | 'multicamera' | 'pip' | 'vr';
+```

package/docs/api/player.mediacontrolsettings.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControlSettings](./player.mediacontrolsettings.md)
+
+## MediaControlSettings type
+
+> 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.
+> 
+
+Specifies the allowed media control elements in each area. Can be used to restrict rendered media control elements.
+
+**Signature:**
+
+```typescript
+export type MediaControlSettings = {
+    left: MediaControlLeftElement[];
+    right: MediaControlRightElement[];
+    default: MediaControlLayerElement[];
+    seekEnabled: boolean;
+};
+```
+**References:** [MediaControlLeftElement](./player.mediacontrolleftelement.md)<!-- -->, [MediaControlRightElement](./player.mediacontrolrightelement.md)<!-- -->, [MediaControlLayerElement](./player.mediacontrollayerelement.md)
+

package/docs/api/{player.contextmenupluginsettings.url.md → player.menuoption.md}

@@ -1,14 +1,21 @@
 <!-- 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; [MenuOption](./player.menuoption.md)
 
-## ContextMenuPluginSettings.url property
+## MenuOption type
 
 > 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
-url?: string;
+export type MenuOption = {
+    label?: string;
+    labelKey?: string;
+    name: string;
+    handler?: () => void;
+    icon?: string;
+};
 ```

package/docs/api/player.playbackrate.md

@@ -41,7 +41,7 @@ const player = new Player({
       { value: 1, label: '1x' },
     ],
     defaultValue: 1,
-  } as PlaybackRateSettings,
+  },
 })
 ```
 

package/docs/api/player.playerconfig.md

@@ -199,7 +199,7 @@ _(Optional)_ Mute the audio output in order to comply with browsers' autoplay po
 
 </td><td>
 
-_(Optional)_ The type of playback (live stream or video on demand).
+_(Optional)_ Stream type.  Should only be set if known in advance, as it should not change once determined. Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.
 
 
 </td></tr>

package/docs/api/player.playerconfig.playbacktype.md

@@ -4,7 +4,7 @@
 
 ## PlayerConfig.playbackType property
 
-The type of playback (live stream or video on demand).
+Stream type.  Should only be set if known in advance, as it should not change once determined. Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.
 
 **Signature:**
 

package/docs/api/{player.levelselector.events.md → player.qualitylevels.events.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; [LevelSelector](./player.levelselector.md) &gt; [events](./player.levelselector.events.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [QualityLevels](./player.qualitylevels.md) &gt; [events](./player.qualitylevels.events.md)
 
-## LevelSelector.events property
+## QualityLevels.events 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.
 > 

package/docs/api/{player.levelselector.md → player.qualitylevels.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; [LevelSelector](./player.levelselector.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [QualityLevels](./player.qualitylevels.md)
 
-## LevelSelector class
+## QualityLevels 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 LevelSelector extends UICorePlugin 
+export declare class QualityLevels extends UICorePlugin 
 ```
 **Extends:** UICorePlugin
 
@@ -26,14 +26,14 @@ Depends on:
 
 The plugin is rendered as an item in the gear menu, which, when clicked, shows a list of quality levels to choose from.
 
-Configuration options - [LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md)
+Configuration options - [QualityLevelsPluginSettings](./player.qualitylevelspluginsettings.md)
 
 ## Example
 
 
 ```ts
 new Player({
-  levelSelector: {
+  qualityLevels: {
     restrictResolution: 360,
     labels: { 360: 'SD', 720: 'HD' },
   },
@@ -65,7 +65,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[events](./player.levelselector.events.md)
+[events](./player.qualitylevels.events.md)
 
 
 </td><td>

package/docs/api/{player.levelselectorpluginsettings.labels.md → player.qualitylevelspluginsettings.labels.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; [LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md) &gt; [labels](./player.levelselectorpluginsettings.labels.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [QualityLevelsPluginSettings](./player.qualitylevelspluginsettings.md) &gt; [labels](./player.qualitylevelspluginsettings.labels.md)
 
-## LevelSelectorPluginSettings.labels property
+## QualityLevelsPluginSettings.labels 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.
 > 

package/docs/api/{player.levelselectorpluginsettings.md → player.qualitylevelspluginsettings.md}

@@ -1,18 +1,18 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [QualityLevelsPluginSettings](./player.qualitylevelspluginsettings.md)
 
-## LevelSelectorPluginSettings interface
+## QualityLevelsPluginSettings interface
 
 > 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 [level selector](./player.levelselector.md) plugin.
+Configuration options for the [QualityLevels](./player.qualitylevels.md) plugin.
 
 **Signature:**
 
 ```typescript
-export interface LevelSelectorPluginSettings 
+export interface QualityLevelsPluginSettings 
 ```
 
 ## Properties
@@ -40,7 +40,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[labels?](./player.levelselectorpluginsettings.labels.md)
+[labels?](./player.qualitylevelspluginsettings.labels.md)
 
 
 </td><td>
@@ -59,7 +59,7 @@ Record&lt;number, string&gt;
 </td></tr>
 <tr><td>
 
-[restrictResolution?](./player.levelselectorpluginsettings.restrictresolution.md)
+[restrictResolution?](./player.qualitylevelspluginsettings.restrictresolution.md)
 
 
 </td><td>

package/docs/api/{player.levelselectorpluginsettings.restrictresolution.md → player.qualitylevelspluginsettings.restrictresolution.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; [LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md) &gt; [restrictResolution](./player.levelselectorpluginsettings.restrictresolution.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [QualityLevelsPluginSettings](./player.qualitylevelspluginsettings.md) &gt; [restrictResolution](./player.qualitylevelspluginsettings.restrictresolution.md)
 
-## LevelSelectorPluginSettings.restrictResolution property
+## QualityLevelsPluginSettings.restrictResolution 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.
 > 

package/lib/plugins/clips/Clips.d.ts

@@ -1,31 +1,34 @@
 import { UICorePlugin } from '@clappr/core';
 import '../../../assets/clips/clips.scss';
 /**
- * Configuration options for the {@link ClipsPlugin | clips} plugin.
+ * Configuration options for the {@link ClipsPlugin} plugin.
  * @beta
  */
 export interface ClipsPluginSettings {
     /**
-     * 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`
      */
     text: string;
 }
 /**
- * `PLUGIN` that shows text over the seekbar to indicate the current clip.
+ * `PLUGIN` that allows marking up the timeline of the video
  * @beta
  * @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:
  *
  * - {@link MediaControl}
  *
  * Configuration options - {@link ClipsPluginSettings}
  */
-export declare class ClipsPlugin extends UICorePlugin {
+export declare class Clips extends UICorePlugin {
+    private barStyle;
     private clips;
-    private duration;
-    private durationGetting;
-    private _oldContainer;
+    private oldContainer;
     private svgMask;
+    private static readonly template;
     /**
      * @internal
      */
@@ -36,22 +39,24 @@ export declare class ClipsPlugin extends UICorePlugin {
     get attributes(): {
         class: string;
     };
+    get version(): string;
+    get supportedVersion(): {
+        min: string;
+    };
     /**
      * @internal
      */
     bindEvents(): void;
-    private _onCoreReady;
-    private _onMediaControlContainerChanged;
+    render(): this;
+    destroy(): import("@clappr/core").UIObject;
+    disable(): void;
+    enable(): void;
+    private onCoreReady;
+    private onMcRender;
+    private onContainerChanged;
     private playerResize;
-    private _bindContainerEvents;
     private onTimeUpdate;
     private parseClips;
-    /**
-     * Returns the text of the current clip.
-     * @param time - The current time of the player.
-     * @returns The text of the current clip.
-     */
-    getText(time: number): string;
     private makeSvg;
     private setSVGMask;
     private setClipText;