@gcorevideo/player 2.19.5 → 2.19.7

package/docs/api/player.mediacontrol.md

@@ -0,0 +1,1030 @@
+<!-- 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
+
+**Signature:**
+
+```typescript
+export declare class MediaControl extends UICorePlugin 
+```
+**Extends:** UICorePlugin
+
+## 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>
+
+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>
+
+
+</td></tr>
+<tr><td>
+
+[bigPlayButton](./player.mediacontrol.bigplaybutton.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[container](./player.mediacontrol.container.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[disabled](./player.mediacontrol.disabled.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</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>
+
+
+</td></tr>
+<tr><td>
+
+[muted](./player.mediacontrol.muted.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[name](./player.mediacontrol.name.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[playback](./player.mediacontrol.playback.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[stopDrag](./player.mediacontrol.stopdrag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(event: MouseEvent) =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[supportedVersion](./player.mediacontrol.supportedversion.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+{ min: string; }
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[template](./player.mediacontrol.template.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[updateDrag](./player.mediacontrol.updatedrag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(event: MouseEvent \| TouchEvent) =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[volume](./player.mediacontrol.volume.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[applyButtonStyle(element)](./player.mediacontrol.applybuttonstyle.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[bindContainerEvents()](./player.mediacontrol.bindcontainerevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[bindEvents()](./player.mediacontrol.bindevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[bindKeyAndShow(key, callback)](./player.mediacontrol.bindkeyandshow.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[bindKeyEvents()](./player.mediacontrol.bindkeyevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[configure()](./player.mediacontrol.configure.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[createCachedElements()](./player.mediacontrol.createcachedelements.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[destroy()](./player.mediacontrol.destroy.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[disable()](./player.mediacontrol.disable.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[disabledControlButton()](./player.mediacontrol.disabledcontrolbutton.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[drawDurationAndPosition()](./player.mediacontrol.drawdurationandposition.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[enable()](./player.mediacontrol.enable.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[enableControlButton()](./player.mediacontrol.enablecontrolbutton.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[ended()](./player.mediacontrol.ended.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getElement(name)](./player.mediacontrol.getelement.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getExternalInterface()](./player.mediacontrol.getexternalinterface.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getSettings()](./player.mediacontrol.getsettings.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getVolumeFromUIEvent(event)](./player.mediacontrol.getvolumefromuievent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hide(delay)](./player.mediacontrol.hide.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hideControllAds()](./player.mediacontrol.hidecontrollads.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hideVolumeBar(timeout)](./player.mediacontrol.hidevolumebar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[highDefinitionUpdate(isHD)](./player.mediacontrol.highdefinitionupdate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[initializeIcons()](./player.mediacontrol.initializeicons.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isSeekEnabledForHtml5Playback()](./player.mediacontrol.isseekenabledforhtml5playback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isVisible()](./player.mediacontrol.isvisible.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[onActiveContainerChanged()](./player.mediacontrol.onactivecontainerchanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[onFinishAd()](./player.mediacontrol.onfinishad.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[onStartAd()](./player.mediacontrol.onstartad.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[onTimeUpdate(timeProgress)](./player.mediacontrol.ontimeupdate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[parseColors()](./player.mediacontrol.parsecolors.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[pause()](./player.mediacontrol.pause.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[play()](./player.mediacontrol.play.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[render()](./player.mediacontrol.render.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[renderSeekBar()](./player.mediacontrol.renderseekbar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[resetIndicators()](./player.mediacontrol.resetindicators.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[resetKeepVisible()](./player.mediacontrol.resetkeepvisible.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[resetUserKeepVisible()](./player.mediacontrol.resetuserkeepvisible.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[seek(event)](./player.mediacontrol.seek.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[seekRelative(delta)](./player.mediacontrol.seekrelative.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setClipText(txt)](./player.mediacontrol.setcliptext.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setKeepVisible()](./player.mediacontrol.setkeepvisible.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setMuted(value)](./player.mediacontrol.setmuted.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setSeekPercentage(value)](./player.mediacontrol.setseekpercentage.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setSVGMask(svg)](./player.mediacontrol.setsvgmask.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setUserKeepVisible()](./player.mediacontrol.setuserkeepvisible.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setVolume(value, isInitialVolume)](./player.mediacontrol.setvolume.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[show(event)](./player.mediacontrol.show.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[showVolumeBar()](./player.mediacontrol.showvolumebar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[startSeekDrag(event)](./player.mediacontrol.startseekdrag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[startVolumeDrag(event)](./player.mediacontrol.startvolumedrag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[stop()](./player.mediacontrol.stop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[toggleFullscreen()](./player.mediacontrol.togglefullscreen.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[toggleMute()](./player.mediacontrol.togglemute.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[togglePlayPause()](./player.mediacontrol.toggleplaypause.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[togglePlayStop()](./player.mediacontrol.toggleplaystop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[unbindKeyEvents()](./player.mediacontrol.unbindkeyevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[updateCursorStyle(showing)](./player.mediacontrol.updatecursorstyle.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[updateProgressBar(progress)](./player.mediacontrol.updateprogressbar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>