@gcorevideo/player 2.20.1 → 2.20.4

package/docs/api/player.contextmenupluginsettings.md

@@ -0,0 +1,98 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md)
+
+## ContextMenuPluginSettings 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.
+> 
+
+The plugin adds a context menu to the player.
+
+**Signature:**
+
+```typescript
+export interface ContextMenuPluginSettings 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[label?](./player.contextmenupluginsettings.label.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[preventShowContextMenu?](./player.contextmenupluginsettings.preventshowcontextmenu.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[url?](./player.contextmenupluginsettings.url.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+</tbody></table>

package/docs/api/{player.audioselector.attributes.md → player.contextmenupluginsettings.preventshowcontextmenu.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [AudioSelector](./player.audioselector.md) &gt; [attributes](./player.audioselector.attributes.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md) &gt; [preventShowContextMenu](./player.contextmenupluginsettings.preventshowcontextmenu.md)
 
-## AudioSelector.attributes property
+## ContextMenuPluginSettings.preventShowContextMenu 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.
 > 
@@ -10,8 +10,5 @@
 **Signature:**
 
 ```typescript
-get attributes(): {
-        class: string;
-        'data-track-selector': string;
-    };
+preventShowContextMenu?: boolean;
 ```

package/docs/api/{player.audioselector.reload.md → player.contextmenupluginsettings.url.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [AudioSelector](./player.audioselector.md) &gt; [reload](./player.audioselector.reload.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ContextMenuPluginSettings](./player.contextmenupluginsettings.md) &gt; [url](./player.contextmenupluginsettings.url.md)
 
-## AudioSelector.reload() method
+## ContextMenuPluginSettings.url 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.
 > 
@@ -10,9 +10,5 @@
 **Signature:**
 
 ```typescript
-reload(): void;
+url?: string;
 ```
-**Returns:**
-
-void
-

package/docs/api/player.dvrcontrols.md

@@ -20,7 +20,7 @@ export declare class DvrControls extends UICorePlugin
 
 Depends on:
 
-- [media\_control](./player.mediacontrol.md)
+- [MediaControl](./player.mediacontrol.md)
 
 The plugin renders the live stream indicator and the DVR seek bar, if DVR is enabled, in the media control UI.
 

package/docs/api/player.errorscreen.md

@@ -9,8 +9,6 @@
 
 Displays a descriptive error in the overlay on top of the player.
 
-TODO
-
 **Signature:**
 
 ```typescript

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

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

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

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

package/docs/api/player.favicon.configure.md

@@ -4,6 +4,9 @@
 
 ## Favicon.configure() 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.favicon.destroy.md

@@ -4,6 +4,9 @@
 
 ## Favicon.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.favicon.disable.md

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

@@ -4,6 +4,11 @@
 
 ## Favicon 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 plugin adds custom favicon to the player's tab.
+
 **Signature:**
 
 ```typescript
@@ -39,7 +44,7 @@ Description
 
 </td><td>
 
-Constructs a new instance of the `Favicon` class
+**_(BETA)_** Constructs a new instance of the `Favicon` class
 
 
 </td></tr>
@@ -85,6 +90,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -104,6 +111,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>
@@ -136,6 +145,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -148,6 +159,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -160,6 +173,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -172,6 +187,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>

package/docs/api/player.favicon.name.md

@@ -4,6 +4,9 @@
 
 ## Favicon.name 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.favicon.supportedversion.md

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

@@ -4,6 +4,9 @@
 
 ## GearEvents 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.
+> 
+
 Custom events emitted by the plugin
 
 **Signature:**
@@ -42,7 +45,7 @@ MEDIACONTROL\_GEAR\_RENDERED
 
 </td><td>
 
-Emitted when the gear menu is rendered
+**_(BETA)_** Emitted when the gear menu is rendered
 
 
 </td></tr>

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

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

package/docs/api/player.googleanalytics.addeventlisteners.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.addEventListeners() 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.googleanalytics.embedscript.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.embedScript() 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.googleanalytics.md

@@ -4,6 +4,11 @@
 
 ## GoogleAnalytics 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.
+> 
+
+An example Google Analytics integration plugin
+
 **Signature:**
 
 ```typescript
@@ -39,7 +44,7 @@ Description
 
 </td><td>
 
-Constructs a new instance of the `GoogleAnalytics` class
+**_(BETA)_** Constructs a new instance of the `GoogleAnalytics` class
 
 
 </td></tr>
@@ -85,6 +90,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -104,6 +111,8 @@ string
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>
@@ -136,6 +145,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -148,6 +159,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -160,6 +173,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -172,6 +187,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -184,6 +201,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -196,6 +215,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -208,6 +229,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -220,6 +243,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -232,6 +257,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -244,6 +271,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -256,6 +285,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -268,6 +299,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -280,6 +313,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -292,6 +327,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -304,6 +341,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -316,6 +355,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>

package/docs/api/player.googleanalytics.name.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.name 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.googleanalytics.onbufferfull.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onBufferFull() 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.googleanalytics.onbuffering.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onBuffering() 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.googleanalytics.ondvr.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onDVR() 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.googleanalytics.onended.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onEnded() 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.googleanalytics.onerror.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onError() 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.googleanalytics.onfullscreen.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onFullscreen() 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.googleanalytics.onhd.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onHD() 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.googleanalytics.onpause.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onPause() 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.googleanalytics.onplay.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onPlay() 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.googleanalytics.onready.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onReady() 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.googleanalytics.onseek.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onSeek() 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.googleanalytics.onstop.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onStop() 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.googleanalytics.onvolumechanged.md

@@ -4,6 +4,9 @@
 
 ## GoogleAnalytics.onVolumeChanged() 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