@gcorevideo/player 2.19.6 → 2.19.8

package/docs/api/player.md

@@ -25,6 +25,191 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[AudioSelector](./player.audioselector.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[BigMuteButton](./player.bigmutebutton.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[BottomGear](./player.bottomgear.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[ClapprNerdStats](./player.clapprnerdstats.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[ClapprStats](./player.clapprstats.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[ClickToPause](./player.clicktopause.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[ClipsPlugin](./player.clipsplugin.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[ContextMenu](./player.contextmenu.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[DisableControls](./player.disablecontrols.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[DvrControls](./player.dvrcontrols.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[ErrorScreen](./player.errorscreen.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[Favicon](./player.favicon.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[GoogleAnalytics](./player.googleanalytics.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[LevelSelector](./player.levelselector.md)
+
+
+</td><td>
+
+**_(BETA)_** Allows to control the quality level of the playback.
+
+
+</td></tr>
+<tr><td>
+
+[Logo](./player.logo.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[MediaControl](./player.mediacontrol.md)
+
+
+</td><td>
+
+**_(BETA)_** The MediaControl is responsible for displaying the Player controls.
+
+
+</td></tr>
+<tr><td>
+
+[MultiCamera](./player.multicamera.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[PictureInPicture](./player.pictureinpicture.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[PlaybackRate](./player.playbackrate.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
 [Player](./player.player.md)
 
 
@@ -33,6 +218,100 @@ Description
 **_(BETA)_** The main component to use in the application code.
 
 
+</td></tr>
+<tr><td>
+
+[Poster](./player.poster.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[SeekTime](./player.seektime.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[Share](./player.share.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[SkipTime](./player.skiptime.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[SourceController](./player.sourcecontroller.md)
+
+
+</td><td>
+
+**_(BETA)_** This plugin is responsible for managing the automatic failover between sources.
+
+
+</td></tr>
+<tr><td>
+
+[SpinnerThreeBounce](./player.spinnerthreebounce.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[Statistics](./player.statistics.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[Subtitles](./player.subtitles.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[Thumbnails](./player.thumbnails.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[VolumeFade](./player.volumefade.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
 </td></tr>
 </tbody></table>
 
@@ -70,6 +349,15 @@ Description
 **_(BETA)_** A top-level event on the player object
 
 
+</td></tr>
+<tr><td>
+
+[VolumeFadeEvents](./player.volumefadeevents.md)
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 
@@ -227,6 +515,17 @@ Description
 **_(BETA)_** An ISO 639-1 language code.
 
 
+</td></tr>
+<tr><td>
+
+[MediaControlElement](./player.mediacontrolelement.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
 </td></tr>
 <tr><td>
 
@@ -337,6 +636,15 @@ Description
 **_(BETA)_**
 
 
+</td></tr>
+<tr><td>
+
+[PluginSettings](./player.pluginsettings.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 
@@ -403,5 +711,16 @@ Description
 **_(BETA)_** Preferred media delivery protocol
 
 
+</td></tr>
+<tr><td>
+
+[ZeptoResult](./player.zeptoresult.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
 </td></tr>
 </tbody></table>

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

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [(constructor)](./player.mediacontrol._constructor_.md)
+
+## MediaControl.(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 `MediaControl` class
+
+**Signature:**
+
+```typescript
+constructor(core: Core);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+core
+
+
+</td><td>
+
+Core
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [attributes](./player.mediacontrol.attributes.md)
+
+## MediaControl.attributes 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
+get attributes(): {
+        class: string;
+        'data-media-control-skin-1': string;
+    };
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [bindContainerEvents](./player.mediacontrol.bindcontainerevents.md)
+
+## MediaControl.bindContainerEvents() 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
+bindContainerEvents(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [bindEvents](./player.mediacontrol.bindevents.md)
+
+## MediaControl.bindEvents() 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
+bindEvents(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [container](./player.mediacontrol.container.md)
+
+## MediaControl.container 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
+get container(): any;
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [destroy](./player.mediacontrol.destroy.md)
+
+## MediaControl.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
+destroy(): import("@clappr/core").UIObject;
+```
+**Returns:**
+
+import("@clappr/core").UIObject
+

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [disable](./player.mediacontrol.disable.md)
+
+## MediaControl.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
+disable(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [disabled](./player.mediacontrol.disabled.md)
+
+## MediaControl.disabled 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
+get disabled(): any;
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [disabledControlButton](./player.mediacontrol.disabledcontrolbutton.md)
+
+## MediaControl.disabledControlButton() 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.
+> 
+
+Disable the control button
+
+**Signature:**
+
+```typescript
+disabledControlButton(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [enable](./player.mediacontrol.enable.md)
+
+## MediaControl.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
+enable(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [enableControlButton](./player.mediacontrol.enablecontrolbutton.md)
+
+## MediaControl.enableControlButton() 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.
+> 
+
+Enable the control button
+
+**Signature:**
+
+```typescript
+enableControlButton(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,40 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [events](./player.mediacontrol.events.md)
+
+## MediaControl.events 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
+get events(): {
+        '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;
+    };
+```

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

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [getElement](./player.mediacontrol.getelement.md)
+
+## MediaControl.getElement() 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 a media control element DOM node
+
+**Signature:**
+
+```typescript
+getElement(name: MediaControlElement): ZeptoResult | null;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+name
+
+
+</td><td>
+
+[MediaControlElement](./player.mediacontrolelement.md)
+
+
+</td><td>
+
+The name of the media control element
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[ZeptoResult](./player.zeptoresult.md) \| null
+
+The DOM node to render the media control element
+