@gcorevideo/player 2.20.11 → 2.20.13

package/dist/plugins/index.js

@@ -33094,17 +33094,10 @@ function orderByOrderPattern(arr, order) {
     return [...ordered, ...rest];
 }
 /**
- * `PLUGIN` that provides a foundation for developing custom media controls UI.
+ * `PLUGIN` that provides basic playback controls UI and a foundation for developing custom UI.
  * @beta
  * @remarks
  * The methods exposed are to be used by the other plugins that extend the media control UI.
- * The plugin registration should be arranged so that MediaControl is initialized before every other `PLUGIN` that depends on it.
- * @example
- * ```ts
- * Player.registerPlugin(MediaControl) // <--- This must go first
- * Player.registerPlugin(LevelSelector) // a media control plugin
- * Player.registerPlugin(NerdStats) // another media control plugin
- * ```
  */
 class MediaControl extends UICorePlugin {
     advertisementPlaying = false;
@@ -34034,7 +34027,6 @@ class MediaControl extends UICorePlugin {
         return super.destroy();
     }
     configure() {
-        // this.advertisementPlaying ? this.disable() : this.enable()
         this.trigger(Events$1.MEDIACONTROL_OPTIONS_CHANGE);
     }
     /**
@@ -37257,7 +37249,7 @@ class ClipsPlugin extends UICorePlugin {
 
 const templateHtml$1 = "<ul class=\"context-menu-list\">\n    <% if(options) { %>\n        <% for (var i = 0; i < options.length; i++) { %>\n        <li class=\"context-menu-list-item <%= options[i].class %>\"\n            data-<%= options[i].name %>><%= options[i].label %></li>\n        <% } %>\n    <% } %>\n</ul>\n";
 
-var version$1 = "2.20.11";
+var version$1 = "2.20.13";
 
 var packages = {
 	"node_modules/@clappr/core": {
@@ -37617,7 +37609,6 @@ class ErrorScreen extends UICorePlugin {
             ...this.err,
             reloadIcon: this.options.errorScreen?.noReload ? null : reloadIcon,
         }));
-        // TODO append to container instead of core?
         if (!this.el.parentElement) {
             this.core.$el.append(this.el);
         }
@@ -37627,26 +37618,32 @@ class ErrorScreen extends UICorePlugin {
 
 const FAVICON_COLOR = '#567';
 const FAVICON_SELECTOR = 'link[rel="shortcut icon"]';
-// const oldIcon = $(FAVICON_SELECTOR);
 /**
- * `PLUGIN` that adds custom favicon to the player's tab.
+ * `PLUGIN` that changes the favicon according to the player's state.
  * @beta
+ * @remarks
+ * There are three states: stopped, playing and paused.
  */
 class Favicon extends CorePlugin {
-    _container = null;
     oldIcon;
     playIcon = null;
     pauseIcon = null;
     stopIcon = null;
+    /**
+     * @internal
+     */
     get name() {
         return 'favicon';
     }
+    /**
+     * @internal
+     */
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
-    //   get oldIcon() {
-    //     return oldIcon;
-    //   }
+    /**
+     * @internal
+     */
     constructor(core) {
         super(core);
         this.oldIcon = $(FAVICON_SELECTOR);
@@ -37654,41 +37651,31 @@ class Favicon extends CorePlugin {
             this.stopIcon = this.createIcon(stopIcon);
             this.changeIcon(this.stopIcon);
         }
-        this.configure();
-    }
-    configure() {
-        if (this.core.options.changeFavicon) {
-            if (!this.enabled) {
-                // @ts-ignore
-                this.stopListening(this.core, Events$1.CORE_OPTIONS_CHANGE);
-                this.enable();
-            }
-        }
-        else if (this.enabled) {
-            this.disable();
-            this.listenTo(this.core, Events$1.CORE_OPTIONS_CHANGE, this.configure);
-        }
     }
+    /**
+     * @internal
+     */
     bindEvents() {
-        this.listenTo(this.core, Events$1.CORE_OPTIONS_CHANGE, this.configure);
         this.listenTo(this.core, Events$1.CORE_ACTIVE_CONTAINER_CHANGED, this.containerChanged);
-        this.core.activeContainer && this.containerChanged();
     }
     containerChanged() {
-        // @ts-ignore
-        this._container && this.stopListening(this._container);
-        this._container = this.core.activeContainer;
-        this.listenTo(this._container, Events$1.CONTAINER_PLAY, this.setPlayIcon);
-        this.listenTo(this._container, Events$1.CONTAINER_PAUSE, this.setPauseIcon);
-        this.listenTo(this._container, Events$1.CONTAINER_STOP, this.resetIcon);
-        this.listenTo(this._container, Events$1.CONTAINER_ENDED, this.resetIcon);
-        this.listenTo(this._container, Events$1.CONTAINER_ERROR, this.resetIcon);
+        this.listenTo(this.core.activeContainer, Events$1.CONTAINER_PLAY, this.setPlayIcon);
+        this.listenTo(this.core.activeContainer, Events$1.CONTAINER_PAUSE, this.setPauseIcon);
+        this.listenTo(this.core.activeContainer, Events$1.CONTAINER_STOP, this.resetIcon);
+        this.listenTo(this.core.activeContainer, Events$1.CONTAINER_ENDED, this.resetIcon);
+        this.listenTo(this.core.activeContainer, Events$1.CONTAINER_ERROR, this.resetIcon);
         this.resetIcon();
     }
+    /**
+     * @internal
+     */
     disable() {
         super.disable();
         this.resetIcon();
     }
+    /**
+     * @internal
+     */
     destroy() {
         super.destroy();
         this.resetIcon();
@@ -37719,15 +37706,12 @@ class Favicon extends CorePlugin {
         this.changeIcon(this.pauseIcon);
     }
     resetIcon() {
-        $(FAVICON_SELECTOR).remove();
         const icon = this.oldIcon.length > 0 ? this.oldIcon : this.stopIcon;
         this.changeIcon(icon);
     }
     changeIcon(icon) {
-        if (icon) {
-            $('link[rel="shortcut icon"]').remove();
-            $('head').append(icon);
-        }
+        $('link[rel="shortcut icon"]').remove();
+        $('head').append(icon);
     }
 }
 
@@ -39036,6 +39020,8 @@ const T$5 = 'plugins.poster';
  * @beta
  * @remarks
  * When the playback is stopped, media control UI is disabled.
+ * Note that the poster image, if specified via the player config, will be used to update video element's poster attribute by the
+ * HTML5-video-based playback module.
  *
  * Configuration options:
  *
@@ -39059,6 +39045,7 @@ const T$5 = 'plugins.poster';
  * ```
  */
 class Poster extends UIContainerPlugin {
+    // TODO merge non-poster related functionality into the ClickToPause plugin
     hasFatalError = false;
     hasStartedPlaying = false;
     playRequested = false;
@@ -39209,9 +39196,6 @@ class Poster extends UIContainerPlugin {
                 this.container.playback.play();
             }
         }
-        else {
-            this.container.trigger('container:start');
-        }
         return false;
     }
     shouldHideOnPlay() {
@@ -39932,6 +39916,9 @@ class SourceController extends CorePlugin {
     get supportedVersion() {
         return { min: CLAPPR_VERSION };
     }
+    /**
+     * @internal
+     */
     constructor(core) {
         super(core);
         this.sourcesList = this.core.options.sources;

package/docs/api/player.contextmenupluginsettings.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 plugin adds a context menu to the player.
+Context menu plugin settings
 
 **Signature:**
 

package/docs/api/player.favicon.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 adds custom favicon to the player's tab.
+`PLUGIN` that changes the favicon according to the player's state.
 
 **Signature:**
 
@@ -16,179 +16,9 @@ export declare class Favicon extends CorePlugin
 ```
 **Extends:** CorePlugin
 
-## Constructors
+## Remarks
 
-<table><thead><tr><th>
+There are three states: stopped, playing and paused.
 
-Constructor
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Favicon` class.
 
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(core)](./player.favicon._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Constructs a new instance of the `Favicon` 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.favicon.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.favicon.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: 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.favicon.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[configure()](./player.favicon.configure.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[destroy()](./player.favicon.destroy.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[disable()](./player.favicon.disable.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-</tbody></table>

package/docs/api/{player.favicon.bindevents.md → player.faviconpluginsettings.faviconcolor.md}

@@ -1,18 +1,16 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Favicon](./player.favicon.md) &gt; [bindEvents](./player.favicon.bindevents.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [FaviconPluginSettings](./player.faviconpluginsettings.md) &gt; [faviconColor](./player.faviconpluginsettings.faviconcolor.md)
 
-## Favicon.bindEvents() method
+## FaviconPluginSettings.faviconColor 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.
 > 
 
+CSS color of the favicon.
+
 **Signature:**
 
 ```typescript
-bindEvents(): void;
+faviconColor?: string;
 ```
-**Returns:**
-
-void
-

package/docs/api/{player.favicon._constructor_.md → player.faviconpluginsettings.md}

@@ -1,25 +1,29 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Favicon](./player.favicon.md) &gt; [(constructor)](./player.favicon._constructor_.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [FaviconPluginSettings](./player.faviconpluginsettings.md)
 
-## Favicon.(constructor)
+## FaviconPluginSettings 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.
 > 
 
-Constructs a new instance of the `Favicon` class
 
 **Signature:**
 
 ```typescript
-constructor(core: Core);
+export interface FaviconPluginSettings 
 ```
 
-## Parameters
+## Properties
 
 <table><thead><tr><th>
 
-Parameter
+Property
+
+
+</th><th>
+
+Modifiers
 
 
 </th><th>
@@ -35,16 +39,21 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-core
+[faviconColor?](./player.faviconpluginsettings.faviconcolor.md)
 
 
 </td><td>
 
-Core
+
+</td><td>
+
+string
 
 
 </td><td>
 
+**_(BETA)_** _(Optional)_ CSS color of the favicon.
+
 
 </td></tr>
 </tbody></table>

package/docs/api/player.md

@@ -8,7 +8,7 @@ Video player for the Gcore streaming platform
 
 ## Remarks
 
-This package provides a video player for the Gcore streaming platform. It is built on top of the Clappr library and provides a framework for building custom integrations. Start with [Player](./player.player.md) for more information.
+This package provides a video player for the Gcore streaming platform. It is built on top of the [Clappr](https://github.com/clappr/clappr) library and provides a framework for building custom integrations. Start with [Player](./player.player.md) for more information.
 
 Various plugins (marked with `PLUGIN` keyword) are available to extend the player with additional features.
 
@@ -160,7 +160,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that adds custom favicon to the player's tab.
+**_(BETA)_** `PLUGIN` that changes the favicon according to the player's state.
 
 
 </td></tr>
@@ -204,7 +204,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that provides a foundation for developing custom media controls UI.
+**_(BETA)_** `PLUGIN` that provides basic playback controls UI and a foundation for developing custom UI.
 
 
 </td></tr>
@@ -502,7 +502,18 @@ Description
 
 </td><td>
 
-**_(BETA)_** The plugin adds a context menu to the player.
+**_(BETA)_** Context menu plugin settings
+
+
+</td></tr>
+<tr><td>
+
+[FaviconPluginSettings](./player.faviconpluginsettings.md)
+
+
+</td><td>
+
+**_(BETA)_**
 
 
 </td></tr>

package/docs/api/{player.favicon.disable.md → player.mediacontrol.getcenterpanel.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; [Favicon](./player.favicon.md) &gt; [disable](./player.favicon.disable.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [getCenterPanel](./player.mediacontrol.getcenterpanel.md)
 
-## Favicon.disable() method
+## MediaControl.getCenterPanel() 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,9 +10,9 @@
 **Signature:**
 
 ```typescript
-disable(): void;
+getCenterPanel(): any;
 ```
 **Returns:**
 
-void
+any
 

package/docs/api/{player.favicon.configure.md → player.mediacontrol.getleftpanel.md}

@@ -1,18 +1,22 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Favicon](./player.favicon.md) &gt; [configure](./player.favicon.configure.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [getLeftPanel](./player.mediacontrol.getleftpanel.md)
 
-## Favicon.configure() method
+## MediaControl.getLeftPanel() 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.
 > 
 
+Get the left panel area to append custom elements to
+
 **Signature:**
 
 ```typescript
-configure(): void;
+getLeftPanel(): any;
 ```
 **Returns:**
 
-void
+any
+
+ZeptoSelector of the left panel element
 

package/docs/api/player.mediacontrol.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 provides a foundation for developing custom media controls UI.
+`PLUGIN` that provides basic playback controls UI and a foundation for developing custom UI.
 
 **Signature:**
 
@@ -18,16 +18,7 @@ export declare class MediaControl extends UICorePlugin
 
 ## Remarks
 
-The methods exposed are to be used by the other plugins that extend the media control UI. The plugin registration should be arranged so that MediaControl is initialized before every other `PLUGIN` that depends on it.
-
-## Example
-
-
-```ts
-Player.registerPlugin(MediaControl) // <--- This must go first
-Player.registerPlugin(LevelSelector) // a media control plugin
-Player.registerPlugin(NerdStats) // another media control plugin
-```
+The methods exposed are to be used by the other plugins that extend the media control UI.
 
 ## Constructors
 
@@ -224,6 +215,20 @@ Description
 **_(BETA)_** Enable the user interaction disabled earlier
 
 
+</td></tr>
+<tr><td>
+
+[getCenterPanel()](./player.mediacontrol.getcenterpanel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
 </td></tr>
 <tr><td>
 
@@ -238,6 +243,20 @@ Description
 **_(BETA)_** Get a media control element DOM node
 
 
+</td></tr>
+<tr><td>
+
+[getLeftPanel()](./player.mediacontrol.getleftpanel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Get the left panel area to append custom elements to
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/player.playbackerror.md

@@ -126,7 +126,7 @@ string
 
 </td><td>
 
-Exact component that originated the error.
+Name of the component that originated the error.
 
 
 </td></tr>
@@ -145,7 +145,7 @@ Exact component that originated the error.
 
 </td><td>
 
-Component subsystem of the error origin
+Component subsystem of the error origin, together with the `origin` uniquely identifies the originating component.
 
 
 </td></tr>

package/docs/api/player.playbackerror.origin.md

@@ -4,7 +4,7 @@
 
 ## PlaybackError.origin property
 
-Exact component that originated the error.
+Name of the component that originated the error.
 
 **Signature:**
 

package/docs/api/player.playbackerror.scope.md

@@ -4,7 +4,7 @@
 
 ## PlaybackError.scope property
 
-Component subsystem of the error origin
+Component subsystem of the error origin, together with the `origin` uniquely identifies the originating component.
 
 **Signature:**
 

package/docs/api/player.poster.md

@@ -18,7 +18,7 @@ export declare class Poster extends UIContainerPlugin
 
 ## Remarks
 
-When the playback is stopped, media control UI is disabled.
+When the playback is stopped, media control UI is disabled. Note that the poster image, if specified via the player config, will be used to update video element's poster attribute by the HTML5-video-based playback module.
 
 Configuration options: