@gcorevideo/player 2.25.10 → 2.26.0

package/docs/api/player.bigmutebutton.md

@@ -4,9 +4,6 @@
 
 ## BigMuteButton 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 a big mute button over the video when it's being played muted.
 
 **Signature:**

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

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

package/docs/api/player.bottomgear.md

@@ -4,9 +4,6 @@
 
 ## BottomGear 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 adds a button to extend the media controls UI with extra options.
 
 **Signature:**
@@ -110,7 +107,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Adds a custom option to the gear menu
+Adds a custom option to the gear menu
 
 
 </td></tr>
@@ -124,7 +121,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Collapses any submenu open back to the gear menu.
+Collapses any submenu open back to the gear menu.
 
 
 </td></tr>

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

@@ -4,9 +4,6 @@
 
 ## BottomGear.refresh() 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.
-> 
-
 Collapses any submenu open back to the gear menu.
 
 **Signature:**

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

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

package/docs/api/player.clapprstats.clearmetrics.md

@@ -4,9 +4,6 @@
 
 ## ClapprStats.clearMetrics() 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.
-> 
-
 **Signature:**
 
 ```typescript

package/docs/api/player.clapprstats.exportmetrics.md

@@ -4,9 +4,6 @@
 
 ## ClapprStats.exportMetrics() 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.
-> 
-
 Returns the collected metrics.
 
 **Signature:**
@@ -18,5 +15,5 @@ exportMetrics(): ClapprStatsMetrics;
 
 [ClapprStatsMetrics](./player.clapprstatsmetrics.md)
 
-Measurements collected so far
+[Measurements](./player.clapprstatsmetrics.md) collected so far
 

package/docs/api/player.clapprstats.md

@@ -4,9 +4,6 @@
 
 ## ClapprStats 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 measures data about playback, which can be useful for analyzing performance and UX.
 
 **Signature:**
@@ -48,7 +45,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Constructs a new instance of the `ClapprStats` class
+Constructs a new instance of the `ClapprStats` class
 
 
 </td></tr>
@@ -82,8 +79,6 @@ Description
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -96,7 +91,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Returns the collected metrics.
+Returns the collected metrics.
 
 
 </td></tr>

package/docs/api/player.clapprstatsbitratetrack.md

@@ -4,9 +4,6 @@
 
 ## ClapprStatsBitrateTrack 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.clapprstatschronograph.md

@@ -4,9 +4,6 @@
 
 ## ClapprStatsChronograph 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.
-> 
-
 
 **Signature:**
 
@@ -44,8 +41,6 @@ Buffering
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -60,8 +55,6 @@ Pause
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -76,8 +69,6 @@ Session
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -92,8 +83,6 @@ Startup
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -108,8 +97,6 @@ Watch
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 </tbody></table>

package/docs/api/player.clapprstatscounter.md

@@ -4,9 +4,6 @@
 
 ## ClapprStatsCounter 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.
-> 
-
 
 **Signature:**
 
@@ -44,8 +41,6 @@ Buffering
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -60,8 +55,6 @@ ChangeLevel
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -76,8 +69,6 @@ DecodedFrames
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -92,8 +83,6 @@ DroppedFrames
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -108,8 +97,6 @@ DvrUsage
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -124,8 +111,6 @@ Error
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -140,8 +125,6 @@ Fps
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -156,8 +139,6 @@ Fullscreen
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -172,8 +153,6 @@ Pause
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -188,8 +167,6 @@ Play
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -204,8 +181,6 @@ Seek
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 </tbody></table>

package/docs/api/player.clapprstatsevents.md

@@ -4,9 +4,6 @@
 
 ## ClapprStatsEvents 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.
-> 
-
 
 **Signature:**
 
@@ -44,7 +41,7 @@ REPORT
 
 </td><td>
 
-**_(BETA)_** Emitted periodically with current measurements.
+Emitted periodically with current measurements.
 
 
 </td></tr>

package/docs/api/player.clapprstatsmetrics.md

@@ -4,9 +4,6 @@
 
 ## ClapprStatsMetrics 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.clapprstatssettings.md

@@ -4,9 +4,6 @@
 
 ## ClapprStatsSettings 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.
-> 
-
 Config options for the [ClapprStats](./player.clapprstats.md) plugin
 
 **Signature:**
@@ -53,7 +50,7 @@ number
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ The interval in milliseconds of periodic measurements. The plugin will emit a [ClapprStatsEvents.REPORT](./player.clapprstatsevents.md) event with the collected metrics at the specified interval.
+_(Optional)_ The interval in milliseconds of periodic measurements. The plugin will emit a [ClapprStatsEvents.REPORT](./player.clapprstatsevents.md) event with the collected metrics at the specified interval.
 
 
 </td></tr>

package/docs/api/player.clapprstatssettings.runeach.md

@@ -4,9 +4,6 @@
 
 ## ClapprStatsSettings.runEach 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 interval in milliseconds of periodic measurements. The plugin will emit a [ClapprStatsEvents.REPORT](./player.clapprstatsevents.md) event with the collected metrics at the specified interval.
 
 **Signature:**

package/docs/api/player.clicktopause.md

@@ -4,9 +4,6 @@
 
 ## ClickToPause 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.
-> 
-
 A small `PLUGIN` that toggles the playback state on click over the video container
 
 **Signature:**

package/docs/api/player.clips.destroy.md

@@ -4,9 +4,6 @@
 
 ## Clips.destroy() 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.
-> 
-
 **Signature:**
 
 ```typescript

