@gcorevideo/player 2.22.1 → 2.22.3

package/docs/api/player.levelselector.md

@@ -75,7 +75,7 @@ Description
 
 </td><td>
 
-{ 'click .gear-sub-menu\_btn': string; 'click .gear-option': string; 'click .go-back': string; }
+{ 'click .gear-sub-menu\_btn': string; 'click .go-back': string; }
 
 
 </td><td>

package/docs/api/player.md

@@ -72,7 +72,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that adds the gear button with an extra options menu on the right side of the [media control](./player.mediacontrol.md) UI
+**_(BETA)_** `PLUGIN` that adds a button to extend the media controls UI with extra options.
 
 
 </td></tr>
@@ -105,7 +105,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that adds a behavior of toggling the playback state on click over the container
+**_(BETA)_** A small `PLUGIN` that toggles the playback state on click over the video container
 
 
 </td></tr>
@@ -160,7 +160,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `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.
 
 
 </td></tr>
@@ -314,7 +314,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that is responsible for managing the automatic failover between sources.
+`PLUGIN` that is managing the automatic failover between media sources.
 
 
 </td></tr>
@@ -325,7 +325,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state
+`PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state.
 
 
 </td></tr>
@@ -379,12 +379,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[MediaControlEvents](./player.mediacontrolevents.md)
+[GearEvents](./player.gearevents.md)
 
 
 </td><td>
 
-**_(BETA)_** Custom events emitted by the plugins to communicate with one another
+**_(BETA)_** Events triggered by the plugin
 
 
 </td></tr>
@@ -417,7 +417,7 @@ A top-level event on the player object
 
 </td><td>
 
-**_(BETA)_** Custom events emitted by the plugin
+Custom events emitted by the plugin
 
 
 </td></tr>
@@ -615,15 +615,6 @@ A level of quality within a media source.
 **_(BETA)_** Plugin settings
 
 
-</td></tr>
-<tr><td>
-
-[TextTrackItem](./player.texttrackitem.md)
-
-
-</td><td>
-
-
 </td></tr>
 <tr><td>
 
@@ -669,6 +660,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Configuration options for the [ClosedCaptions](./player.closedcaptions.md) plugin.
+
 
 </td></tr>
 <tr><td>
@@ -733,60 +726,73 @@ Levels of severity of errors. Non-fatal errors usually can be ignored.
 
 </td><td>
 
-**_(BETA)_** Configuration options for the [error screen](./player.errorscreen.md) plugin.
+Configuration options for the [ErrorScreen](./player.errorscreen.md) plugin.
 
 
 </td></tr>
 <tr><td>
 
-[GearItemElement](./player.gearitemelement.md)
+[ErrorScreenSettings](./player.errorscreensettings.md)
 
 
 </td><td>
 
+Settings for the [ErrorScreen](./player.errorscreen.md) plugin.
+
 
 </td></tr>
 <tr><td>
 
-[GearOptionsItem](./player.gearoptionsitem.md)
+[LangTag](./player.langtag.md)
 
 
 </td><td>
 
-**_(BETA)_** An element inside the gear menu
+An ISO 639-1 language code.
 
 
 </td></tr>
 <tr><td>
 
-[LangTag](./player.langtag.md)
+[MediaControlElement](./player.mediacontrolelement.md)
 
 
 </td><td>
 
-An ISO 639-1 language code.
+**_(BETA)_** Media control elements, mount points for additional plugins
 
 
 </td></tr>
 <tr><td>
 
-[MediaControlElement](./player.mediacontrolelement.md)
+[PlaybackModule](./player.playbackmodule.md)
 
 
 </td><td>
 
-**_(BETA)_** Media control elements, mount points for additional plugins
+Module to perform the playback.
 
 
 </td></tr>
 <tr><td>
 
-[PlaybackModule](./player.playbackmodule.md)
+[PlaybackRateOption](./player.playbackrateoption.md)
 
 
 </td><td>
 
-Module to perform the playback.
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[PlaybackRateSettings](./player.playbackratesettings.md)
+
+
+</td><td>
+
+**_(BETA)_**
 
 
 </td></tr>
@@ -882,15 +888,6 @@ A media source to fetch the media data from
 
 
 
-</td></tr>
-<tr><td>
-
-[SubtitlesPluginSettings](./player.subtitlespluginsettings.md)
-
-
-</td><td>
-
-
 </td></tr>
 <tr><td>
 

