@gcorevideo/player 2.20.8 → 2.20.11

package/docs/api/player.player.md

@@ -4,10 +4,7 @@
 
 ## Player 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.
-> 
-
-The main component to use in the application code.
+`MAIN` component to use in the application code.
 
 **Signature:**
 
@@ -47,7 +44,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Constructs a new instance of the `Player` class
+Constructs a new instance of the `Player` class
 
 
 </td></tr>
@@ -81,7 +78,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Initializes the player at the given container element.
+Initializes the player at the given container element.
 
 
 </td></tr>
@@ -95,7 +92,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Configures the player.
+Configures the player.
 
 
 </td></tr>
@@ -109,7 +106,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Destroys the player, releasing all resources and unmounting its UI from the DOM.
+Destroys the player, releasing all resources and unmounting its UI from the DOM.
 
 
 </td></tr>
@@ -123,7 +120,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Current playback (time since the beginning of the stream), if appropriate.
+Current playback (time since the beginning of the stream), if appropriate.
 
 
 </td></tr>
@@ -137,7 +134,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Duration of the current media in seconds, if appropriate.
+Duration of the current media in seconds, if appropriate.
 
 
 </td></tr>
@@ -151,7 +148,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Gets the current volume of the media content being played.
+Gets the current volume of the media content being played.
 
 
 </td></tr>
@@ -165,7 +162,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Indicates whether DVR is enabled.
+Indicates whether DVR is enabled.
 
 
 </td></tr>
@@ -179,7 +176,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Indicates whether DVR is in use.
+Indicates whether DVR is in use.
 
 
 </td></tr>
@@ -193,7 +190,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Indicates muted state of the video.
+Indicates muted state of the video.
 
 
 </td></tr>
@@ -207,7 +204,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Indicates the playing state.
+Indicates the playing state.
 
 
 </td></tr>
@@ -221,7 +218,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Mutes the sound of the video.
+Mutes the sound of the video.
 
 
 </td></tr>
@@ -235,7 +232,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Removes a previously added event listener
+Removes a previously added event listener
 
 
 </td></tr>
@@ -249,7 +246,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Adds a listener to a player event
+Adds a listener to a player event
 
 
 </td></tr>
@@ -263,7 +260,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Pauses playback.
+Pauses playback.
 
 
 </td></tr>
@@ -277,7 +274,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Starts playback.
+Starts playback.
 
 
 </td></tr>
@@ -293,7 +290,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Registers a plugin.
+Registers a plugin.
 
 
 </td></tr>
@@ -307,7 +304,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Resizes the player container element and everything within it.
+Resizes the player container element and everything within it.
 
 
 </td></tr>
@@ -321,7 +318,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Seeks to the given time.
+Seeks to the given time.
 
 
 </td></tr>
@@ -335,7 +332,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Sets the current volume of the media content being played.
+Sets the current volume of the media content being played.
 
 
 </td></tr>
@@ -349,7 +346,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Stops playback.
+Stops playback.
 
 
 </td></tr>
@@ -363,13 +360,13 @@ Description
 
 </td><td>
 
-**_(BETA)_** Unmutes the video sound.
+Unmutes the video sound.
 
 
 </td></tr>
 <tr><td>
 
-[unregisterPlugin(plugin)](./player.player.unregisterplugin.md)
+[unregisterPlugin(name)](./player.player.unregisterplugin.md)
 
 
 </td><td>
@@ -379,7 +376,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Unregisters a plugin registered earlier with [Player.registerPlugin()](./player.player.registerplugin.md)<!-- -->.
+Unregisters a plugin registered earlier with [Player.registerPlugin()](./player.player.registerplugin.md)<!-- -->.
 
 
 </td></tr>

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

@@ -4,9 +4,6 @@
 
 ## Player.mute() 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.
-> 
-
 Mutes the sound of the video.
 
 **Signature:**

package/docs/api/player.player.off.md

@@ -4,9 +4,6 @@
 
 ## Player.off() 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.
-> 
-
 Removes a previously added event listener
 
 **Signature:**

package/docs/api/player.player.on.md

@@ -4,9 +4,6 @@
 
 ## Player.on() 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 listener to a player event
 
 **Signature:**

package/docs/api/player.player.pause.md

@@ -4,9 +4,6 @@
 
 ## Player.pause() 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.
-> 
-
 Pauses playback.
 
 **Signature:**

package/docs/api/player.player.play.md

@@ -4,9 +4,6 @@
 
 ## Player.play() 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.
-> 
-
 Starts playback.
 
 **Signature:**

package/docs/api/player.player.registerplugin.md

@@ -4,15 +4,12 @@
 
 ## Player.registerPlugin() 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.
-> 
-
 Registers a plugin.
 
 **Signature:**
 
 ```typescript
-static registerPlugin(plugin: PlayerPlugin): void;
+static registerPlugin(plugin: PlayerPluginConstructor): void;
 ```
 
 ## Parameters
@@ -40,7 +37,7 @@ plugin
 
 </td><td>
 
-[PlayerPlugin](./player.playerplugin.md)
+[PlayerPluginConstructor](./player.playerpluginconstructor.md)
 
 
 </td><td>

package/docs/api/player.player.resize.md

@@ -4,9 +4,6 @@
 
 ## Player.resize() 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.
-> 
-
 Resizes the player container element and everything within it.
 
 **Signature:**

package/docs/api/player.player.seek.md

@@ -4,9 +4,6 @@
 
 ## Player.seek() 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.
-> 
-
 Seeks to the given time.
 
 **Signature:**

package/docs/api/player.player.setvolume.md

@@ -4,9 +4,6 @@
 
 ## Player.setVolume() 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.
-> 
-
 Sets the current volume of the media content being played.
 
 **Signature:**

package/docs/api/player.player.stop.md

@@ -4,9 +4,6 @@
 
 ## Player.stop() 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.
-> 
-
 Stops playback.
 
 **Signature:**

package/docs/api/player.player.unmute.md

@@ -4,9 +4,6 @@
 
 ## Player.unmute() 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.
-> 
-
 Unmutes the video sound.
 
 **Signature:**

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: PlayerPlugin): void;
+static unregisterPlugin(name: string): void;
 ```
 
 ## Parameters
@@ -35,17 +32,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-plugin
+name
 
 
 </td><td>
 
-[PlayerPlugin](./player.playerplugin.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:**