@gcorevideo/player 2.22.1 → 2.22.2

package/dist/plugins/index.js

@@ -10100,16 +10100,24 @@ const gearIcon = "<svg width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\"n
 const gearHdIcon = "<svg width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\">\n  <g clip-path=\"url(#clip0_28_1567)\">\n    <path\n      d=\"M19.14 12.94C19.18 12.64 19.2 12.33 19.2 12C19.2 11.68 19.18 11.36 19.13 11.06L21.16 9.47999C21.34 9.33999 21.39 9.06999 21.28 8.86999L19.36 5.54999C19.24 5.32999 18.99 5.25999 18.77 5.32999L16.38 6.28999C15.88 5.90999 15.35 5.58999 14.76 5.34999L14.4 2.80999C14.36 2.56999 14.16 2.39999 13.92 2.39999H10.08C9.83999 2.39999 9.64999 2.56999 9.60999 2.80999L9.24999 5.34999C8.65999 5.58999 8.11999 5.91999 7.62999 6.28999L5.23999 5.32999C5.01999 5.24999 4.76999 5.32999 4.64999 5.54999L2.73999 8.86999C2.61999 9.07999 2.65999 9.33999 2.85999 9.47999L4.88999 11.06C4.83999 11.36 4.79999 11.69 4.79999 12C4.79999 12.31 4.81999 12.64 4.86999 12.94L2.83999 14.52C2.65999 14.66 2.60999 14.93 2.71999 15.13L4.63999 18.45C4.75999 18.67 5.00999 18.74 5.22999 18.67L7.61999 17.71C8.11999 18.09 8.64999 18.41 9.23999 18.65L9.59999 21.19C9.64999 21.43 9.83999 21.6 10.08 21.6H13.92C14.16 21.6 14.36 21.43 14.39 21.19L14.75 18.65C15.34 18.41 15.88 18.09 16.37 17.71L18.76 18.67C18.98 18.75 19.23 18.67 19.35 18.45L21.27 15.13C21.39 14.91 21.34 14.66 21.15 14.52L19.14 12.94ZM12 15.6C10.02 15.6 8.39999 13.98 8.39999 12C8.39999 10.02 10.02 8.39999 12 8.39999C13.98 8.39999 15.6 10.02 15.6 12C15.6 13.98 13.98 15.6 12 15.6Z\"\n      fill=\"#C9C9C9\"/>\n    <rect x=\"13\" width=\"11\" height=\"7\" rx=\"1\" fill=\"#F6413B\"/>\n    <path\n      d=\"M14.6962 6V1.63636H15.3546V3.53267H17.53V1.63636H18.1905V6H17.53V4.0973H15.3546V6H14.6962ZM20.562 6H19.1493V1.63636H20.6067C21.0343 1.63636 21.4015 1.72372 21.7083 1.89844C22.0151 2.07173 22.2502 2.32102 22.4135 2.64631C22.5783 2.97017 22.6607 3.35866 22.6607 3.81179C22.6607 4.26634 22.5776 4.65696 22.4114 4.98366C22.2466 5.31037 22.008 5.56179 21.6955 5.73793C21.383 5.91264 21.0051 6 20.562 6ZM19.8077 5.42472H20.5257C20.8581 5.42472 21.1344 5.36222 21.3546 5.23722C21.5748 5.1108 21.7395 4.92827 21.8489 4.68963C21.9583 4.44957 22.013 4.15696 22.013 3.81179C22.013 3.46946 21.9583 3.17898 21.8489 2.94034C21.7409 2.7017 21.5797 2.5206 21.3652 2.39702C21.1507 2.27344 20.8844 2.21165 20.5662 2.21165H19.8077V5.42472Z\"\n      fill=\"#C9C9C9\"/>\n  </g>\n  <defs>\n    <clipPath id=\"clip0_28_1567\">\n      <rect width=\"24\" height=\"24\" fill=\"white\"/>\n    </clipPath>\n  </defs>\n</svg>\n";
 
 const VERSION$5 = '2.19.12';