package/docs/api/{player.bottomgear.setcontent.md → player.mediacontrol.handlecustomarea.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; [BottomGear](./player.bottomgear.md) &gt; [setContent](./player.bottomgear.setcontent.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [handleCustomArea](./player.mediacontrol.handlecustomarea.md)
 
-## BottomGear.setContent() method
+## MediaControl.handleCustomArea() 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.
 > 
 
-Replaces the content of the gear menu
-
 **Signature:**
 
 ```typescript
-setContent(content: ZeptoResult): void;
+handleCustomArea(handler: (name: string, content: HTMLElement) => void): void;
 ```
 
 ## Parameters
@@ -35,18 +33,16 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-content
+handler
 
 
 </td><td>
 
-[ZeptoResult](./player.zeptoresult.md)
+(name: string, content: HTMLElement) =&gt; void
 
 
 </td><td>
 
-Zepto result of the element
-
 
 </td></tr>
 </tbody></table>

package/docs/api/player.mediacontrol.md

@@ -229,6 +229,20 @@ 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>
 
@@ -274,7 +288,7 @@ Description
 </td></tr>
 <tr><td>
 
-[toggleElement(name, show)](./player.mediacontrol.toggleelement.md)
+[toggleElement(area, show)](./player.mediacontrol.toggleelement.md)
 
 
 </td><td>

package/docs/api/player.mediacontrol.putelement.md

@@ -10,7 +10,7 @@
 **Signature:**
 
 ```typescript
-putElement(name: MediaControlElement, element: HTMLElement): void;
+putElement(name: MediaControlElement, element: ZeptoResult): void;
 ```
 
 ## Parameters
@@ -52,7 +52,7 @@ element
 
 </td><td>
 
-HTMLElement
+[ZeptoResult](./player.zeptoresult.md)
 
 
 </td><td>

package/docs/api/player.mediacontrol.toggleelement.md

@@ -12,7 +12,7 @@ Toggle the visibility of a media control element
 **Signature:**
 
 ```typescript
-toggleElement(name: MediaControlElement, show: boolean): void;
+toggleElement(area: MediaControlElement, show: boolean): void;
 ```
 
 ## Parameters
@@ -35,7 +35,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-name
+area
 
 
 </td><td>
@@ -45,8 +45,6 @@ name
 
 </td><td>
 
-The name of the media control element
-
 
 </td></tr>
 <tr><td>

package/docs/api/player.mediacontrolelement.md

@@ -12,5 +12,5 @@ Media control elements, mount points for additional plugins
 **Signature:**
 
 ```typescript
-export type MediaControlElement = 'audiotracks' | 'cc' | 'clipText' | 'dvr' | 'duration' | 'gear' | 'pip' | 'playbackRate' | 'position' | 'seekBarContainer';
+export type MediaControlElement = 'audiotracks' | 'cc' | 'clipText' | 'dvr' | 'duration' | 'fullscreen' | 'gear' | 'multicamera' | 'pip' | 'playbackRate' | 'position' | 'seekBarContainer' | 'vr' | 'volume';
 ```

package/docs/api/player.playbackrate.md

@@ -20,11 +20,30 @@ export declare class PlaybackRate extends UICorePlugin
 
 Depends on:
 
-- [media\_control](./player.mediacontrol.md)
+- [MediaControl](./player.mediacontrol.md)
 
-- [bottom\_gear](./player.bottomgear.md)
+- [BottomGear](./player.bottomgear.md)
 
-It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate. Note that the playback rate change is supported only for VOD or DVR enabled live streams.
+It renders an option in the gear menu, which opens a dropdown with the options to change the playback rate. Note that the playback rate change is supported only for VOD or DVR-enabled live streams.
+
+Plugin settings - [PlaybackRateSettings](./player.playbackratesettings.md)
+
+## Example
+
+
+```ts
+import { Player, PlaybackRateSettings } from '@gcorevideo/player'
+Player.registerPlugin(PlaybackRate)
+const player = new Player({
+  playbackRate: {
+    options: [
+      { value: 0.5, label: '0.5x' },
+      { value: 1, label: '1x' },
+    ],
+    defaultValue: 1,
+  } as PlaybackRateSettings,
+})
+```
 
 ## Constructors
 

package/docs/api/{player.gearoptionsitem.md → player.playbackrateoption.md}

@@ -1,16 +1,18 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [GearOptionsItem](./player.gearoptionsitem.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlaybackRateOption](./player.playbackrateoption.md)
 
-## GearOptionsItem type
+## PlaybackRateOption 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 element inside the gear menu
 
 **Signature:**
 
 ```typescript
-export type GearOptionsItem = 'quality' | 'rate' | 'nerd';
+export type PlaybackRateOption = {
+    value: number;
+    label: string;
+};
 ```

package/docs/api/player.playbackratesettings.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; [PlaybackRateSettings](./player.playbackratesettings.md)
+
+## PlaybackRateSettings 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 PlaybackRateSettings = {
+    options?: PlaybackRateOption[];
+    defaultValue?: number;
+};
+```
+**References:** [PlaybackRateOption](./player.playbackrateoption.md)
+

package/docs/api/player.sourcecontroller._constructor_.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [SourceController](./player.sourcecontroller.md) &gt; [(constructor)](./player.sourcecontroller._constructor_.md)
+
+## SourceController.(constructor)
+
+Constructs a new instance of the `SourceController` class
+
+**Signature:**
+
+```typescript
+constructor(core: ClapprCore);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+core
+
+
+</td><td>
+
+ClapprCore
+
+
+</td><td>
+
+The Clappr core instance.
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.sourcecontroller.md

@@ -4,10 +4,7 @@
 
 ## SourceController 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 is responsible for managing the automatic failover between sources.
+`PLUGIN` that is managing the automatic failover between media sources.
 
 **Signature:**
 
@@ -18,11 +15,44 @@ export declare class SourceController extends CorePlugin
 
 ## Remarks
 
-Have a look at the [source failover diagram](https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787) for the details on how sources ordering and selection works.
+Have a look at the [source failover diagram](https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787) for the details on how sources ordering and selection works. Below is a simplified diagram:
 
-This plugin does not expose any public methods apart from required by the Clappr plugin interface. It is supposed to work autonomously.
+```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 |
+                 +-------------------+
 
-The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SourceController` class.
+```
+This plugin does not expose any public methods apart from required by the Clappr plugin interface. It is supposed to work autonomously.
 
 ## Example
 
@@ -33,3 +63,36 @@ import { SourceController } from '@gcorevideo/player'
 Player.registerPlugin(SourceController)
 ```
 
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(core)](./player.sourcecontroller._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `SourceController` class
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.spinnerevents.md

@@ -4,9 +4,6 @@
 
 ## SpinnerEvents 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 plugin
 
 **Signature:**
@@ -45,7 +42,7 @@ SYNC
 
 </td><td>
 
-**_(BETA)_** Emitted at the end of the spinner animation cycle to facilitate smooth UI updates, e.g. [SourceController](./player.sourcecontroller.md) listens to this event to reload the source when the spinner is hidden
+Emitted at the end of the spinner animation cycle to facilitate smooth UI updates, for instance, [SourceController](./player.sourcecontroller.md) listens to this event to reload the source when the spinner is hidden
 
 
 </td></tr>

package/docs/api/player.spinnerthreebounce._constructor_.md

@@ -4,9 +4,6 @@
 
 ## SpinnerThreeBounce.(constructor)
 
-> 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 `SpinnerThreeBounce` class
 
 **Signature:**

package/docs/api/player.spinnerthreebounce.hide.md

@@ -4,9 +4,6 @@
 
 ## SpinnerThreeBounce.hide() 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.
-> 
-
 Hides the spinner.
 
 **Signature:**

package/docs/api/player.spinnerthreebounce.md

@@ -4,10 +4,7 @@
 
 ## SpinnerThreeBounce 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 shows a pending operation indicator when playback is buffering or in a similar state
+`PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state.
 
 **Signature:**
 
@@ -18,7 +15,7 @@ export declare class SpinnerThreeBounce extends UIContainerPlugin
 
 ## Remarks
 
-Events emitted- [SpinnerEvents](./player.spinnerevents.md) Other plugins can use [show](./player.spinnerthreebounce.show.md) and [hide](./player.spinnerthreebounce.hide.md) methods to implement custom pending/progress indication scenarios.
+It is aliased as `Spinner` for convenience. Events emitted - [SpinnerEvents](./player.spinnerevents.md) Other plugins can use [show](./player.spinnerthreebounce.show.md) and [hide](./player.spinnerthreebounce.hide.md) methods to implement custom pending/progress indication scenarios.
 
 ## Constructors
 
@@ -48,7 +45,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Constructs a new instance of the `SpinnerThreeBounce` class
+Constructs a new instance of the `SpinnerThreeBounce` class
 
 
 </td></tr>
@@ -82,7 +79,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Hides the spinner.
+Hides the spinner.
 
 
 </td></tr>
@@ -96,9 +93,9 @@ Description
 
 </td><td>
 
-**_(BETA)_** Shows the spinner.
+Shows the spinner.
 
-When called, the spinner will not hide (due to its built-in logic) until [SpinnerThreeBounce.hide()](./player.spinnerthreebounce.hide.md) is called
+The method call prevents spinner's built-in logic from automatically hiding it until [SpinnerThreeBounce.hide()](./player.spinnerthreebounce.hide.md) is called
 
 
 </td></tr>

package/docs/api/player.spinnerthreebounce.show.md

@@ -4,12 +4,9 @@
 
 ## SpinnerThreeBounce.show() 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.
-> 
-
 Shows the spinner.
 
-When called, the spinner will not hide (due to its built-in logic) until [SpinnerThreeBounce.hide()](./player.spinnerthreebounce.hide.md) is called
+The method call prevents spinner's built-in logic from automatically hiding it until [SpinnerThreeBounce.hide()](./player.spinnerthreebounce.hide.md) is called
 
 **Signature:**
 
@@ -47,7 +44,7 @@ number
 
 </td><td>
 
-_(Optional)_
+_(Optional)_ The delay in milliseconds before the spinner is shown.
 
 
 </td></tr>

package/lib/index.plugins.d.ts

@@ -22,6 +22,7 @@ export * from "./plugins/seek-time/SeekTime.js";
 export * from "./plugins/share/Share.js";
 export * from "./plugins/skip-time/SkipTime.js";
 export * from "./plugins/spinner-three-bounce/SpinnerThreeBounce.js";
+export { SpinnerThreeBounce as Spinner } from "./plugins/spinner-three-bounce/SpinnerThreeBounce.js";
 export * from "./plugins/source-controller/SourceController.js";
 export * from "./plugins/subtitles/ClosedCaptions.js";
 export { ClosedCaptions as Subtitles } from "./plugins/subtitles/ClosedCaptions.js";