package/docs/api/player.clips.disable.md

@@ -4,9 +4,6 @@
 
 ## Clips.disable() 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.
-> 
-
 **Signature:**
 
 ```typescript

package/docs/api/player.clips.enable.md

@@ -4,9 +4,6 @@
 
 ## Clips.enable() 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.
-> 
-
 **Signature:**
 
 ```typescript

package/docs/api/player.clips.gettext.md

@@ -4,9 +4,6 @@
 
 ## Clips.getText() 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.
-> 
-
 Get the text of the clip at the given time
 
 **Signature:**

package/docs/api/player.clips.md

@@ -4,9 +4,6 @@
 
 ## Clips 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 allows marking up the timeline of the video
 
 **Signature:**
@@ -66,8 +63,6 @@ Description
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -87,8 +82,6 @@ string
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 </tbody></table>
@@ -121,8 +114,6 @@ Description
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -135,8 +126,6 @@ Description
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -149,8 +138,6 @@ Description
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 <tr><td>
@@ -163,7 +150,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Get the text of the clip at the given time
+Get the text of the clip at the given time
 
 
 </td></tr>
@@ -177,8 +164,6 @@ Description
 
 </td><td>
 
-**_(BETA)_**
-
 
 </td></tr>
 </tbody></table>

package/docs/api/player.clips.render.md

@@ -4,9 +4,6 @@
 
 ## Clips.render() 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.
-> 
-
 **Signature:**
 
 ```typescript

package/docs/api/player.clips.supportedversion.md

@@ -4,9 +4,6 @@
 
 ## Clips.supportedVersion 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.
-> 
-
 **Signature:**
 
 ```typescript

package/docs/api/player.clips.version.md

@@ -4,9 +4,6 @@
 
 ## Clips.version 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.
-> 
-
 **Signature:**
 
 ```typescript

package/docs/api/player.clipspluginsettings.md

@@ -4,9 +4,6 @@
 
 ## ClipsPluginSettings 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 [Clips](./player.clips.md) plugin.
 
 **Signature:**
@@ -53,7 +50,7 @@ string
 
 </td><td>
 
-**_(BETA)_** The compiled text of the clips description, one clip per line in format: `HH:MM:SS text` or `MM:SS text` or `SS text`
+The compiled text of the clips description, one clip per line in format: `HH:MM:SS text` or `MM:SS text` or `SS text`
 
 
 </td></tr>

package/docs/api/player.clipspluginsettings.text.md

@@ -4,9 +4,6 @@
 
 ## ClipsPluginSettings.text 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 compiled text of the clips description, one clip per line in format: `HH:MM:SS text` or `MM:SS text` or `SS text`
 
 **Signature:**

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

@@ -4,9 +4,6 @@
 
 ## ClosedCaptions.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 subtitles menu and the subtitles.
 
 **Signature:**

package/docs/api/player.closedcaptions.md

@@ -4,9 +4,6 @@
 
 ## ClosedCaptions 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 provides a UI to select the subtitles when available.
 
 **Signature:**
@@ -26,6 +23,10 @@ Depends on:
 
 Configuration options - [ClosedCaptionsPluginSettings](./player.closedcaptionspluginsettings.md)
 
+Known issues:
+
+1. When media source changes, the subtitles tracks aren't reloaded. Possible solution: use `playback.recycleVideo = false` [main config option](./player.playerconfig.md)<!-- -->, which will force new video element creation every time media source changes. However, this may lead to other issues, such as autoplay not working (after media source has been changed). [related discussion](https://github.com/video-dev/hls.js/issues/2198)
+
 ## Example
 
 
@@ -70,7 +71,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Hides the subtitles menu and the subtitles.
+Hides the subtitles menu and the subtitles.
 
 
 </td></tr>
@@ -84,7 +85,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Shows the subtitles menu and the subtitles.
+Shows the subtitles menu and the subtitles.
 
 
 </td></tr>

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

@@ -4,9 +4,6 @@
 
 ## ClosedCaptions.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 subtitles menu and the subtitles.
 
 **Signature:**

package/docs/api/player.closedcaptionspluginsettings.md

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

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

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

package/docs/api/player.cmcdconfig.exportids.md

@@ -4,9 +4,6 @@
 
 ## CmcdConfig.exportIds() 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.
-> 
-
 Returns the current `sid` and `cid` values. Useful when the auto-generated values need to be known.
 
 **Signature:**

package/docs/api/player.cmcdconfig.md

@@ -4,9 +4,6 @@
 
 ## CmcdConfig 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.
-> 
-
 A `PLUGIN` that configures [CMCD](https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf) for playback
 
 **Signature:**
@@ -64,7 +61,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Constructs a new instance of the `CmcdConfig` class
+Constructs a new instance of the `CmcdConfig` class
 
 
 </td></tr>
@@ -98,7 +95,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Returns the current `sid` and `cid` values. Useful when the auto-generated values need to be known.
+Returns the current `sid` and `cid` values. Useful when the auto-generated values need to be known.
 
 
 </td></tr>