@gcorevideo/player 2.19.12 → 2.19.14

package/docs/api/player.md

@@ -8,7 +8,7 @@ Video player for the Gcore streaming platform
 
 ## Remarks
 
-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.
+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.
 
 ## Classes
 
@@ -52,7 +52,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Adds the gear button that triggers extra options menu on the right side of the [media control](./player.mediacontrol.md) UI
 
 
 </td></tr>
@@ -121,6 +121,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Adds the DVR controls to the media control UI
+
 
 </td></tr>
 <tr><td>
@@ -157,7 +159,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Allows to control the quality level of the playback.
+**_(BETA)_** A [media control](./player.mediacontrol.md) plugin that provides a UI to control the quality level of the playback.
 
 
 </td></tr>
@@ -177,7 +179,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** The MediaControl is responsible for displaying the Player controls.
+**_(BETA)_** The MediaControl provides a foundation for developing custom media controls UI.
 
 
 </td></tr>
@@ -226,6 +228,8 @@ Description
 
 </td><td>
 
+**_(BETA)_** Displays a poster image in the background and a big play button on top when playback is stopped
+
 
 </td></tr>
 <tr><td>
@@ -523,7 +527,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Media control elements, mount points for additional plugins
 
 
 </td></tr>

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

@@ -7,6 +7,8 @@
 > 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
+
 **Signature:**
 
 ```typescript

package/docs/api/player.mediacontrol.disabledcontrolbutton.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.
 > 
 
-Disable the control button
+Disable the user interaction for the control buttons
 
 **Signature:**
 

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

@@ -7,6 +7,8 @@
 > 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.
 > 
 
+Reenables the plugin disabled earlier with the [MediaControl.disable()](./player.mediacontrol.disable.md) method
+
 **Signature:**
 
 ```typescript

package/docs/api/player.mediacontrol.enablecontrolbutton.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.
 > 
 
-Enable the control button
+Enable the user interaction disabled earlier
 
 **Signature:**
 

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

@@ -54,5 +54,23 @@ The name of the media control element
 
 [ZeptoResult](./player.zeptoresult.md) \| null
 
-The DOM node to render the media control element
+The DOM node to render to or extend
+
+## Remarks
+
+Use this method to render custom media control UI in a plugin
+
+## Example
+
+
+```ts
+class MyPlugin extends UICorePlugin {
+  override render() {
+    const mediaControl = this.core.getPlugin('media_control')
+    const clipText = mediaControl.getElement('clipText')
+    clipText?.el.text('Here we go')
+    return this
+  }
+}
+```
 

package/docs/api/player.mediacontrol.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 MediaControl is responsible for displaying the Player controls.
+The MediaControl provides a foundation for developing custom media controls UI.
 
 **Signature:**
 
@@ -18,7 +18,16 @@ export declare class MediaControl extends UICorePlugin
 
 ## Remarks
 
-This plugin provides a foundation for developing a media controls UI via additional plugins. The methods exposed are to be used by the other plugins that extend the media control UI.
+The methods exposed are to be used by the other plugins that extend the media control UI. The plugin registration should be arranged so that MediaControl is initialized before every other plugin that depends on it.
+
+## Example
+
+
+```ts
+Player.registerPlugin(MediaControl) // <--- This must go first
+Player.registerPlugin(LevelSelector) // a media control plugin
+Player.registerPlugin(NerdStats) // another media control plugin
+```
 
 ## Constructors
 
