@gcorevideo/player 2.19.6 → 2.19.8

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

@@ -0,0 +1,21 @@
+<!-- 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; [getExternalInterface](./player.mediacontrol.getexternalinterface.md)
+
+## MediaControl.getExternalInterface() 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
+getExternalInterface(): {
+        setVolume: (value: number, isInitialVolume?: boolean) => void;
+        getVolume: () => any;
+    };
+```
+**Returns:**
+
+{ setVolume: (value: number, isInitialVolume?: boolean) =&gt; void; getVolume: () =&gt; any; }
+

package/docs/api/player.mediacontrol.md

@@ -0,0 +1,513 @@
+<!-- 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)
+
+## MediaControl 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 MediaControl is responsible for displaying the Player controls.
+
+**Signature:**
+
+```typescript
+export declare class MediaControl extends UICorePlugin 
+```
+**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.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(core)](./player.mediacontrol._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Constructs a new instance of the `MediaControl` class
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+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)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(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>
+
+[volume](./player.mediacontrol.volume.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+**_(BETA)_** Current volume
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+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)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[disabledControlButton()](./player.mediacontrol.disabledcontrolbutton.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Disable the control button
+
+
+</td></tr>
+<tr><td>
+
+[enable()](./player.mediacontrol.enable.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[enableControlButton()](./player.mediacontrol.enablecontrolbutton.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Enable the control button
+
+
+</td></tr>
+<tr><td>
+
+[getElement(name)](./player.mediacontrol.getelement.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(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>
+
+[setInitialVolume()](./player.mediacontrol.setinitialvolume.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(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>
+
+[setVolume(value, isInitialVolume)](./player.mediacontrol.setvolume.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(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.muted.md

@@ -0,0 +1,16 @@
+<!-- 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; [muted](./player.mediacontrol.muted.md)
+
+## MediaControl.muted 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.
+> 
+
+Muted state
+
+**Signature:**
+
+```typescript
+get muted(): boolean;
+```

package/docs/api/player.mediacontrol.name.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; [name](./player.mediacontrol.name.md)
+
+## MediaControl.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
+get name(): string;
+```

package/docs/api/player.mediacontrol.pause.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; [pause](./player.mediacontrol.pause.md)
+
+## MediaControl.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.
+> 
+
+Pause the playback
+
+**Signature:**
+
+```typescript
+pause(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.mediacontrol.play.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; [play](./player.mediacontrol.play.md)
+
+## MediaControl.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.
+> 
+
+Start the playback
+
+**Signature:**
+
+```typescript
+play(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.mediacontrol.playback.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; [playback](./player.mediacontrol.playback.md)
+
+## MediaControl.playback 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 playback(): any;
+```

package/docs/api/player.mediacontrol.render.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; [render](./player.mediacontrol.render.md)
+
+## MediaControl.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
+render(): this;
+```
+**Returns:**
+
+this
+

package/docs/api/player.mediacontrol.setinitialvolume.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; [setInitialVolume](./player.mediacontrol.setinitialvolume.md)
+
+## MediaControl.setInitialVolume() 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.
+> 
+
+Set the initial volume, which is preserved when playback is interrupted by an advertisement
+
+**Signature:**
+
+```typescript
+setInitialVolume(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,52 @@
+<!-- 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; [setMuted](./player.mediacontrol.setmuted.md)
+
+## MediaControl.setMuted() 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
+setMuted(value: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+value
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+