@gcorevideo/player 2.20.9 → 2.20.12

package/docs/api/player.player.unregisterplugin.md

@@ -4,15 +4,12 @@
 
 ## Player.unregisterPlugin() 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.
-> 
-
 Unregisters a plugin registered earlier with [Player.registerPlugin()](./player.player.registerplugin.md)<!-- -->.
 
 **Signature:**
 
 ```typescript
-static unregisterPlugin(plugin: PlayerPluginConstructor): void;
+static unregisterPlugin(name: string): void;
 ```
 
 ## Parameters
@@ -35,17 +32,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-plugin
+name
 
 
 </td><td>
 
-[PlayerPluginConstructor](./player.playerpluginconstructor.md)
+string
 
 
 </td><td>
 
-a plugin class
+name of the plugin
 
 
 </td></tr>
@@ -54,3 +51,13 @@ a plugin class
 
 void
 
+## Remarks
+
+It can be also used to unregister a built-in default plugin.
+
+Currently, the plugins that are always registered are:
+
+- ['strings'](https://github.com/clappr/clappr-core/blob/3126c3a38a6eee9d5aba3918b194e6380fa1178c/src/plugins/strings/strings.js)<!-- -->, which supports internationalization of the player UI
+
+- ['sources'](https://github.com/clappr/clappr-core/blob/3126c3a38a6eee9d5aba3918b194e6380fa1178c/src/plugins/sources/sources.js)<!-- -->, which lets to specify multiple media sources and selects the first suitable playback module
+

package/docs/api/player.playercomponenttype.md

@@ -4,9 +4,6 @@
 
 ## PlayerComponentType 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.
-> 
-
 Subsystems of a player component.
 
 **Signature:**

package/docs/api/player.playerconfig.autoplay.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.autoPlay 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.
-> 
-
 Start playback automatically when the player is ready
 
 **Signature:**

package/docs/api/player.playerconfig.dash.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.dash 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.
-> 
-
 Configuration settings for the DASH playback engine
 
 **Signature:**

package/docs/api/player.playerconfig.debug.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.debug 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.
-> 
-
 Controls the debug output level
 
 **Signature:**

package/docs/api/player.playerconfig.language.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.language 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.
-> 
-
 A language code for the player UI, for example, `es`<!-- -->. Must reference a key in the [strings](./player.playerconfig.strings.md) record.
 
 **Signature:**

package/docs/api/player.playerconfig.loop.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.loop 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.
-> 
-
 Repeat playback when the media ends. Is used with the `vod` [playbackType](./player.playerconfig.playbacktype.md)
 
 **Signature:**

package/docs/api/player.playerconfig.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig 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.
-> 
-
 Configuration options for the player
 
 **Signature:**
@@ -88,7 +85,7 @@ boolean
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ Start playback automatically when the player is ready
+_(Optional)_ Start playback automatically when the player is ready
 
 
 </td></tr>
@@ -107,7 +104,7 @@ boolean
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ Configuration settings for the DASH playback engine
+_(Optional)_ Configuration settings for the DASH playback engine
 
 
 </td></tr>
@@ -126,7 +123,7 @@ boolean
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ Controls the debug output level
+_(Optional)_ Controls the debug output level
 
 
 </td></tr>
@@ -145,7 +142,7 @@ string
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ A language code for the player UI, for example, `es`<!-- -->. Must reference a key in the [strings](./player.playerconfig.strings.md) record.
+_(Optional)_ A language code for the player UI, for example, `es`<!-- -->. Must reference a key in the [strings](./player.playerconfig.strings.md) record.
 
 
 </td></tr>
@@ -164,7 +161,7 @@ boolean
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ Repeat playback when the media ends. Is used with the `vod` [playbackType](./player.playerconfig.playbacktype.md)
+_(Optional)_ Repeat playback when the media ends. Is used with the `vod` [playbackType](./player.playerconfig.playbacktype.md)
 
 
 </td></tr>
@@ -183,7 +180,7 @@ boolean
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ Mute the audio output in order to comply with browsers' autoplay policy.
+_(Optional)_ Mute the audio output in order to comply with browsers' autoplay policy.
 
 
 </td></tr>
@@ -202,7 +199,7 @@ boolean
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ The type of playback (live stream or video on demand).
+_(Optional)_ The type of playback (live stream or video on demand).
 
 
 </td></tr>
@@ -221,7 +218,7 @@ boolean
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ Preferred transport protocol when multiple sources are available.
+_(Optional)_ Preferred transport protocol when multiple sources are available.
 
 
 </td></tr>
@@ -240,7 +237,7 @@ boolean
 
 </td><td>
 
-**_(BETA)_** List of media sources, at least one is required.
+List of media sources, at least one is required.
 
 
 </td></tr>
@@ -259,7 +256,7 @@ boolean
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ Localization strings for the player UI.
+_(Optional)_ Localization strings for the player UI.
 
 
 </td></tr>

package/docs/api/player.playerconfig.mute.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.mute 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.
-> 
-
 Mute the audio output in order to comply with browsers' autoplay policy.
 
 **Signature:**

package/docs/api/player.playerconfig.playbacktype.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.playbackType 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 type of playback (live stream or video on demand).
 
 **Signature:**

package/docs/api/player.playerconfig.prioritytransport.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.priorityTransport 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.
-> 
-
 Preferred transport protocol when multiple sources are available.
 
 **Signature:**

package/docs/api/player.playerconfig.sources.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.sources 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.
-> 
-
 List of media sources, at least one is required.
 
 **Signature:**

package/docs/api/player.playerconfig.strings.md

@@ -4,9 +4,6 @@
 
 ## PlayerConfig.strings 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.
-> 
-
 Localization strings for the player UI.
 
 **Signature:**

package/docs/api/player.playerdebugsettings.md

@@ -4,9 +4,6 @@
 
 ## PlayerDebugSettings 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

package/docs/api/player.playerdebugtag.md

@@ -4,9 +4,6 @@
 
 ## PlayerDebugTag 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.
-> 
-
 Debug output category selector
 
 **Signature:**

package/docs/api/player.playerevent.md

@@ -4,9 +4,6 @@
 
 ## PlayerEvent 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.
-> 
-
 A top-level event on the player object
 
 **Signature:**
@@ -45,7 +42,7 @@ Ended
 
 </td><td>
 
-**_(BETA)_** Playback has reached the end of the media.
+Playback has reached the end of the media.
 
 
 </td></tr>
@@ -61,7 +58,7 @@ Error
 
 </td><td>
 
-**_(BETA)_** An error occurred. Parameters: [PlaybackError](./player.playbackerror.md)
+An error occurred. Parameters: [PlaybackError](./player.playbackerror.md)
 
 
 </td></tr>
@@ -77,7 +74,7 @@ Fullscreen
 
 </td><td>
 
-**_(BETA)_** The player has switched to or from the fullscreen mode. Parameters:`boolean` isFullscreen
+The player has switched to or from the fullscreen mode. Parameters:`boolean` isFullscreen
 
 
 </td></tr>
@@ -93,7 +90,7 @@ Pause
 
 </td><td>
 
-**_(BETA)_** Playback has been paused.
+Playback has been paused.
 
 
 </td></tr>
@@ -109,7 +106,7 @@ Play
 
 </td><td>
 
-**_(BETA)_** Playback has started.
+Playback has started.
 
 
 </td></tr>
@@ -125,7 +122,7 @@ Ready
 
 </td><td>
 
-**_(BETA)_** The player is ready to use.
+The player is ready to use.
 
 
 </td></tr>
@@ -141,7 +138,7 @@ Resize
 
 </td><td>
 
-**_(BETA)_** The player's container has been resized. Parameters: [ContainerSize](./player.containersize.md)
+The player's container has been resized. Parameters: [ContainerSize](./player.containersize.md)
 
 
 </td></tr>
@@ -157,7 +154,7 @@ Seek
 
 </td><td>
 
-**_(BETA)_** The player is seeking to a new position.
+The player is seeking to a new position.
 
 
 </td></tr>
@@ -173,7 +170,7 @@ Stop
 
 </td><td>
 
-**_(BETA)_** Playback has been stopped.
+Playback has been stopped.
 
 
 </td></tr>
@@ -189,7 +186,7 @@ TimeUpdate
 
 </td><td>
 
-**_(BETA)_** The current playback time has changed. Parameters: [TimePosition](./player.timeposition.md)
+The current playback time has changed. Parameters: [TimePosition](./player.timeposition.md)
 
 
 </td></tr>
@@ -205,7 +202,7 @@ VolumeUpdate
 
 </td><td>
 
-**_(BETA)_** The volume has changed. Parameters: `number` volume in the range 0..1
+The volume has changed. Parameters: `number` volume in the range 0..1
 
 
 </td></tr>

package/docs/api/player.playereventhandler.md

@@ -4,9 +4,6 @@
 
 ## PlayerEventHandler 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.
-> 
-
 Type of a listener callback function for a player event. See the description of the event parameters in [PlayerEvent](./player.playerevent.md)<!-- -->.
 
 **Signature:**

package/docs/api/player.playereventparams.md

@@ -4,9 +4,6 @@
 
 ## PlayerEventParams 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:**
 

package/docs/api/player.playermediasource.md

@@ -4,9 +4,6 @@
 
 ## PlayerMediaSource 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.
-> 
-
 A media source to fetch the media data from
 
 **Signature:**

package/docs/api/player.playermediasourcedesc.md

@@ -4,9 +4,6 @@
 
 ## PlayerMediaSourceDesc 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.
-> 
-
 Describes a media source with its MIME type and URL.
 
 **Signature:**
@@ -57,7 +54,7 @@ string
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ The MIME type of the media source (e.g. `"video/mp4"`<!-- -->, `"application/x-mpegURL"`<!-- -->). Necessary if the type cannot be detected from file extension of the source URL.
+_(Optional)_ The MIME type of the media source (e.g. `"video/mp4"`<!-- -->, `"application/x-mpegURL"`<!-- -->). Necessary if the type cannot be detected from file extension of the source URL.
 
 
 </td></tr>
@@ -76,7 +73,7 @@ string
 
 </td><td>
 
-**_(BETA)_** URL of the media source
+URL of the media source
 
 
 </td></tr>

package/docs/api/player.playermediasourcedesc.mimetype.md

@@ -4,9 +4,6 @@
 
 ## PlayerMediaSourceDesc.mimeType 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 MIME type of the media source (e.g. `"video/mp4"`<!-- -->, `"application/x-mpegURL"`<!-- -->). Necessary if the type cannot be detected from file extension of the source URL.
 
 **Signature:**

package/docs/api/player.playermediasourcedesc.source.md

@@ -4,9 +4,6 @@
 
 ## PlayerMediaSourceDesc.source 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.
-> 
-
 URL of the media source
 
 **Signature:**

package/docs/api/player.playerplugin.md

@@ -4,14 +4,10 @@
 
 ## PlayerPlugin 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 PlayerPlugin = {
-    new (...args: any[]): unknown;
     name: string;
 };
 ```

package/docs/api/player.playerpluginconstructor.md

@@ -4,9 +4,6 @@
 
 ## PlayerPluginConstructor 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:**
 

package/docs/api/player.poster.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 a poster image in the background and a big play button on top when playback is stopped
+`PLUGIN` that displays a poster image in the background and a big play button on top when playback is stopped
 
 **Signature:**
 

package/docs/api/player.qualitylevel.bitrate.md

@@ -4,9 +4,6 @@
 
 ## QualityLevel.bitrate 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.
-> 
-
 Bitrate of the video, bps.
 
 **Signature:**

package/docs/api/player.qualitylevel.height.md

@@ -4,9 +4,6 @@
 
 ## QualityLevel.height 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.
-> 
-
 Height of the video, pixels.
 
 **Signature:**

package/docs/api/player.qualitylevel.level.md

@@ -4,9 +4,6 @@
 
 ## QualityLevel.level 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.
-> 
-
 Zero-based index of the quality level.
 
 **Signature:**

package/docs/api/player.qualitylevel.md

@@ -4,9 +4,6 @@
 
 ## QualityLevel 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.
-> 
-
 A level of quality within a media source.
 
 **Signature:**
@@ -53,7 +50,7 @@ number
 
 </td><td>
 
-**_(BETA)_** Bitrate of the video, bps.
+Bitrate of the video, bps.
 
 
 </td></tr>
@@ -72,7 +69,7 @@ number
 
 </td><td>
 
-**_(BETA)_** Height of the video, pixels.
+Height of the video, pixels.
 
 
 </td></tr>
@@ -91,7 +88,7 @@ number
 
 </td><td>
 
-**_(BETA)_** Zero-based index of the quality level.
+Zero-based index of the quality level.
 
 
 </td></tr>
@@ -110,7 +107,7 @@ number
 
 </td><td>
 
-**_(BETA)_** Width of the video, pixels.
+Width of the video, pixels.
 
 
 </td></tr>

package/docs/api/player.qualitylevel.width.md

@@ -4,9 +4,6 @@
 
 ## QualityLevel.width 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.
-> 
-
 Width of the video, pixels.
 
 **Signature:**

package/docs/api/player.seektime.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 seek time indicator to the media control UI.
+`PLUGIN` that adds a seek time indicator to the media control UI.
 
 **Signature:**
 

package/docs/api/player.share.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 share button to the media control UI.
+`PLUGIN` that adds a share button to the media control UI.
 
 **Signature:**
 

package/docs/api/player.skiptime.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 skip controls to the media control UI.
+`PLUGIN` that adds skip controls to the media control UI.
 
 **Signature:**
 

package/docs/api/player.sourcecontroller.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.
 > 
 
-This plugin is responsible for managing the automatic failover between sources.
+`PLUGIN` that is responsible for managing the automatic failover between sources.
 
 **Signature:**
 

package/docs/api/player.spinnerthreebounce.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 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:**
 

package/docs/api/player.subtitles.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.
 > 
 
-A [media control](./player.mediacontrol.md) plugin that provides a UI to select the subtitles when available.
+`PLUGIN` that provides a UI to select the subtitles when available.
 
 **Signature:**