@gcorevideo/player 2.20.8 → 2.20.9

package/dist/plugins/index.js

@@ -32796,9 +32796,6 @@ const gearHdIcon = "<svg width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\
 /* eslint-disable */
 // Kibo is released under the MIT License. Copyright (c) 2013 marquete.
 // see https://github.com/marquete/kibo
-/**
- * @internal
- */
 class Kibo {
     element;
     lastKeyCode = -1;
@@ -33096,7 +33093,7 @@ function orderByOrderPattern(arr, order) {
     return [...ordered, ...rest];
 }
 /**
- * The MediaControl provides a foundation for developing custom media controls UI.
+ * PLUGIN that provides a foundation for developing custom media controls UI.
  * @beta
  * @remarks
  * The methods exposed are to be used by the other plugins that extend the media control UI.
@@ -33178,14 +33175,14 @@ class MediaControl extends UICorePlugin {
     }
     /**
      * @internal
-     * @deprecated
+     * @deprecated Use core.activeContainer directly
      */
     get container() {
         return this.core.activeContainer;
     }
     /**
      * @internal
-     * @deprecated
+     * @deprecated Use core.activePlayback directly
      */
     get playback() {
         return this.core.activePlayback;
@@ -35923,7 +35920,7 @@ class Speedtest {
             this._state = 1;
         }
         if (this._state !== 1) {
-            throw 'You can\'t add a server after server selection';
+            throw "You can't add a server after server selection";
         }
         this._settings.mpot = true;
         this._serverList.push(server);
@@ -35942,7 +35939,7 @@ class Speedtest {
     setSelectedServer(server) {
         this._checkServerDefinition(server);
         if (this._state === 3) {
-            throw 'You can\'t select a server while the test is running';
+            throw "You can't select a server while the test is running";
         }
         this._selectedServer = server;
         this._state = 2;
@@ -35956,7 +35953,7 @@ class Speedtest {
                 throw 'Server already selected';
             }
             if (this._state >= 3) {
-                throw 'You can\'t select a server while the test is running';
+                throw "You can't select a server while the test is running";
             }
         }
         if (this._selectServerCalled) {
@@ -35966,7 +35963,7 @@ class Speedtest {
             this._selectServerCalled = true;
         }
         /*this function goes through a list of servers. For each server, the ping is measured, then the server with the function result is called with the best server, or null if all the servers were down.
-             */
+         */
         const select = (serverList, result) => {
             //pings the specified URL, then calls the function result. Result will receive a parameter which is either the time it took to ping the URL, or -1 if something went wrong.
             const PING_TIMEOUT = 2000;
@@ -36064,7 +36061,7 @@ class Speedtest {
                 }
                 result(bestServer);
             };
-            serverList.forEach(server => {
+            serverList.forEach((server) => {
                 checkServer(server, done);
             });
             if (i === serverList.length) {
@@ -36153,12 +36150,12 @@ class Speedtest {
             if (typeof this._originalExtra !== 'undefined') {
                 this._settings.telemetry_extra = JSON.stringify({
                     server: this._selectedServer.name,
-                    extra: this._originalExtra
+                    extra: this._originalExtra,
                 });
             }
             else {
                 this._settings.telemetry_extra = JSON.stringify({
-                    server: this._selectedServer.name
+                    server: this._selectedServer.name,
                 });
             }
         }
@@ -36168,7 +36165,7 @@ class Speedtest {
     }
     abort() {
         if (this._state < 3) {
-            throw new Error('You cannot abort a test that\'s not started yet');
+            throw new Error("You cannot abort a test that's not started yet");
         }
         if (this._state < 4) {
             this.worker?.postMessage('abort');
@@ -36413,7 +36410,7 @@ const drawSummary = (customMetrics, vodContainer, liveContainer) => {
 };
 // const T = 'plugins.clappr_nerd_stats';
 /**
- * Displays useful network-related statistics.
+ * PLUGIN that displays useful network-related statistics.
  * @beta
  *
  * @remarks
@@ -36669,7 +36666,7 @@ function newMetrics() {
 // TODO: fix
 const updateMetrics = () => { };
 /**
- * Collects useful statistics about playback performance.
+ * PLIGIN that collects useful statistics about playback performance.
  * @beta
  * @remarks
  * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.
@@ -36732,9 +36729,10 @@ class ClapprStats extends ContainerPlugin {
     }
     /**
      * Registers a callback to receive the metrics.
-     * @param updateMetricsFn
+     * @param updateMetricsFn - The callback to receive the metrics
      */
     setUpdateMetrics(updateMetricsFn) {
+        // TODO use events instead
         this.updateFn = updateMetricsFn;
     }
     _defaultReport(metrics) {
@@ -36782,7 +36780,7 @@ class ClapprStats extends ContainerPlugin {
     }
     /**
      * Returns the collected metrics.
-     * @returns The collected metrics
+     * @returns Currently collected metrics
      */
     exportMetrics() {
         return structuredClone(this.metrics);
@@ -37092,7 +37090,7 @@ class ClickToPause extends ContainerPlugin {
 }
 
 /**
- * Adds a behavior of showing a text over the seekbar to indicate the current clip.
+ * PLUGIN that shows text over the seekbar to indicate the current clip.
  * @beta
  * @remarks
  * Depends on:
@@ -37248,7 +37246,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.8";
+var version$1 = "2.20.9";
 
 var packages = {
 	"node_modules/@clappr/core": {
@@ -37385,7 +37383,8 @@ const dvrHTML = "<div class=\"live-info\"><%= live %></div>\n<button type=\"butt
 
 const T$b = 'plugins.dvr_controls';
 /**
- * Adds the DVR controls to the media control UI
+ * PLUGIN that adds the DVR controls to the media control UI
+ *
  * @beta
  *
  * @remarks
@@ -37393,7 +37392,7 @@ const T$b = 'plugins.dvr_controls';
  *
  * - {@link MediaControl}
  *
- * The plugin renders the live stream indicator and the DVR seek bar, if DVR is enabled, in the media control UI.
+ * The plugin renders live stream indicator and the DVR seek bar, if DVR is enabled, in the media control UI.
  */
 class DvrControls extends UICorePlugin {
     static template = tmpl(dvrHTML);
@@ -37517,7 +37516,7 @@ const templateHtml = "<div class=\"player-error-screen__content\" data-error-scr
 
 const T$a = 'plugins.error_screen';
 /**
- * Displays an error nicely in the overlay on top of the player.
+ * PLUGIN that displays errors nicely in the overlay on top of the player.
  * @beta
  */
 class ErrorScreen extends UICorePlugin {
@@ -37862,7 +37861,7 @@ const checkIcon = "<svg width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\"
 const T$9 = 'plugins.level_selector';
 const VERSION$4 = '2.19.4';
 /**
- * A {@link MediaControl | media control} plugin that provides a UI to control the quality level of the playback.
+ * PLUGIN that provides a UI to select the desired quality level of the playback.
  * @beta
  *
  * @remarks
@@ -37872,9 +37871,7 @@ const VERSION$4 = '2.19.4';
  *
  * - {@link BottomGear}
  *
- * The plugin is rendered as an item in the gear menu.
- *
- * When clicked, it shows a list of quality levels to choose from.
+ * 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 - {@link LevelSelectorPluginSettings}
  *
@@ -38374,7 +38371,7 @@ const streamsWhiteNightsIcon = "<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:
 const VERSION$3 = '0.0.1';
 const T$8 = 'plugins.multicamera';
 /**
- * The plugin adds support for loading multiple streams and switching between them using the media control UI.
+ * PLUGIN that adds support for loading multiple streams and switching between them using the media control UI.
  * @beta
  */
 class MultiCamera extends UICorePlugin {
@@ -39031,7 +39028,7 @@ const posterHTML = "<div class=\"play-wrapper\" data-poster></div>\n";
 //Copyright 2014 Globo.com Player authors. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
-const T$5 = 'plugins.poster_custom';
+const T$5 = 'plugins.poster';
 /**
  * Displays a poster image in the background and a big play button on top when playback is stopped
  * @beta
@@ -39069,7 +39066,7 @@ class Poster extends UIContainerPlugin {
      * @internal
      */
     get name() {
-        return 'poster_custom';
+        return 'poster';
     }
     /**
      * @internal
@@ -39465,7 +39462,8 @@ const fbIcon = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<svg width=\"32px\"
 const twIcon = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<svg width=\"32px\" height=\"32px\" viewBox=\"0 0 32 32\" version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n    <!-- Generator: Sketch 49 (51002) - http://www.bohemiancoding.com/sketch -->\n    <title>twitter</title>\n    <desc>Created with Sketch.</desc>\n    <defs></defs>\n    <g id=\"twitter\" stroke=\"none\" stroke-width=\"1\" fill=\"none\" fill-rule=\"evenodd\">\n        <g fill-rule=\"nonzero\" id=\"Shape\">\n            <path d=\"M32,30 C32,31.104 31.104,32 30,32 L2,32 C0.896,32 0,31.104 0,30 L0,2 C0,0.896 0.896,0 2,0 L30,0 C31.104,0 32,0.896 32,2 L32,30 Z\" fill=\"#55ACEE\"></path>\n            <path class=\"icon-hover\" d=\"M25.987,9.894 C25.251,10.216 24.462,10.431 23.63,10.529 C24.48,10.031 25.13,9.24 25.436,8.298 C24.644,8.759 23.766,9.095 22.831,9.276 C22.083,8.491 21.017,8 19.838,8 C17.572,8 15.738,9.807 15.738,12.038 C15.738,12.352 15.774,12.663 15.842,12.96 C12.435,12.788 9.413,11.181 7.39,8.739 C7.038,9.336 6.834,10.029 6.834,10.771 C6.834,12.17 7.56,13.406 8.658,14.131 C7.987,14.109 7.354,13.928 6.802,13.625 C6.801,13.642 6.801,13.659 6.801,13.677 C6.801,15.632 8.215,17.266 10.091,17.637 C9.748,17.727 9.386,17.779 9.01,17.779 C8.746,17.779 8.49,17.755 8.24,17.707 C8.76,19.311 10.274,20.478 12.068,20.512 C10.67,21.594 8.9,22.24 6.979,22.24 C6.649,22.24 6.321,22.222 6,22.184 C7.814,23.329 9.971,23.997 12.287,23.997 C19.828,23.997 23.953,17.843 23.953,12.506 C23.953,12.333 23.948,12.156 23.941,11.985 C24.741,11.414 25.438,10.703 25.987,9.894 Z\" fill=\"#FFFFFF\"></path>\n        </g>\n    </g>\n</svg>";
 
 /**
- * The plugin adds a share button to the media control UI.
+ * PLUGIN that adds a share button to the media control UI.
+ * @beta
  */
 class Share extends UICorePlugin {
     hide = false;
@@ -39585,7 +39583,8 @@ class Share extends UICorePlugin {
 const pluginHtml$1 = "<div class=\"skip-container\" data-skip-container>\n    <div class=\"skip-item\" data-skip-left>\n    </div>\n    <div class=\"skip-item\" data-skip-mid>\n    </div>\n    <div class=\"skip-item\" data-skip-right>\n    </div>\n</div>\n";
 
 /**
- * The plugin adds skip controls to the media control UI.
+ * PLUGIN that adds skip controls to the media control UI.
+ * @beta
  */
 class SkipTime extends UICorePlugin {
     get name() {
@@ -39698,6 +39697,7 @@ const spinnerHTML = "<div data-bounce1></div>\n<div data-bounce2></div>\n<div da
 const T$4 = 'plugins.spinner';
 /**
  * Custom events emitted by the plugin
+ * @beta
  */
 var SpinnerEvents;
 (function (SpinnerEvents) {
@@ -39708,10 +39708,12 @@ var SpinnerEvents;
     SpinnerEvents["SYNC"] = "plugins:spinner:sync";
 })(SpinnerEvents || (SpinnerEvents = {}));
 /**
- * Shows a pending operation indicator when playback is buffering or in other appropriate cases
+ * PLUGIN that shows a pending operation indicator when playback is buffering or in a similar state
  * @beta
  * @remarks
- * The plugin emits
+ * Events emitted- {@link SpinnerEvents}
+ * Other plugins can use {@link SpinnerThreeBounce.show | show} and {@link SpinnerThreeBounce.hide | hide} methods to
+ * implement custom pending/progress indication scenarios.
  */
 class SpinnerThreeBounce extends UIContainerPlugin {
     userShown = false;
@@ -39789,7 +39791,7 @@ class SpinnerThreeBounce extends UIContainerPlugin {
     /**
      * Shows the spinner.
      *
-     * When called, the spinner will not hide (due to its built-in logic) until {@link SpinnerThreeBounce#hide} is called
+     * When called, the spinner will not hide (due to its built-in logic) until {@link SpinnerThreeBounce.hide} is called
      */
     show(delay = 300) {
         this.userShown = true;
@@ -39966,7 +39968,7 @@ class SourceController extends CorePlugin {
         }
         this.bindContainerEventListeners();
         if (this.active) {
-            this.core.activeContainer?.getPlugin('poster_custom')?.disable();
+            this.core.activeContainer?.getPlugin('poster')?.disable();
             spinner?.show(0);
         }
     }
@@ -39987,7 +39989,7 @@ class SourceController extends CorePlugin {
             }
             switch (error.code) {
                 case PlaybackErrorCode.MediaSourceUnavailable:
-                    this.core.activeContainer?.getPlugin('poster_custom')?.disable();
+                    this.core.activeContainer?.getPlugin('poster')?.disable();
                     this.retryPlayback();
                     break;
             }
@@ -39999,7 +40001,7 @@ class SourceController extends CorePlugin {
             });
             if (this.active) {
                 this.reset();
-                this.core.activeContainer?.getPlugin('poster_custom')?.enable();
+                this.core.activeContainer?.getPlugin('poster')?.enable();
                 this.core.activeContainer?.getPlugin('spinner')?.hide();
             }
         });
@@ -40430,7 +40432,7 @@ var TelemetryEvent;
     TelemetryEvent[TelemetryEvent["Stall"] = 4] = "Stall";
 })(TelemetryEvent || (TelemetryEvent = {}));
 /**
- * Collects and reports the performance statistics.
+ * PLUGIN that collects and reports the performance statistics.
  * @beta
  * @remarks
  * This plugin is experimental and its API is likely to change.
@@ -41249,4 +41251,4 @@ class VolumeFade extends UICorePlugin {
     }
 }
 
-export { AudioSelector, BigMuteButton, BottomGear, ClapprNerdStats, ClapprStats, ClickToPause, ClipsPlugin, ContextMenu, DvrControls, ErrorScreen, Favicon, GoogleAnalytics, Kibo, LevelSelector, Logo, MediaControl, MediaControlEvents, MultiCamera, PictureInPicture, PlaybackRate, Poster, SeekTime, Share, SkipTime, SourceController, SpinnerEvents, SpinnerThreeBounce, Subtitles, Telemetry, TelemetryEvent, Thumbnails, VolumeFade, VolumeFadeEvents };
+export { AudioSelector, BigMuteButton, BottomGear, ClapprNerdStats, ClapprStats, ClickToPause, ClipsPlugin, ContextMenu, DvrControls, ErrorScreen, Favicon, GoogleAnalytics, LevelSelector, Logo, MediaControl, MediaControlEvents, MultiCamera, PictureInPicture, PlaybackRate, Poster, SeekTime, Share, SkipTime, SourceController, SpinnerEvents, SpinnerThreeBounce, Subtitles, Telemetry, TelemetryEvent, Thumbnails, VolumeFade, VolumeFadeEvents };

package/docs/api/player.bottomgear.md

@@ -55,6 +55,20 @@ Description
 **_(BETA)_**
 
 
+</td></tr>
+<tr><td>
+
+[refresh()](./player.bottomgear.refresh.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Re-renders the gear menu. It fires the [MEDIACONTROL\_GEAR\_RENDERED](./player.mediacontrolevents.md) event, which the plugins that attach to the gear menu can listen to to re-render themselves.
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/player.bottomgear.refresh.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [BottomGear](./player.bottomgear.md) &gt; [refresh](./player.bottomgear.refresh.md)
+
+## BottomGear.refresh() 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.
+> 
+
+Re-renders the gear menu. It fires the [MEDIACONTROL\_GEAR\_RENDERED](./player.mediacontrolevents.md) event, which the plugins that attach to the gear menu can listen to to re-render themselves.
+
+**Signature:**
+
+```typescript
+refresh(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.clapprnerdstats.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.
 > 
 
-Displays useful network-related statistics.
+PLUGIN that displays useful network-related statistics.
 
 **Signature:**
 

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

@@ -18,5 +18,5 @@ exportMetrics(): Metrics;
 
 Metrics
 
-The collected metrics
+Currently collected metrics
 

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.
 > 
 
-Collects useful statistics about playback performance.
+PLIGIN that collects useful statistics about playback performance.
 
 **Signature:**
 
@@ -85,20 +85,6 @@ Description
 **_(BETA)_** Returns the collected metrics.
 
 
-</td></tr>
-<tr><td>
-
-[onBitrate(newBitrate)](./player.clapprstats.onbitrate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 

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

@@ -45,6 +45,8 @@ MetricsUpdateFn
 
 </td><td>
 
+The callback to receive the metrics
+
 
 </td></tr>
 </tbody></table>

package/docs/api/player.clipsplugin.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.
 > 
 
-Adds a behavior of showing a text over the seekbar to indicate the current clip.
+PLUGIN that shows text over the seekbar to indicate the current clip.
 
 **Signature:**
 

package/docs/api/player.clipspluginsettings.md

@@ -4,7 +4,10 @@
 
 ## ClipsPluginSettings interface
 
-Configuration options
+> 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.
 
 **Signature:**
 
@@ -50,7 +53,7 @@ string
 
 </td><td>
 
-The text to display over the seekbar.
+**_(BETA)_** The text to display over the seekbar.
 
 
 </td></tr>

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

@@ -4,6 +4,9 @@
 
 ## ClipsPluginSettings.text 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 text to display over the seekbar.
 
 **Signature:**

package/docs/api/player.containerpluginconstructor.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContainerPluginConstructor](./player.containerpluginconstructor.md)
+
+## ContainerPluginConstructor 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
+export type ContainerPluginConstructor = ((container: unknown) => PlayerPlugin) & {
+    type: 'container';
+};
+```
+**References:** [PlayerPlugin](./player.playerplugin.md)
+

package/docs/api/{player.errorscreen.render.md → player.corepluginconstructor.md}

@@ -1,18 +1,19 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ErrorScreen](./player.errorscreen.md) &gt; [render](./player.errorscreen.render.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [CorePluginConstructor](./player.corepluginconstructor.md)
 
-## ErrorScreen.render() method
+## CorePluginConstructor 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
-render(): this;
+export type CorePluginConstructor = ((core: unknown) => PlayerPlugin) & {
+    type: 'core';
+};
 ```
-**Returns:**
-
-this
+**References:** [PlayerPlugin](./player.playerplugin.md)
 

package/docs/api/player.errordesc.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ErrorDesc](./player.errordesc.md)
+
+## ErrorDesc 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.
+> 
+
+An error fired in the player and plugins code to be handled in the UI
+
+**Signature:**
+
+```typescript
+export type ErrorDesc = {
+    description: string;
+    level: string;
+    code: string;
+    origin: string;
+    scope: string;
+    raw?: string;
+    UI?: {
+        icon?: string;
+        title: string;
+        message: string;
+    };
+};
+```