+/**
+ * Events triggered by the plugin
+ * @beta
+ */
 var GearEvents;
 (function (GearEvents) {
+    /**
+     * Use this event to accurately attach an item to the gear menu
+     */
     GearEvents["RENDERED"] = "rendered";
 })(GearEvents || (GearEvents = {}));
 // TODO disabled if no items added
 /**
- * `PLUGIN` that adds the gear button with an extra options menu on the right side of the {@link MediaControl | media control} UI
+ * `PLUGIN` that adds a button to extend the media controls UI with extra options.
  * @beta
  * @remarks
- * The plugins provides a base for attaching custom settings UI in the gear menu
+ * The plugin renders small gear icon to the right of the media controls.
+ * It provides a base for attaching custom settings UI in the gear menu
  *
  * Depends on:
  *
@@ -10216,6 +10224,28 @@ class BottomGear extends UICorePlugin {
         this.listenToOnce(this.core, Events.CORE_READY, this.onCoreReady);
         this.listenTo(this.core, Events.CORE_ACTIVE_CONTAINER_CHANGED, this.onActiveContainerChanged);
     }
+    /**
+     * Adds a custom option to the gear menu
+     * @param name - A unique name of the option
+     * @param $subMenu - The submenu to attach to the option
+     * @returns The added item placeholder to attach custom markup
+     * @remarks
+     * When called with $submenu param, a click on the added item will toggle the submenu visibility.
+     *
+     * When added without submenu, it's responsibility of the caller to handle the click event however needed.
+     * @example
+     * ```ts
+     * class MyPlugin extends UICorePlugin {
+     *   override render() {
+     *     this.$el.html('<div class="my-awesome-settings">...</div>')
+     *     this.core.getPlugin('bottom_gear')
+     *       ?.addItem('custom', this.$el)
+     *       .html($('<button>Custom settings</button>'))
+     *     return this
+     *   }
+     * }
+     * ```
+     */
     addItem(name, $subMenu) {
         const $existingItem = this.$el.find(`#gear-options li[data-${name}`);
         if ($existingItem.length) {
@@ -10268,7 +10298,9 @@ class BottomGear extends UICorePlugin {
         return this;
     }
     /**
-     * Collapses any submenu open back to the gear menu
+     * Collapses any submenu open back to the gear menu.
+     * @remarks
+     * Should be called by the UI plugin that added a gear item with a submenu when the latter is closed (e.g., when a "back" button is clicked).
      */
     refresh() {
         this.$el.find('.gear-sub-menu-wrapper').hide();
@@ -13037,11 +13069,12 @@ class ClapprStats extends ContainerPlugin {
 // ClapprStats.REPORT_EVENT = 'clappr:stats:report';
 // ClapprStats.PERCENTAGE_EVENT = 'clappr:stats:percentage';
 
-//Copyright 2014 Globo.com Player authors. All rights reserved.
+// This work is based on the original work of the following authors:
+// 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 at https://github.com/clappr/clappr-plugins/blob/master/LICENSE.
 /**
- * `PLUGIN` that adds a behavior of toggling the playback state on click over the container
+ * A small `PLUGIN` that toggles the playback state on click over the video container
  * @beta
  */
 class ClickToPause extends ContainerPlugin {
@@ -13325,7 +13358,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.22.1";
+var version$1 = "2.22.2";
 
 var packages = {
 	"node_modules/@clappr/core": {
@@ -13563,8 +13596,23 @@ const templateHtml = "<div class=\"player-error-screen__content\" data-error-scr
 
 const T$b = 'plugins.error_screen';
 /**
- * `PLUGIN` that displays errors nicely in the overlay on top of the player.
- * @beta
+ * `PLUGIN` that displays fatal errors nicely in the overlay on top of the player.
+ * @public
+ * @remarks
+ * A fatal error is an error that prevents the player from playing the content.
+ * It's usually a network error that persists after multiple retries.
+ *
+ * The error screen should not be confused with the content stub that is shown when no media sources are available.
+ * This can happen due to the lack of the support of the given sources type or because the sources are misconfigured (e.g., omitted).
+ *
+ * Configuration options - {@link ErrorScreenPluginSettings}
+ *
+ * @example
+ * ```ts
+ * import { ErrorScreen, Player } from '@gcorevideo/player'
+ *
+ * Player.registerPlugin(ErrorScreen)
+ * ```
  */
 class ErrorScreen extends UICorePlugin {
     err = null;
@@ -14599,18 +14647,6 @@ const DEFAULT_SETTINGS = {
     default: [],
     seekEnabled: true,
 };
-/**
- * Custom events emitted by the plugins to communicate with one another
- * @beta
- * @deprecated
- */
-var MediaControlEvents;
-(function (MediaControlEvents) {
-    /**
-     * Emitted when the gear menu is rendered
-     */
-    MediaControlEvents["MEDIACONTROL_GEAR_RENDERED"] = "mediacontrol:gear:rendered";
-})(MediaControlEvents || (MediaControlEvents = {}));
 const T$9 = 'plugins.media_control';
 const LEFT_ORDER = [
     'playpause',
@@ -17105,27 +17141,29 @@ var PlaybackErrorCode;
 
 const spinnerHTML = "<div data-bounce1></div>\n<div data-bounce2></div>\n<div data-bounce3></div>\n";
 
+// This work is based on the original work of Globo.com
 // 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.
+// https://github.com/clappr/clappr-plugins/blob/ffaa9d27005fa5a8a7c243ffc47eb5655b84b371/LICENSE
 const T$4 = 'plugins.spinner';
 /**
  * Custom events emitted by the plugin
- * @beta
+ * @public
  */
 var SpinnerEvents;
 (function (SpinnerEvents) {
     /**
      * Emitted at the end of the spinner animation cycle to facilitate smooth UI updates,
-     * e.g. {@link SourceController} listens to this event to reload the source when the spinner is hidden
+     * for instance, {@link SourceController} listens to this event to reload the source when the spinner is hidden
      */
     SpinnerEvents["SYNC"] = "plugins:spinner:sync";
 })(SpinnerEvents || (SpinnerEvents = {}));
 /**
- * `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state
- * @beta
+ * `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state.
+ * @public
  * @remarks
- * Events emitted- {@link SpinnerEvents}
+ * 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.
  */
@@ -17196,7 +17234,9 @@ 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
+     * The method call prevents spinner's built-in logic from automatically hiding it until {@link SpinnerThreeBounce.hide} is called
+     *
+     * @param delay - The delay in milliseconds before the spinner is shown.
      */
     show(delay = 300) {
         this.userShown = true;
@@ -17262,11 +17302,47 @@ function noSync(cb) {
     queueMicrotask(cb);
 }
 /**
- * `PLUGIN` that is responsible for managing the automatic failover between sources.
- * @beta
+ * `PLUGIN` that is managing the automatic failover between media sources.
+ * @public
  * @remarks
  * Have a look at the {@link https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787 | source failover diagram} for the details
- * on how sources ordering and selection works.
+ * on how sources ordering and selection works. Below is a simplified diagram:
+ *
+ * ```markdown
+ * sources_list:
+ *       - a.mpd  |    +--------------------+
+ *       - b.m3u8 |--->|         init       |
+ *       - ...    |    |--------------------|
+ *                     | current_source = 0 |
+ *                     +--------------------+
+ *                            |
+ *                            |  source = a.mpd
+ *                            |  playback = dash.js
+ *                            v
+ *                      +------------------+
+ *                  +-->|   load source    |
+ *                  |   +---------|--------+
+ *                  |             v
+ *                  |   +------------------+
+ *                  |   |       play       |
+ *                  |   +---------|--------+
+ *                  |             |
+ *                  |             v
+ *                  |   +-----------------------+
+ *                  |   |  on playback_error    |
+ *                  |   |-----------------------|
+ *                  |   | current_source =      |
+ *                  |   |  (current_source + 1) |
+ *                  |   |  % len sources_list   |
+ *                  |   |                       |
+ *                  |   | delay 1..3s           |
+ *                  |   +---------------|-------+
+ *                  |                   |
+ *                  |   source=b.m3u8   |
+ *                  |   playback=hls.js |
+ *                  +-------------------+
+ *
+ * ```
  *
  * This plugin does not expose any public methods apart from required by the Clappr plugin interface.
  * It is supposed to work autonomously.
@@ -17316,6 +17392,7 @@ class SourceController extends CorePlugin {
      *                  |   playback=hls.js |
      *                  +-------------------+
      *
+     * As can be seen from the diagram, the plugin will endless try to load the next sources rotating between them in round-robin manner.
      */
     sourcesList = [];
     currentSourceIndex = 0;
@@ -17336,7 +17413,7 @@ class SourceController extends CorePlugin {
         return { min: CLAPPR_VERSION };
     }
     /**
-     * @internal
+     * @param core - The Clappr core instance.
      */
     constructor(core) {
         super(core);
@@ -17471,7 +17548,7 @@ const T$2 = 'plugins.cc';
  * @beta
  *
  * @remarks
- * The plugin is activated when closed captions tracks are provided with the media source.
+ * The plugin is activated when closed captions tracks are detected in the media source.
  * It shows a familiar "CC" button with a dropdown menu to select the subtitles language.
  *
  * Depends on:
@@ -17488,7 +17565,7 @@ const T$2 = 'plugins.cc';
  * new Player({
  *   ...
  *   cc: {
- *     language: 'en',
+ *     language: 'pt-BR',
  *   },
  * })
  * ```
@@ -18626,4 +18703,4 @@ class VolumeFade extends UICorePlugin {
     }
 }
 
-export { AudioSelector, BigMuteButton, BottomGear, ClapprNerdStats, ClapprStats, ClickToPause, ClipsPlugin, ClosedCaptions, ContextMenu, DvrControls, ErrorScreen, Favicon, GearEvents, GoogleAnalytics, LevelSelector, Logo, MediaControl, MediaControlEvents, MultiCamera, PictureInPicture, PlaybackRate, Poster, SeekTime, Share, SkipTime, SourceController, SpinnerEvents, SpinnerThreeBounce, ClosedCaptions as Subtitles, Telemetry, TelemetryEvent, Thumbnails, VolumeFade, VolumeFadeEvents };
+export { AudioSelector, BigMuteButton, BottomGear, ClapprNerdStats, ClapprStats, ClickToPause, ClipsPlugin, ClosedCaptions, ContextMenu, DvrControls, ErrorScreen, Favicon, GearEvents, GoogleAnalytics, LevelSelector, Logo, MediaControl, MultiCamera, PictureInPicture, PlaybackRate, Poster, SeekTime, Share, SkipTime, SourceController, SpinnerEvents, SpinnerThreeBounce, ClosedCaptions as Subtitles, Telemetry, TelemetryEvent, Thumbnails, VolumeFade, VolumeFadeEvents };

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

@@ -0,0 +1,95 @@
+<!-- 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; [addItem](./player.bottomgear.additem.md)
+
+## BottomGear.addItem() 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.
+> 
+
+Adds a custom option to the gear menu
+
+**Signature:**
+
+```typescript
+addItem(name: string, $subMenu?: ZeptoResult): ZeptoResult;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+name
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+A unique name of the option
+
+
+</td></tr>
+<tr><td>
+
+$subMenu
+
+
+</td><td>
+
+[ZeptoResult](./player.zeptoresult.md)
+
+
+</td><td>
+
+_(Optional)_ The submenu to attach to the option
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[ZeptoResult](./player.zeptoresult.md)
+
+The added item placeholder to attach custom markup
+
+## Remarks
+
+When called with $submenu param, a click on the added item will toggle the submenu visibility.
+
+When added without submenu, it's responsibility of the caller to handle the click event however needed.
+
+## Example
+
+
+```ts
+class MyPlugin extends UICorePlugin {
+  override render() {
+    this.$el.html('<div class="my-awesome-settings">...</div>')
+    this.core.getPlugin('bottom_gear')
+      ?.addItem('custom', this.$el)
+      .html($('<button>Custom settings</button>'))
+    return this
+  }
+}
+```
+

package/docs/api/player.bottomgear.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 the gear button with an extra options menu on the right side of the [media control](./player.mediacontrol.md) UI
+`PLUGIN` that adds a button to extend the media controls UI with extra options.
 
 **Signature:**
 
@@ -18,12 +18,70 @@ export declare class BottomGear extends UICorePlugin
 
 ## Remarks
 
-The plugins provides a base for attaching custom settings UI in the gear menu
+The plugin renders small gear icon to the right of the media controls. It provides a base for attaching custom settings UI in the gear menu
 
 Depends on:
 
 - [MediaControl](./player.mediacontrol.md)
 
+## Example
+
+You can use bottom gear to add custom settings UI to the gear menu.
+
+```ts
+import { BottomGear } from '@gcorevideo/player/plugins/bottom-gear';
+
+class CustomOptionsPlugin extends UICorePlugin {
+  // ...
+
+  override get events() {
+    return {
+      'click #my-button': 'doMyAction',
+    }
+  }
+
+  private doMyAction() {
+    // ...
+  }
+
+  override render() {
+    const bottomGear = this.core.getPlugin('bottom_gear');
+    if (!bottomGear) {
+      return this;
+    }
+    this.$el.html('<button class="custom-option">Custom option</button>');
+    // Put rendered element into the gear menu
+    bottomGear.addItem('custom').html(this.$el)
+    return this;
+  }
+
+  // alternatively, add an option with a submenu
+  override render() {
+    this.$el.html(template(templateHtml)({
+      // ...
+    })));
+    return this;
+  }
+
+  private addGearOption() {
+    this.core.getPlugin('bottom_gear')
+      .addItem('custom', this.$el)
+      .html($('<button class="custom-option">Custom option</button>'))
+  }
+
+  override bindEvents() {
+    this.listenToOnce(this.core, ClapprEvents.CORE_READY, () => {
+      const bottomGear = this.core.getPlugin('bottom_gear');
+      assert(bottomGear, 'bottom_gear plugin is required');
+      // simple case
+      this.listenTo(bottomGear, GearEvents.RENDERED, this.render);
+      // or with a submenu
+      this.listenTo(bottomGear, GearEvents.RENDERED, this.addGearOption);
+     });
+  }
+}
+```
+
 ## Methods
 
 <table><thead><tr><th>
@@ -44,7 +102,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[getElement(name)](./player.bottomgear.getelement.md)
+[addItem(name, $subMenu)](./player.bottomgear.additem.md)
 
 
 </td><td>
@@ -52,7 +110,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Adds a custom option to the gear menu
 
 
 </td></tr>
@@ -66,21 +124,7 @@ Description
 
 </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>
-
-[setContent(content)](./player.bottomgear.setcontent.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Replaces the content of the gear menu
+**_(BETA)_** Collapses any submenu open back to the gear menu.
 
 
 </td></tr>

package/docs/api/player.bottomgear.refresh.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.
 > 
 
-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.
+Collapses any submenu open back to the gear menu.
 
 **Signature:**
 
@@ -18,3 +18,7 @@ refresh(): void;
 
 void
 
+## Remarks
+
+Should be called by the UI plugin that added a gear item with a submenu when the latter is closed (e.g., when a "back" button is clicked).
+

package/docs/api/player.clapprnerdstats.md

@@ -20,8 +20,6 @@ export declare class ClapprNerdStats extends UICorePlugin
 
 Depends on:
 
-- [MediaControl](./player.mediacontrol.md)
-
 - [BottomGear](./player.bottomgear.md)
 
 - [ClapprStats](./player.clapprstats.md)

package/docs/api/player.clicktopause.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 a behavior of toggling the playback state on click over the container
+A small `PLUGIN` that toggles the playback state on click over the video container
 
 **Signature:**
 

package/docs/api/player.closedcaptions.md

@@ -18,7 +18,7 @@ export declare class ClosedCaptions extends UICorePlugin
 
 ## Remarks
 
-The plugin is activated when closed captions tracks are provided with the media source. It shows a familiar "CC" button with a dropdown menu to select the subtitles language.
+The plugin is activated when closed captions tracks are detected in the media source. It shows a familiar "CC" button with a dropdown menu to select the subtitles language.
 
 Depends on:
 
@@ -37,7 +37,7 @@ Player.registerPlugin(ClosedCaptions)
 new Player({
   ...
   cc: {
-    language: 'en',
+    language: 'pt-BR',
   },
 })
 ```

package/docs/api/player.closedcaptionspluginsettings.md

@@ -4,6 +4,11 @@
 
 ## ClosedCaptionsPluginSettings 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.
+> 
+
+Configuration options for the [ClosedCaptions](./player.closedcaptions.md) plugin.
+
 **Signature:**
 
 ```typescript

package/docs/api/player.errorscreen.md

@@ -4,10 +4,7 @@
 
 ## ErrorScreen 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 displays errors nicely in the overlay on top of the player.
+`PLUGIN` that displays fatal errors nicely in the overlay on top of the player.
 
 **Signature:**
 
@@ -16,3 +13,20 @@ export declare class ErrorScreen extends UICorePlugin
 ```
 **Extends:** UICorePlugin
 
+## Remarks
+
+A fatal error is an error that prevents the player from playing the content. It's usually a network error that persists after multiple retries.
+
+The error screen should not be confused with the content stub that is shown when no media sources are available. This can happen due to the lack of the support of the given sources type or because the sources are misconfigured (e.g., omitted).
+
+Configuration options - [ErrorScreenPluginSettings](./player.errorscreenpluginsettings.md)
+
+## Example
+
+
+```ts
+import { ErrorScreen, Player } from '@gcorevideo/player'
+
+Player.registerPlugin(ErrorScreen)
+```
+

package/docs/api/player.errorscreenpluginsettings.md

@@ -4,10 +4,7 @@
 
 ## ErrorScreenPluginSettings 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.
-> 
-
-Configuration options for the [error screen](./player.errorscreen.md) plugin.
+Configuration options for the [ErrorScreen](./player.errorscreen.md) plugin.
 
 **Signature:**
 

package/docs/api/player.errorscreensettings.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ErrorScreenSettings](./player.errorscreensettings.md)
+
+## ErrorScreenSettings type
+
+Settings for the [ErrorScreen](./player.errorscreen.md) plugin.
+
+**Signature:**
+
+```typescript
+export type ErrorScreenSettings = {
+    noReload?: boolean;
+};
+```

package/docs/api/{player.mediacontrolevents.md → player.gearevents.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; [MediaControlEvents](./player.mediacontrolevents.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [GearEvents](./player.gearevents.md)
 
-## MediaControlEvents enum
+## GearEvents enum
 
 > 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.
 > 
 
-Custom events emitted by the plugins to communicate with one another
+Events triggered by the plugin
 
 **Signature:**
 
 ```typescript
-export declare enum MediaControlEvents 
+export declare enum GearEvents 
 ```
 
 ## Enumeration Members
@@ -35,17 +35,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-MEDIACONTROL\_GEAR\_RENDERED
+RENDERED
 
 
 </td><td>
 
-`"mediacontrol:gear:rendered"`
+`"rendered"`
 
 
 </td><td>
 
-**_(BETA)_** Emitted when the gear menu is rendered
+**_(BETA)_** Use this event to accurately attach an item to the gear menu
 
 
 </td></tr>

package/docs/api/player.levelselector.events.md

@@ -12,7 +12,6 @@
 ```typescript
 get events(): {
         'click .gear-sub-menu_btn': string;
-        'click .gear-option': string;
         'click .go-back': string;
     };
 ```