@@ -79,90 +88,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[attributes](./player.mediacontrol.attributes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ class: string; 'data-media-control-skin-1': string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[container](./player.mediacontrol.container.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[disabled](./player.mediacontrol.disabled.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[events](./player.mediacontrol.events.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ 'click \[data-play\]': string; 'click \[data-pause\]': string; 'click \[data-playpause\]': string; 'click \[data-stop\]': string; 'click \[data-playstop\]': string; 'click \[data-fullscreen\]': string; 'click .bar-container\[data-seekbar\]': string; 'click .bar-container\[data-volume\]': string; 'click .drawer-icon\[data-volume\]': string; 'mouseenter .drawer-container\[data-volume\]': string; 'mouseleave .drawer-container\[data-volume\]': string; 'mousedown .bar-container\[data-volume\]': string; 'touchstart .bar-container\[data-volume\]': string; 'mousemove .bar-container\[data-volume\]': string; 'touchmove .bar-container\[data-volume\]': string; 'mousedown .bar-scrubber\[data-seekbar\]': string; 'mousedown .bar-container\[data-seekbar\]': string; 'touchstart .bar-scrubber\[data-seekbar\]': string; 'touchstart .bar-container\[data-seekbar\]': string; 'mousemove .bar-container\[data-seekbar\]': string; 'touchmove .bar-container\[data-seekbar\]': string; 'mouseleave .bar-container\[data-seekbar\]': string; 'touchend .bar-container\[data-seekbar\]': string; 'mouseenter .media-control-layer\[data-controls\]': string; 'mouseleave .media-control-layer\[data-controls\]': string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
 [muted](./player.mediacontrol.muted.md)
 
 
@@ -181,69 +106,6 @@ boolean
 **_(BETA)_** Muted state
 
 
-</td></tr>
-<tr><td>
-
-[name](./player.mediacontrol.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[playback](./player.mediacontrol.playback.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.mediacontrol.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 
@@ -257,12 +119,12 @@ any
 
 </td><td>
 
-any
+number
 
 
 </td><td>
 
-**_(BETA)_** Current volume
+**_(BETA)_** Current volume \[0..100\]
 
 
 </td></tr>
@@ -288,48 +150,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[bindContainerEvents()](./player.mediacontrol.bindcontainerevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[bindEvents()](./player.mediacontrol.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[destroy()](./player.mediacontrol.destroy.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
 [disable()](./player.mediacontrol.disable.md)
 
 
@@ -338,7 +158,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Disables the plugin and unmounts its UI
 
 
 </td></tr>
@@ -352,7 +172,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Disable the control button
+**_(BETA)_** Disable the user interaction for the control buttons
 
 
 </td></tr>
@@ -366,7 +186,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Reenables the plugin disabled earlier with the [MediaControl.disable()](./player.mediacontrol.disable.md) method
 
 
 </td></tr>
@@ -380,7 +200,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Enable the control button
+**_(BETA)_** Enable the user interaction disabled earlier
 
 
 </td></tr>
@@ -397,62 +217,6 @@ Description
 **_(BETA)_** Get a media control element DOM node
 
 
-</td></tr>
-<tr><td>
-
-[getExternalInterface()](./player.mediacontrol.getexternalinterface.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[pause()](./player.mediacontrol.pause.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Pause the playback
-
-
-</td></tr>
-<tr><td>
-
-[play()](./player.mediacontrol.play.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Start the playback
-
-
-</td></tr>
-<tr><td>
-
-[render()](./player.mediacontrol.render.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 
@@ -467,20 +231,6 @@ Description
 **_(BETA)_** Set the initial volume, which is preserved when playback is interrupted by an advertisement
 
 
-</td></tr>
-<tr><td>
-
-[setMuted(value)](./player.mediacontrol.setmuted.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 
@@ -495,19 +245,5 @@ Description
 **_(BETA)_** Set the volume
 
 
-</td></tr>
-<tr><td>
-
-[stop()](./player.mediacontrol.stop.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_** Stop the playback
-
-
 </td></tr>
 </tbody></table>

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

@@ -7,10 +7,10 @@
 > 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.
 > 
 
-Current volume
+Current volume \[0..100\]
 
 **Signature:**
 
 ```typescript
-get volume(): any;
+get volume(): number;
 ```

package/docs/api/player.mediacontrolelement.md

@@ -7,9 +7,10 @@
 > 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.
 > 
 
+Media control elements, mount points for additional plugins
 
 **Signature:**
 
 ```typescript
-export type MediaControlElement = 'clipText' | 'pip' | 'seekBarContainer';
+export type MediaControlElement = 'bottomGear' | 'clipText' | 'pip' | 'playbackRate' | 'seekBarContainer';
 ```

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

@@ -4,6 +4,11 @@
 
 ## Poster.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.
+> 
+
+Disables the plugin, unmounting it from the DOM
+
 **Signature:**
 
 ```typescript

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

@@ -4,6 +4,11 @@
 
 ## Poster.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.
+> 
+
+Reenables earlier disabled plugin
+
 **Signature:**
 
 ```typescript