@gcorevideo/player 2.20.8 → 2.20.11

package/docs/api/{player.errorscreen.unbindevents.md → player.levelselectorpluginsettings.restrictresolution.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; [ErrorScreen](./player.errorscreen.md) &gt; [unBindEvents](./player.errorscreen.unbindevents.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md) &gt; [restrictResolution](./player.levelselectorpluginsettings.restrictresolution.md)
 
-## ErrorScreen.unBindEvents() method
+## LevelSelectorPluginSettings.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.
 > 
 
+The maximum resolution to allow in the level selector.
+
 **Signature:**
 
 ```typescript
-unBindEvents(): void;
+restrictResolution?: number;
 ```
-**Returns:**
-
-void
-

package/docs/api/player.logo.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 custom logo to the player.
+`PLUGIN` that adds custom logo to the player.
 
 **Signature:**
 

package/docs/api/player.md

@@ -10,6 +10,26 @@ Video player for the Gcore streaming platform
 
 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.
 
+Various plugins (marked with `PLUGIN` keyword) are available to extend the player with additional features.
+
+## Example
+
+
+```ts
+import { Player, MediaControl, ErrorScreen } from '@gcorevideo/player'
+
+Player.registerPlugin(MediaControl)
+Player.registerPlugin(ErrorScreen)
+
+const player = new Player({
+  autoPlay: true,
+  mute: true,
+  sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],
+})
+
+player.attachTo(document.getElementById('container'))
+```
+
 ## Classes
 
 <table><thead><tr><th>
@@ -30,7 +50,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Adds an audio track selector to the media control UI.
+**_(BETA)_** `PLUGIN` that adds an audio track selector to the media control UI.
 
 
 </td></tr>
@@ -41,7 +61,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Displays a big mute button over the video when it's muted. Once pressed, it unmutes the video.
+**_(BETA)_** `PLUGIN` that displays a big mute button over the video when it's muted. Once pressed, it unmutes the video.
 
 
 </td></tr>
@@ -52,7 +72,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Adds the gear button that triggers extra options menu on the right side of the [media control](./player.mediacontrol.md) UI
+**_(BETA)_** `PLUGIN` that adds the gear button with an extra options menu on the right side of the [media control](./player.mediacontrol.md) UI
 
 
 </td></tr>
@@ -63,7 +83,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Displays useful network-related statistics.
+**_(BETA)_** `PLUGIN` that displays useful network-related statistics.
 
 
 </td></tr>
@@ -74,7 +94,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Collects useful statistics about playback performance.
+**_(BETA)_** `PLUGIN` that collects useful statistics about playback performance.
 
 
 </td></tr>
@@ -85,7 +105,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Adds a behavior of toggling the playback state on click over the container
+**_(BETA)_** `PLUGIN` that adds a behavior of toggling the playback state on click over the container
 
 
 </td></tr>
@@ -96,7 +116,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Adds a behavior of showing a text over the seekbar to indicate the current clip.
+**_(BETA)_** `PLUGIN` that shows text over the seekbar to indicate the current clip.
 
 
 </td></tr>
@@ -107,7 +127,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Displays a small context menu when clicked on the player container.
+**_(BETA)_** `PLUGIN` that displays a small context menu when clicked on the player container.
 
 
 </td></tr>
@@ -118,7 +138,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Adds the DVR controls to the media control UI
+**_(BETA)_** `PLUGIN` that adds the DVR controls to the media control UI
 
 
 </td></tr>
@@ -129,7 +149,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Displays a descriptive error in the overlay on top of the player.
+**_(BETA)_** `PLUGIN` that displays errors nicely in the overlay on top of the player.
 
 
 </td></tr>
@@ -140,7 +160,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** The plugin adds custom favicon to the player's tab.
+**_(BETA)_** `PLUGIN` that adds custom favicon to the player's tab.
 
 
 </td></tr>
@@ -151,7 +171,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** An example Google Analytics integration plugin
+**_(BETA)_** `PLUGIN` that integrates with Google Analytics
 
 
 </td></tr>
@@ -162,7 +182,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** A [media control](./player.mediacontrol.md) plugin that provides a UI to control the quality level of the playback.
+**_(BETA)_** `PLUGIN` that provides a UI to select the desired quality level of the playback.
 
 
 </td></tr>
@@ -173,7 +193,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** The plugin adds custom logo to the player.
+**_(BETA)_** `PLUGIN` that adds custom logo to the player.
 
 
 </td></tr>
@@ -184,7 +204,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** The MediaControl provides a foundation for developing custom media controls UI.
+**_(BETA)_** `PLUGIN` that provides a foundation for developing custom media controls UI.
 
 
 </td></tr>
@@ -195,7 +215,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** The plugin adds support for loading multiple streams and switching between them using the media control UI.
+**_(BETA)_** `PLUGIN` that adds support for loading multiple streams and switching between them using the media control UI.
 
 
 </td></tr>
@@ -206,7 +226,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Enables picture in picture mode.
+**_(BETA)_** `PLUGIN` that enables picture in picture mode.
 
 
 </td></tr>
@@ -217,7 +237,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Allows changing the playback speed of the video.
+**_(BETA)_** `PLUGIN` that allows changing the playback speed of the video.
 
 
 </td></tr>
@@ -228,7 +248,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** The main component to use in the application code.
+`MAIN` component to use in the application code.
 
 
 </td></tr>
@@ -239,7 +259,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Displays a poster image in the background and a big play button on top when playback is stopped
+**_(BETA)_** `PLUGIN` that displays a poster image in the background and a big play button on top when playback is stopped
 
 
 </td></tr>
@@ -250,7 +270,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** The plugin adds a seek time indicator to the media control UI.
+**_(BETA)_** `PLUGIN` that adds a seek time indicator to the media control UI.
 
 
 </td></tr>
@@ -261,7 +281,7 @@ Description
 
 </td><td>
 
-The plugin adds a share button to the media control UI.
+**_(BETA)_** `PLUGIN` that adds a share button to the media control UI.
 
 
 </td></tr>
@@ -272,7 +292,7 @@ The plugin adds a share button to the media control UI.
 
 </td><td>
 
-The plugin adds skip controls to the media control UI.
+**_(BETA)_** `PLUGIN` that adds skip controls to the media control UI.
 
 
 </td></tr>
@@ -283,7 +303,7 @@ The plugin adds skip controls to the media control UI.
 
 </td><td>
 
-**_(BETA)_** This plugin is responsible for managing the automatic failover between sources.
+**_(BETA)_** `PLUGIN` that is responsible for managing the automatic failover between sources.
 
 
 </td></tr>
@@ -294,7 +314,7 @@ The plugin adds skip controls to the media control UI.
 
 </td><td>
 
-**_(BETA)_** Shows a pending operation indicator when playback is buffering or in other appropriate cases
+**_(BETA)_** `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state
 
 
 </td></tr>
@@ -305,7 +325,7 @@ The plugin adds skip controls to the media control UI.
 
 </td><td>
 
-**_(BETA)_** A [media control](./player.mediacontrol.md) plugin that provides a UI to select the subtitles when available.
+**_(BETA)_** `PLUGIN` that provides a UI to select the subtitles when available.
 
 
 </td></tr>
@@ -316,7 +336,7 @@ The plugin adds skip controls to the media control UI.
 
 </td><td>
 
-**_(BETA)_** Collects and reports the performance statistics.
+**_(BETA)_** `PLUGIN` that collects and reports the performance statistics.
 
 
 </td></tr>
@@ -327,7 +347,7 @@ The plugin adds skip controls to the media control UI.
 
 </td><td>
 
-**_(BETA)_** Displays the thumbnails of the video when available.
+**_(BETA)_** `PLUGIN` that displays the thumbnails of the video when available.
 
 
 </td></tr>
@@ -338,7 +358,7 @@ The plugin adds skip controls to the media control UI.
 
 </td><td>
 
-**_(BETA)_** Applies fade effect to the player's volume change.
+**_(BETA)_** `PLUGIN` that applies fade effect to the player's volume change.
 
 
 </td></tr>
@@ -359,12 +379,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[GearEvents](./player.gearevents.md)
+[MediaControlEvents](./player.mediacontrolevents.md)
 
 
 </td><td>
 
-**_(BETA)_** Custom events emitted by the plugin
+**_(BETA)_** Custom events emitted by the plugins to communicate with one another
 
 
 </td></tr>
@@ -375,7 +395,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Codes of errors occurring within the playback component.
+Codes of errors occurring within the playback component.
 
 
 </td></tr>
@@ -386,7 +406,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** A top-level event on the player object
+A top-level event on the player object
 
 
 </td></tr>
@@ -397,7 +417,7 @@ Description
 
 </td><td>
 
-Custom events emitted by the plugin
+**_(BETA)_** Custom events emitted by the plugin
 
 
 </td></tr>
@@ -471,7 +491,7 @@ Description
 
 </td><td>
 
-Configuration options
+**_(BETA)_** Configuration options for the [clips](./player.clipsplugin.md) plugin.
 
 
 </td></tr>
@@ -496,6 +516,17 @@ Configuration options
 **_(BETA)_** Telemetry init event data
 
 
+</td></tr>
+<tr><td>
+
+[LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Configuration options for the [level selector](./player.levelselector.md) plugin.
+
+
 </td></tr>
 <tr><td>
 
@@ -504,7 +535,7 @@ Configuration options
 
 </td><td>
 
-**_(BETA)_** An error occurred during the playback.
+An error occurred during the playback.
 
 
 </td></tr>
@@ -515,7 +546,7 @@ Configuration options
 
 </td><td>
 
-**_(BETA)_** Configuration options for the player
+Configuration options for the player
 
 
 </td></tr>
@@ -526,7 +557,7 @@ Configuration options
 
 </td><td>
 
-**_(BETA)_** Describes a media source with its MIME type and URL.
+Describes a media source with its MIME type and URL.
 
 
 </td></tr>
@@ -537,7 +568,7 @@ Configuration options
 
 </td><td>
 
-**_(BETA)_** A level of quality within a media source.
+A level of quality within a media source.
 
 
 </td></tr>
@@ -581,7 +612,7 @@ Configuration options
 
 </td><td>
 
-**_(BETA)_** Current playback time and total duration of the media.
+Current playback time and total duration of the media.
 
 
 </td></tr>
@@ -613,12 +644,32 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[ContainerPluginConstructor](./player.containerpluginconstructor.md)
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
 [ContainerSize](./player.containersize.md)
 
 
 </td><td>
 
-**_(BETA)_** Dimensions of the player container DOM element.
+Dimensions of the player container DOM element.
+
+
+</td></tr>
+<tr><td>
+
+[CorePluginConstructor](./player.corepluginconstructor.md)
+
+
+</td><td>
+
 
 
 </td></tr>
@@ -629,7 +680,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** A plain JS object that must conform to the DASH.js settings schema.
+A plain JS object that must conform to the DASH.js settings schema.
 
 [DASH.js settings](https://cdn.dashjs.org/latest/jsdoc/module-Settings.html)
 
@@ -642,51 +693,51 @@ Description
 
 </td><td>
 
-**_(BETA)_** Levels of severity of errors. Non-fatal errors usually can be ignored.
+Levels of severity of errors. Non-fatal errors usually can be ignored.
 
 
 </td></tr>
 <tr><td>
 
-[GearItemElement](./player.gearitemelement.md)
+[ErrorScreenPluginSettings](./player.errorscreenpluginsettings.md)
 
 
 </td><td>
 
-**_(BETA)_** An element inside the gear menu
+**_(BETA)_** Configuration options for the [error screen](./player.errorscreen.md) plugin.
 
 
 </td></tr>
 <tr><td>
 
-[LangTag](./player.langtag.md)
+[GearItemElement](./player.gearitemelement.md)
 
 
 </td><td>
 
-**_(BETA)_** An ISO 639-1 language code.
+**_(BETA)_** An element inside the gear menu
 
 
 </td></tr>
 <tr><td>
 
-[MediaControlElement](./player.mediacontrolelement.md)
+[LangTag](./player.langtag.md)
 
 
 </td><td>
 
-**_(BETA)_** Media control elements, mount points for additional plugins
+An ISO 639-1 language code.
 
 
 </td></tr>
 <tr><td>
 
-[MediaTransport](./player.mediatransport.md)
+[MediaControlElement](./player.mediacontrolelement.md)
 
 
 </td><td>
 
-**_(BETA)_** Media delivery protocol
+**_(BETA)_** Media control elements, mount points for additional plugins
 
 
 </td></tr>
@@ -697,7 +748,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Module to perform the playback.
+Module to perform the playback.
 
 
 </td></tr>
@@ -708,7 +759,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Type of a stream playback
+Type of a stream
 
 
 </td></tr>
@@ -719,7 +770,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Subsystems of a player component.
+Subsystems of a player component.
 
 
 </td></tr>
@@ -730,8 +781,6 @@ Description
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -741,7 +790,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Debug output category selector
+Debug output category selector
 
 
 </td></tr>
@@ -752,7 +801,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Type of a listener callback function for a player event. See the description of the event parameters in [PlayerEvent](./player.playerevent.md)<!-- -->.
+Type of a listener callback function for a player event. See the description of the event parameters in [PlayerEvent](./player.playerevent.md)<!-- -->.
 
 
 </td></tr>
@@ -763,7 +812,6 @@ Description
 
 </td><td>
 
-**_(BETA)_**
 
 
 </td></tr>
@@ -774,7 +822,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** A media source to fetch the media data from
+A media source to fetch the media data from
 
 
 </td></tr>
@@ -785,7 +833,15 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+
+</td></tr>
+<tr><td>
+
+[PlayerPluginConstructor](./player.playerpluginconstructor.md)
+
+
+</td><td>
+
 
 
 </td></tr>
@@ -810,6 +866,17 @@ Description
 **_(BETA)_** Telemetry record
 
 
+</td></tr>
+<tr><td>
+
+[TelemetrySendFn](./player.telemetrysendfn.md)
+
+
+</td><td>
+
+**_(BETA)_** Callback to send the telemetry record to the storage.
+
+
 </td></tr>
 <tr><td>
 
@@ -851,7 +918,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Playback time in seconds since the beginning of the stream (or a segment for the live streams)
+Playback time in seconds since the beginning of the stream (or a segment for the live streams)
 
 
 </td></tr>
@@ -862,7 +929,6 @@ Description
 
 </td><td>
 
-**_(BETA)_**
 
 
 </td></tr>
@@ -873,7 +939,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Localization strings for the player UI.
+Localization strings for the player UI.
 
 
 </td></tr>
@@ -884,7 +950,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Preferred media delivery protocol
+Preferred streaming media delivery protocol
 
 
 </td></tr>

package/docs/api/{player.errorscreen.container.md → player.mediacontrol.currentseekpos.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; [ErrorScreen](./player.errorscreen.md) &gt; [container](./player.errorscreen.container.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [currentSeekPos](./player.mediacontrol.currentseekpos.md)
 
-## ErrorScreen.container property
+## MediaControl.currentSeekPos 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
-get container(): any;
+get currentSeekPos(): number;
 ```

package/docs/api/player.mediacontrol.disable.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.
 > 
 
-Disables the plugin and unmounts its UI
+Hides the media control UI
 
 **Signature:**