clappr
Version:
An extensible media player for the web
4,763 lines • 194 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Playback - Clappr</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="https://cloud.githubusercontent.com/assets/244265/6373134/a845eb50-bce7-11e4-80f2-592ba29972ab.png" title="Clappr"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.2.41</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/BaseObject.html">BaseObject</a></li>
<li><a href="../classes/Container.html">Container</a></li>
<li><a href="../classes/ContainerPlugin.html">ContainerPlugin</a></li>
<li><a href="../classes/Core.html">Core</a></li>
<li><a href="../classes/CoreFactory.html">CoreFactory</a></li>
<li><a href="../classes/Events.html">Events</a></li>
<li><a href="../classes/Loader.html">Loader</a></li>
<li><a href="../classes/Playback.html">Playback</a></li>
<li><a href="../classes/Player.html">Player</a></li>
<li><a href="../classes/UIContainerPlugin.html">UIContainerPlugin</a></li>
<li><a href="../classes/UIObject.html">UIObject</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/base.html">base</a></li>
<li><a href="../modules/components.html">components</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Playback Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/UIObject.html" class="crosslink">UIObject</a>
</div>
<div class="foundat">
Defined in: <a href="../files/src_base_playback.js.html#l4"><code>src/base/playback.js:4</code></a>
</div>
Module: <a href="../modules/base.html">base</a>
</div>
<div class="box intro">
<p>An abstraction to represent a generic playback, it's like an interface to be implemented by subclasses.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Playback" class="method item">
<h3 class="name"><code>Playback</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l4"><code>src/base/playback.js:4</code></a>
</p>
</div>
<div class="description">
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
<li class="api-class-tab events"><a href="#events">Events</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<li class="index-item method inherited">
<a href="#method_$">$</a>
</li>
<li class="index-item method private inherited">
<a href="#method__ensureElement">_ensureElement</a>
</li>
<li class="index-item method">
<a href="#method_canPlay">canPlay</a>
<span class="flag static">static</span>
</li>
<li class="index-item method inherited">
<a href="#method_constructor">constructor</a>
</li>
<li class="index-item method inherited">
<a href="#method_delegateEvents">delegateEvents</a>
</li>
<li class="index-item method">
<a href="#method_destroy">destroy</a>
</li>
<li class="index-item method">
<a href="#method_getDuration">getDuration</a>
</li>
<li class="index-item method">
<a href="#method_getPlaybackType">getPlaybackType</a>
</li>
<li class="index-item method">
<a href="#method_getStartTimeOffset">getStartTimeOffset</a>
</li>
<li class="index-item method">
<a href="#method_isHighDefinitionInUse">isHighDefinitionInUse</a>
</li>
<li class="index-item method">
<a href="#method_isPlaying">isPlaying</a>
</li>
<li class="index-item method inherited">
<a href="#method_listenTo">listenTo</a>
</li>
<li class="index-item method inherited">
<a href="#method_listenToOnce">listenToOnce</a>
</li>
<li class="index-item method inherited">
<a href="#method_off">off</a>
</li>
<li class="index-item method inherited">
<a href="#method_on">on</a>
</li>
<li class="index-item method inherited">
<a href="#method_once">once</a>
</li>
<li class="index-item method">
<a href="#method_pause">pause</a>
</li>
<li class="index-item method">
<a href="#method_play">play</a>
</li>
<li class="index-item method inherited">
<a href="#method_remove">remove</a>
</li>
<li class="index-item method inherited">
<a href="#method_render">render</a>
</li>
<li class="index-item method">
<a href="#method_seek">seek</a>
</li>
<li class="index-item method">
<a href="#method_seekPercentage">seekPercentage</a>
</li>
<li class="index-item method inherited">
<a href="#method_setElement">setElement</a>
</li>
<li class="index-item method">
<a href="#method_stop">stop</a>
</li>
<li class="index-item method inherited">
<a href="#method_stopListening">stopListening</a>
</li>
<li class="index-item method inherited">
<a href="#method_tagName">tagName</a>
</li>
<li class="index-item method inherited">
<a href="#method_trigger">trigger</a>
</li>
<li class="index-item method inherited">
<a href="#method_undelegateEvents">undelegateEvents</a>
</li>
<li class="index-item method">
<a href="#method_volume">volume</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property inherited">
<a href="#property_$el">$el</a>
</li>
<li class="index-item property">
<a href="#property_AOD">AOD</a>
<span class="flag static">static</span>
</li>
<li class="index-item property inherited">
<a href="#property_attributes">attributes</a>
</li>
<li class="index-item property">
<a href="#property_buffering">buffering</a>
</li>
<li class="index-item property inherited">
<a href="#property_cid">cid</a>
</li>
<li class="index-item property inherited">
<a href="#property_el">el</a>
</li>
<li class="index-item property">
<a href="#property_ended">ended</a>
</li>
<li class="index-item property inherited">
<a href="#property_events">events</a>
</li>
<li class="index-item property">
<a href="#property_isReady">isReady</a>
</li>
<li class="index-item property">
<a href="#property_LIVE">LIVE</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_NO_OP">NO_OP</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_type">type</a>
<span class="flag static">static</span>
</li>
<li class="index-item property inherited">
<a href="#property_uniqueId">uniqueId</a>
</li>
<li class="index-item property">
<a href="#property_VOD">VOD</a>
<span class="flag static">static</span>
</li>
</ul>
</div>
<div class="index-section events">
<h3>Events</h3>
<ul class="index-list events extends">
<li class="index-item event inherited">
<a href="#event_CONTAINER_BITRATE">CONTAINER_BITRATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_HIGHDEFINITIONUPDATE">CONTAINER_HIGHDEFINITIONUPDATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_LOADEDMETADATA">CONTAINER_LOADEDMETADATA</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_MEDIACONTROL_HIDE">CONTAINER_MEDIACONTROL_HIDE</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_MEDIACONTROL_SHOW">CONTAINER_MEDIACONTROL_SHOW</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_OPTIONS_CHANGE">CONTAINER_OPTIONS_CHANGE</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_PLAYBACKSTATE">CONTAINER_PLAYBACKSTATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_PROGRESS">CONTAINER_PROGRESS</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_READY">CONTAINER_READY</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_SEEK">CONTAINER_SEEK</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_SETTINGSUPDATE">CONTAINER_SETTINGSUPDATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_STATE_BUFFERFULL">CONTAINER_STATE_BUFFERFULL</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_STATE_BUFFERING">CONTAINER_STATE_BUFFERING</a>
</li>
<li class="index-item event inherited">
<a href="#event_CONTAINER_TIMEUPDATE">CONTAINER_TIMEUPDATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_CORE_OPTIONS_CHANGE">CORE_OPTIONS_CHANGE</a>
</li>
<li class="index-item event inherited inherited">
<a href="#event_CORE_READY">CORE_READY</a>
</li>
<li class="index-item event inherited">
<a href="#event_MEDIACONTROL_CONTAINERCHANGED">MEDIACONTROL_CONTAINERCHANGED</a>
</li>
<li class="index-item event inherited">
<a href="#event_MEDIACONTROL_FULLSCREEN">MEDIACONTROL_FULLSCREEN</a>
</li>
<li class="index-item event inherited">
<a href="#event_MEDIACONTROL_HIDE">MEDIACONTROL_HIDE</a>
</li>
<li class="index-item event inherited">
<a href="#event_MEDIACONTROL_MOUSELEAVE_SEEKBAR">MEDIACONTROL_MOUSELEAVE_SEEKBAR</a>
</li>
<li class="index-item event inherited">
<a href="#event_MEDIACONTROL_MOUSEMOVE_SEEKBAR">MEDIACONTROL_MOUSEMOVE_SEEKBAR</a>
</li>
<li class="index-item event inherited">
<a href="#event_MEDIACONTROL_NOTPLAYING">MEDIACONTROL_NOTPLAYING</a>
</li>
<li class="index-item event inherited">
<a href="#event_MEDIACONTROL_PLAYING">MEDIACONTROL_PLAYING</a>
</li>
<li class="index-item event inherited">
<a href="#event_MEDIACONTROL_SHOW">MEDIACONTROL_SHOW</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_BITRATE">PLAYBACK_BITRATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_BUFFERFULL">PLAYBACK_BUFFERFULL</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_BUFFERING">PLAYBACK_BUFFERING</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_DVR">PLAYBACK_DVR</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_ENDED">PLAYBACK_ENDED</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_ERROR">PLAYBACK_ERROR</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_HIGHDEFINITIONUPDATE">PLAYBACK_HIGHDEFINITIONUPDATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_LEVEL_SWITCH_END">PLAYBACK_LEVEL_SWITCH_END</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_LEVEL_SWITCH_START">PLAYBACK_LEVEL_SWITCH_START</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_LEVELS_AVAILABLE">PLAYBACK_LEVELS_AVAILABLE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_LOADEDMETADATA">PLAYBACK_LOADEDMETADATA</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_PAUSE">PLAYBACK_PAUSE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_PLAY">PLAYBACK_PLAY</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_PLAYBACKSTATE">PLAYBACK_PLAYBACKSTATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_PROGRESS">PLAYBACK_PROGRESS</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_READY">PLAYBACK_READY</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_SETTINGSUPDATE">PLAYBACK_SETTINGSUPDATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_STOP">PLAYBACK_STOP</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYBACK_TIMEUPDATE">PLAYBACK_TIMEUPDATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_ENDED">PLAYER_ENDED</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_ERROR">PLAYER_ERROR</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_FULLSCREEN">PLAYER_FULLSCREEN</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_PAUSE">PLAYER_PAUSE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_PLAY">PLAYER_PLAY</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_READY">PLAYER_READY</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_RESIZE">PLAYER_RESIZE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_SEEK">PLAYER_SEEK</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_STOP">PLAYER_STOP</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_TIMEUPDATE">PLAYER_TIMEUPDATE</a>
</li>
<li class="index-item event inherited">
<a href="#event_PLAYER_VOLUMEUPDATE">PLAYER_VOLUMEUPDATE</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_$" class="method item inherited">
<h3 class="name"><code>$</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>selector</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#method_$">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l101"><code>src/base/ui_object.js:101</code></a>
</p>
</div>
<div class="description">
selects within the component.
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">selector</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
a selector to find within the component.
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>:
an element, if it exists.
</div>
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code class="language-javascript">fullScreenBarUIComponent.$('.button-full') //will return only <code>.button-full</code> within the component
</code></pre>
</div>
</div>
</div>
<div id="method__ensureElement" class="method item private inherited">
<h3 class="name"><code>_ensureElement</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#method__ensureElement">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l188"><code>src/base/ui_object.js:188</code></a>
</p>
</div>
<div class="description">
ensures the creation of this ui component
</div>
</div>
<div id="method_canPlay" class="method item">
<h3 class="name"><code>canPlay</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</code>
</li>
<li class="arg">
<code class="optional">[mimeType]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l153"><code>src/base/playback.js:153</code></a>
</p>
</div>
<div class="description">
<p>checks if the playback can play a given <code>source</code>
If a mimeType is provided then this will be used instead of inferring the mimetype
from the source extension.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">source</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>the given source ex: <code>http://example.com/play.mp4</code></p>
</div>
</li>
<li class="param">
<code class="param-name optional">[mimeType]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the given mime type, ex: <code>'application/vnd.apple.mpegurl'</code></p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
<p><code>true</code> if the playback is playable, otherwise <code>false</code></p>
</div>
</div>
</div>
<div id="method_constructor" class="method item">
<h3 class="name"><code>constructor</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>options</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseObject.html#method_constructor">
BaseObject
</a>
but overwritten in
<a href="../files/src_base_playback.js.html#l32"><code>src/base/playback.js:32</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">options</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>the options object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_delegateEvents" class="method item inherited">
<h3 class="name"><code>delegateEvents</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>events</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#method_delegateEvents">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l151"><code>src/base/ui_object.js:151</code></a>
</p>
</div>
<div class="description">
delegates all the original <code>events</code> on <code>element</code> to its callbacks
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">events</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>:
itself
</div>
</div>
</div>
<div id="method_destroy" class="method item">
<h3 class="name"><code>destroy</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l140"><code>src/base/playback.js:140</code></a>
</p>
</div>
<div class="description">
<p>destroys the playback, removing it from DOM</p>
</div>
</div>
<div id="method_getDuration" class="method item">
<h3 class="name"><code>getDuration</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l83"><code>src/base/playback.js:83</code></a>
</p>
</div>
<div class="description">
<p>gets the duration in seconds</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:
<p>duration (in seconds) of the current source</p>
</div>
</div>
</div>
<div id="method_getPlaybackType" class="method item">
<h3 class="name"><code>getPlaybackType</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l108"><code>src/base/playback.js:108</code></a>
</p>
</div>
<div class="description">
<p>gets the playback type (<code>'vod', 'live', 'aod'</code>)</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
<p>you should write the playback type otherwise it'll assume <code>'no_op'</code></p>
</div>
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code class="language-javascript">html5VideoPlayback.getPlaybackType() //vod
html5AudioPlayback.getPlaybackType() //aod
html5VideoPlayback.getPlaybackType() //live
flashHlsPlayback.getPlaybackType() //live
</code></pre>
</div>
</div>
</div>
<div id="method_getStartTimeOffset" class="method item">
<h3 class="name"><code>getStartTimeOffset</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l74"><code>src/base/playback.js:74</code></a>
</p>
</div>
<div class="description">
<p>The time that "0" now represents relative to when playback started.
For a stream with a sliding window this will increase as content is
removed from the beginning.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:
<p>time (in seconds) that time "0" represents.</p>
</div>
</div>
</div>
<div id="method_isHighDefinitionInUse" class="method item">
<h3 class="name"><code>isHighDefinitionInUse</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l124"><code>src/base/playback.js:124</code></a>
</p>
</div>
<div class="description">
<p>checks if the playback is in HD.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
<p><code>true</code> if the playback is playing in HD, otherwise <code>false</code></p>
</div>
</div>
</div>
<div id="method_isPlaying" class="method item">
<h3 class="name"><code>isPlaying</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l90"><code>src/base/playback.js:90</code></a>
</p>
</div>
<div class="description">
<p>checks if the playback is playing.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
<p><code>true</code> if the current playback is playing, otherwise <code>false</code></p>
</div>
</div>
</div>
<div id="method_listenTo" class="method item inherited">
<h3 class="name"><code>listenTo</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>obj</code>
</li>
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>context</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#method_listenTo">Events</a>:
<a href="../files/src_base_events.js.html#l167"><code>src/base/events.js:167</code></a>
</p>
</div>
<div class="description">
<p>listen to an event indefinitely for a given <code>obj</code></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">obj</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">context</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code class="language-javascript">this.listenTo(this.core.playback, Events.PLAYBACK_PAUSE, this.callback)
</code></pre>
</div>
</div>
</div>
<div id="method_listenToOnce" class="method item inherited">
<h3 class="name"><code>listenToOnce</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>obj</code>
</li>
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>context</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#method_listenToOnce">Events</a>:
<a href="../files/src_base_events.js.html#l179"><code>src/base/events.js:179</code></a>
</p>
</div>
<div class="description">
<p>listen to an event once for a given <code>obj</code></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">obj</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">context</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code class="language-javascript">this.listenToOnce(this.core.playback, Events.PLAYBACK_PAUSE, this.callback)
</code></pre>
</div>
</div>
</div>
<div id="method_off" class="method item inherited">
<h3 class="name"><code>off</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>context</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#method_off">Events</a>:
<a href="../files/src_base_events.js.html#l86"><code>src/base/events.js:86</code></a>
</p>
</div>
<div class="description">
<p>stop listening to an event</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">context</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_on" class="method item inherited">
<h3 class="name"><code>on</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>context</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#method_on">Events</a>:
<a href="../files/src_base_events.js.html#l53"><code>src/base/events.js:53</code></a>
</p>
</div>
<div class="description">
<p>listen to an event indefinitely, if you want to stop you need to call <code>off</code></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">context</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_once" class="method item inherited">
<h3 class="name"><code>once</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>context</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#method_once">Events</a>:
<a href="../files/src_base_events.js.html#l68"><code>src/base/events.js:68</code></a>
</p>
</div>
<div class="description">
<p>listen to an event only once</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">context</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_pause" class="method item">
<h3 class="name"><code>pause</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l47"><code>src/base/playback.js:47</code></a>
</p>
</div>
<div class="description">
<p>pauses the playback.</p>
</div>
</div>
<div id="method_play" class="method item">
<h3 class="name"><code>play</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l41"><code>src/base/playback.js:41</code></a>
</p>
</div>
<div class="description">
<p>plays the playback.</p>
</div>
</div>
<div id="method_remove" class="method item inherited">
<h3 class="name"><code>remove</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#method_remove">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l124"><code>src/base/ui_object.js:124</code></a>
</p>
</div>
<div class="description">
removes the ui component from DOM
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>:
itself
</div>
</div>
</div>
<div id="method_render" class="method item inherited">
<h3 class="name"><code>render</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#method_render">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l115"><code>src/base/ui_object.js:115</code></a>
</p>
</div>
<div class="description">
render the component, usually attach it to a real existent <code>element</code>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>:
itself
</div>
</div>
</div>
<div id="method_seek" class="method item">
<h3 class="name"><code>seek</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>time</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l59"><code>src/base/playback.js:59</code></a>
</p>
</div>
<div class="description">
<p>seeks the playback to a given <code>time</code> in seconds</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">time</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<div class="param-description">
<p>should be a number between 0 and the video duration</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_seekPercentage" class="method item">
<h3 class="name"><code>seekPercentage</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>time</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l66"><code>src/base/playback.js:66</code></a>
</p>
</div>
<div class="description">
<p>seeks the playback to a given <code>percentage</code> in percentage</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">time</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<div class="param-description">
<p>should be a number between 0 and 100</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_setElement" class="method item inherited">
<h3 class="name"><code>setElement</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>element</code>
</li>
<li class="arg">
<code>delegate</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#method_setElement">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l136"><code>src/base/ui_object.js:136</code></a>
</p>
</div>
<div class="description">
set element to <code>el</code> and <code>$el</code>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">element</code>
<span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">delegate</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
whether is delegate or not
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>:
itself
</div>
</div>
</div>
<div id="method_stop" class="method item">
<h3 class="name"><code>stop</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l53"><code>src/base/playback.js:53</code></a>
</p>
</div>
<div class="description">
<p>stops the playback.</p>
</div>
</div>
<div id="method_stopListening" class="method item inherited">
<h3 class="name"><code>stopListening</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>obj</code>
</li>
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#method_stopListening">Events</a>:
<a href="../files/src_base_events.js.html#l144"><code>src/base/events.js:144</code></a>
</p>
</div>
<div class="description">
<p>stop listening an event for a given object</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">obj</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_tagName" class="method item inherited">
<h3 class="name"><code>tagName</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#method_tagName">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l39"><code>src/base/ui_object.js:39</code></a>
</p>
</div>
<div class="description">
gets the tag name for the ui component
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
tag's name
</div>
</div>
</div>
<div id="method_trigger" class="method item inherited">
<h3 class="name"><code>trigger</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#method_trigger">Events</a>:
<a href="../files/src_base_events.js.html#l122"><code>src/base/events.js:122</code></a>
</p>
</div>
<div class="description">
<p>triggers an event given its <code>name</code></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_undelegateEvents" class="method item inherited">
<h3 class="name"><code>undelegateEvents</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#method_undelegateEvents">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l178"><code>src/base/ui_object.js:178</code></a>
</p>
</div>
<div class="description">
undelegats all the <code>events</code>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/UIObject.html" class="crosslink">UIObject</a></span>:
itself
</div>
</div>
</div>
<div id="method_volume" class="method item">
<h3 class="name"><code>volume</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l133"><code>src/base/playback.js:133</code></a>
</p>
</div>
<div class="description">
<p>sets the volume for the playback</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">value</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<div class="param-description">
<p>a number between 0 (<code>muted</code>) to 100 (<code>max</code>)</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_$el" class="property item inherited">
<h3 class="name"><code>$el</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#property_$el">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l32"><code>src/base/ui_object.js:32</code></a>
</p>
</div>
<div class="description">
the dom element wrapped by <code>$</code>
</div>
</div>
<div id="property_AOD" class="property item">
<h3 class="name"><code>AOD</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l176"><code>src/base/playback.js:176</code></a>
</p>
</div>
<div class="description">
<p>a playback type for audio on demand</p>
</div>
</div>
<div id="property_attributes" class="property item inherited">
<h3 class="name"><code>attributes</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#property_attributes">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l67"><code>src/base/ui_object.js:67</code></a>
</p>
</div>
<div class="description">
a literal object mapping attributes and values to the element
element's attribute name and the value the attribute value
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code class="language-javascript">
class MyButton extends UIObject {
constructor(options) { super(options) }
get attributes() { return { class: 'my-button'} }
}
// MyButton.el.className will be 'my-button'
</code></pre>
</div>
</div>
</div>
<div id="property_buffering" class="property item">
<h3 class="name"><code>buffering</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l21"><code>src/base/playback.js:21</code></a>
</p>
</div>
<div class="description">
<p>Determine if the playback is having to buffer in order for
playback to be smooth.
(i.e if a live stream is playing smoothly, this will be false)</p>
</div>
</div>
<div id="property_cid" class="property item inherited">
<h3 class="name"><code>cid</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#property_cid">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l20"><code>src/base/ui_object.js:20</code></a>
</p>
</div>
<div class="description">
a unique id prefixed with <code>'c'</code>, <code>c1, c232</code>
</div>
</div>
<div id="property_el" class="property item inherited">
<h3 class="name"><code>el</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#property_el">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l26"><code>src/base/ui_object.js:26</code></a>
</p>
</div>
<div class="description">
the dom element itself
</div>
</div>
<div id="property_ended" class="property item">
<h3 class="name"><code>ended</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l12"><code>src/base/playback.js:12</code></a>
</p>
</div>
<div class="description">
<p>Determine if the playback has ended.</p>
</div>
</div>
<div id="property_events" class="property item inherited">
<h3 class="name"><code>events</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/UIObject.html#property_events">UIObject</a>:
<a href="../files/src_base_ui_object.js.html#l46"><code>src/base/ui_object.js:46</code></a>
</p>
</div>
<div class="description">
a literal object mapping element's events to methods
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code class="language-javascript">
class MyButton extends UIObject {
constructor(options) {
super(options)
this.myId = 0
}
get events() { return { 'click': 'myClick' } }
myClick(){ this.myId = 42 }
}
// when you click on MyButton the method <code>myClick</code> will be called
</code></pre>
</div>
</div>
</div>
<div id="property_isReady" class="property item">
<h3 class="name"><code>isReady</code></h3>
<span class="type">Boolean <code>true</code> if the current playback is ready, otherwise <code>false</code></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l99"><code>src/base/playback.js:99</code></a>
</p>
</div>
<div class="description">
<p>checks if the playback is ready.</p>
</div>
</div>
<div id="property_LIVE" class="property item">
<h3 class="name"><code>LIVE</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l184"><code>src/base/playback.js:184</code></a>
</p>
</div>
<div class="description">
<p>a playback type for live video</p>
</div>
</div>
<div id="property_NO_OP" class="property item">
<h3 class="name"><code>NO_OP</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l192"><code>src/base/playback.js:192</code></a>
</p>
</div>
<div class="description">
<p>a default playback type</p>
</div>
</div>
<div id="property_type" class="property item">
<h3 class="name"><code>type</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l200"><code>src/base/playback.js:200</code></a>
</p>
</div>
<div class="description">
<p>the plugin type</p>
</div>
</div>
<div id="property_uniqueId" class="property item inherited">
<h3 class="name"><code>uniqueId</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseObject.html#property_uniqueId">BaseObject</a>:
<a href="../files/src_base_base_object.js.html#l23"><code>src/base/base_object.js:23</code></a>
</p>
</div>
<div class="description">
<p>a unique id prefixed with <code>'o'</code>, <code>o1, o232</code></p>
</div>
</div>
<div id="property_VOD" class="property item">
<h3 class="name"><code>VOD</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_playback.js.html#l168"><code>src/base/playback.js:168</code></a>
</p>
</div>
<div class="description">
<p>a playback type for video on demand</p>
</div>
</div>
</div>
<div id="events" class="api-class-tabpanel">
<h2 class="off-left">Events</h2>
<div id="event_CONTAINER_BITRATE" class="events item inherited">
<h3 class="name"><code>CONTAINER_BITRATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_BITRATE">Events</a>:
<a href="../files/src_base_events.js.html#l501"><code>src/base/events.js:501</code></a>
</p>
</div>
<div class="description">
<p>Fired when the container updates its bitrate</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">bitrate</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
bitrate object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[bandwidth]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>bitrate bandwidth when it's available</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[width]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>playback width (ex: 720, 640, 1080)</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[height]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>playback height (ex: 240, 480, 720)</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[level]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>playback level when it's available, it could be just a map for width (0 => 240, 1 => 480, 2 => 720)</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_CONTAINER_HIGHDEFINITIONUPDATE" class="events item inherited">
<h3 class="name"><code>CONTAINER_HIGHDEFINITIONUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_HIGHDEFINITIONUPDATE">Events</a>:
<a href="../files/src_base_events.js.html#l600"><code>src/base/events.js:600</code></a>
</p>
</div>
<div class="description">
<p>Fired when container updates its video quality</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">isHD
true</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>when is on HD, false otherwise</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_CONTAINER_LOADEDMETADATA" class="events item inherited">
<h3 class="name"><code>CONTAINER_LOADEDMETADATA</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_LOADEDMETADATA">Events</a>:
<a href="../files/src_base_events.js.html#l526"><code>src/base/events.js:526</code></a>
</p>
</div>
<div class="description">
<p>Fired when the container loaded its metadata</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">metadata</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
settings object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[duration]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the playback duration</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[data]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>extra meta data</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_CONTAINER_MEDIACONTROL_HIDE" class="events item inherited">
<h3 class="name"><code>CONTAINER_MEDIACONTROL_HIDE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_MEDIACONTROL_HIDE">Events</a>:
<a href="../files/src_base_events.js.html#l615"><code>src/base/events.js:615</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media control hides</p>
</div>
</div>
<div id="event_CONTAINER_MEDIACONTROL_SHOW" class="events item inherited">
<h3 class="name"><code>CONTAINER_MEDIACONTROL_SHOW</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_MEDIACONTROL_SHOW">Events</a>:
<a href="../files/src_base_events.js.html#l609"><code>src/base/events.js:609</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media control shows</p>
</div>
</div>
<div id="event_CONTAINER_OPTIONS_CHANGE" class="events item inherited">
<h3 class="name"><code>CONTAINER_OPTIONS_CHANGE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_OPTIONS_CHANGE">Events</a>:
<a href="../files/src_base_events.js.html#l625"><code>src/base/events.js:625</code></a>
</p>
</div>
<div class="description">
<p>Fired when the options were changed for the container</p>
</div>
</div>
<div id="event_CONTAINER_PLAYBACKSTATE" class="events item inherited">
<h3 class="name"><code>CONTAINER_PLAYBACKSTATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_PLAYBACKSTATE">Events</a>:
<a href="../files/src_base_events.js.html#l490"><code>src/base/events.js:490</code></a>
</p>
</div>
<div class="description">
<p>Fired when the container internal state changes</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">state</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
state object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[type]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the playback type</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_CONTAINER_PROGRESS" class="events item inherited">
<h3 class="name"><code>CONTAINER_PROGRESS</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_PROGRESS">Events</a>:
<a href="../files/src_base_events.js.html#l550"><code>src/base/events.js:550</code></a>
</p>
</div>
<div class="description">
<p>Fired when the container is downloading the media</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">progress</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
progress object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[start]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>initial downloaded content</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[current]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>current dowloaded content</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[total]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>total content to be downloaded</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_CONTAINER_READY" class="events item inherited">
<h3 class="name"><code>CONTAINER_READY</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_READY">Events</a>:
<a href="../files/src_base_events.js.html#l519"><code>src/base/events.js:519</code></a>
</p>
</div>
<div class="description">
<p>Fired when the container is ready</p>
</div>
</div>
<div id="event_CONTAINER_SEEK" class="events item inherited">
<h3 class="name"><code>CONTAINER_SEEK</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_SEEK">Events</a>:
<a href="../files/src_base_events.js.html#l573"><code>src/base/events.js:573</code></a>
</p>
</div>
<div class="description">
<p>Fired when the container seeks the video</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">time</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<div class="param-description">
<p>the current time in seconds</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_CONTAINER_SETTINGSUPDATE" class="events item inherited">
<h3 class="name"><code>CONTAINER_SETTINGSUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_SETTINGSUPDATE">Events</a>:
<a href="../files/src_base_events.js.html#l594"><code>src/base/events.js:594</code></a>
</p>
</div>
<div class="description">
<p>Fired when the container changes any settings (volume, seek and etc)</p>
</div>
</div>
<div id="event_CONTAINER_STATE_BUFFERFULL" class="events item inherited">
<h3 class="name"><code>CONTAINER_STATE_BUFFERFULL</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_STATE_BUFFERFULL">Events</a>:
<a href="../files/src_base_events.js.html#l588"><code>src/base/events.js:588</code></a>
</p>
</div>
<div class="description">
<p>Fired when the container filled the buffer</p>
</div>
</div>
<div id="event_CONTAINER_STATE_BUFFERING" class="events item inherited">
<h3 class="name"><code>CONTAINER_STATE_BUFFERING</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_STATE_BUFFERING">Events</a>:
<a href="../files/src_base_events.js.html#l582"><code>src/base/events.js:582</code></a>
</p>
</div>
<div class="description">
<p>Fired when container is buffering</p>
</div>
</div>
<div id="event_CONTAINER_TIMEUPDATE" class="events item inherited">
<h3 class="name"><code>CONTAINER_TIMEUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CONTAINER_TIMEUPDATE">Events</a>:
<a href="../files/src_base_events.js.html#l538"><code>src/base/events.js:538</code></a>
</p>
</div>
<div class="description">
<p>Fired when the time is updated on container</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">progress</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
progress object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[current]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>current time</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[total]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>total time</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_CORE_OPTIONS_CHANGE" class="events item inherited">
<h3 class="name"><code>CORE_OPTIONS_CHANGE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CORE_OPTIONS_CHANGE">Events</a>:
<a href="../files/src_base_events.js.html#l469"><code>src/base/events.js:469</code></a>
</p>
</div>
<div class="description">
<p>Fired when the options were changed for the core</p>
</div>
</div>
<div id="event_CORE_READY" class="events item inherited">
<h3 class="name"><code>CORE_READY</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_CORE_READY">
Events
</a>
but overwritten in
<a href="../files/src_base_events.js.html#l475"><code>src/base/events.js:475</code></a>
</p>
</div>
<div class="description">
<p>Fired after creating containers, when the core is ready</p>
</div>
</div>
<div id="event_MEDIACONTROL_CONTAINERCHANGED" class="events item inherited">
<h3 class="name"><code>MEDIACONTROL_CONTAINERCHANGED</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_MEDIACONTROL_CONTAINERCHANGED">Events</a>:
<a href="../files/src_base_events.js.html#l680"><code>src/base/events.js:680</code></a>
</p>
</div>
<div class="description">
<p>Fired when the container was changed</p>
</div>
</div>
<div id="event_MEDIACONTROL_FULLSCREEN" class="events item inherited">
<h3 class="name"><code>MEDIACONTROL_FULLSCREEN</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_MEDIACONTROL_FULLSCREEN">Events</a>:
<a href="../files/src_base_events.js.html#l634"><code>src/base/events.js:634</code></a>
</p>
</div>
<div class="description">
<p>Fired when the player enters/exit on fullscreen</p>
</div>
</div>
<div id="event_MEDIACONTROL_HIDE" class="events item inherited">
<h3 class="name"><code>MEDIACONTROL_HIDE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_MEDIACONTROL_HIDE">Events</a>:
<a href="../files/src_base_events.js.html#l646"><code>src/base/events.js:646</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media control hides</p>
</div>
</div>
<div id="event_MEDIACONTROL_MOUSELEAVE_SEEKBAR" class="events item inherited">
<h3 class="name"><code>MEDIACONTROL_MOUSELEAVE_SEEKBAR</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_MEDIACONTROL_MOUSELEAVE_SEEKBAR">Events</a>:
<a href="../files/src_base_events.js.html#l660"><code>src/base/events.js:660</code></a>
</p>
</div>
<div class="description">
<p>Fired when mouse leaves the seekbar</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event
the</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>javascript event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_MEDIACONTROL_MOUSEMOVE_SEEKBAR" class="events item inherited">
<h3 class="name"><code>MEDIACONTROL_MOUSEMOVE_SEEKBAR</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_MEDIACONTROL_MOUSEMOVE_SEEKBAR">Events</a>:
<a href="../files/src_base_events.js.html#l652"><code>src/base/events.js:652</code></a>
</p>
</div>
<div class="description">
<p>Fired when mouse enters on the seekbar</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event
the</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>javascript event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_MEDIACONTROL_NOTPLAYING" class="events item inherited">
<h3 class="name"><code>MEDIACONTROL_NOTPLAYING</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_MEDIACONTROL_NOTPLAYING">Events</a>:
<a href="../files/src_base_events.js.html#l674"><code>src/base/events.js:674</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media is not being played</p>
</div>
</div>
<div id="event_MEDIACONTROL_PLAYING" class="events item inherited">
<h3 class="name"><code>MEDIACONTROL_PLAYING</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_MEDIACONTROL_PLAYING">Events</a>:
<a href="../files/src_base_events.js.html#l668"><code>src/base/events.js:668</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media is being played</p>
</div>
</div>
<div id="event_MEDIACONTROL_SHOW" class="events item inherited">
<h3 class="name"><code>MEDIACONTROL_SHOW</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_MEDIACONTROL_SHOW">Events</a>:
<a href="../files/src_base_events.js.html#l640"><code>src/base/events.js:640</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media control shows</p>
</div>
</div>
<div id="event_PLAYBACK_BITRATE" class="events item inherited">
<h3 class="name"><code>PLAYBACK_BITRATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_BITRATE">Events</a>:
<a href="../files/src_base_events.js.html#l363"><code>src/base/events.js:363</code></a>
</p>
</div>
<div class="description">
<p>Fired when playback updates its bitrate</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">bitrate</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
bitrate object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[bandwidth]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>bitrate bandwidth when it's available</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[width]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>playback width (ex: 720, 640, 1080)</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[height]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>playback height (ex: 240, 480, 720)</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[level]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>playback level when it's available, it could be just a map for width (0 => 240, 1 => 480, 2 => 720)</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_PLAYBACK_BUFFERFULL" class="events item inherited">
<h3 class="name"><code>PLAYBACK_BUFFERFULL</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_BUFFERFULL">Events</a>:
<a href="../files/src_base_events.js.html#l326"><code>src/base/events.js:326</code></a>
</p>
</div>
<div class="description">
<p>Fired when the playback has enough in the buffer to be
able to play smoothly, after previously being unable to
do this.</p>
<p>This corresponds to the playback <code>buffering</code> property being
<code>false</code>.</p>
</div>
</div>
<div id="event_PLAYBACK_BUFFERING" class="events item inherited">
<h3 class="name"><code>PLAYBACK_BUFFERING</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_BUFFERING">Events</a>:
<a href="../files/src_base_events.js.html#l316"><code>src/base/events.js:316</code></a>
</p>
</div>
<div class="description">
<p>Fired when the playback starts having to buffer because
playback can currently not be smooth.</p>
<p>This corresponds to the playback <code>buffering</code> property being
<code>true</code>.</p>
</div>
</div>
<div id="event_PLAYBACK_DVR" class="events item inherited">
<h3 class="name"><code>PLAYBACK_DVR</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_DVR">Events</a>:
<a href="../files/src_base_events.js.html#l414"><code>src/base/events.js:414</code></a>
</p>
</div>
<div class="description">
<p>Fired when DVR becomes enabled/disabled.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">state</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>true if dvr enabled</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_PLAYBACK_ENDED" class="events item inherited">
<h3 class="name"><code>PLAYBACK_ENDED</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_ENDED">Events</a>:
<a href="../files/src_base_events.js.html#l425"><code>src/base/events.js:425</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media for a playback ends.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>the name of the playback</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_PLAYBACK_ERROR" class="events item inherited">
<h3 class="name"><code>PLAYBACK_ERROR</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_ERROR">Events</a>:
<a href="../files/src_base_events.js.html#l454"><code>src/base/events.js:454</code></a>
</p>
</div>
<div class="description">
<p>Fired if an error occurs in the playback.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">error</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object containing the error details</p>
</div>
</li>
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Playback name</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_PLAYBACK_HIGHDEFINITIONUPDATE" class="events item inherited">
<h3 class="name"><code>PLAYBACK_HIGHDEFINITIONUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_HIGHDEFINITIONUPDATE">Events</a>:
<a href="../files/src_base_events.js.html#l355"><code>src/base/events.js:355</code></a>
</p>
</div>
<div class="description">
<p>Fired when playback updates its video quality</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">isHD
true</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>when is on HD, false otherwise</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_PLAYBACK_LEVEL_SWITCH_END" class="events item inherited">
<h3 class="name"><code>PLAYBACK_LEVEL_SWITCH_END</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_LEVEL_SWITCH_END">Events</a>:
<a href="../files/src_base_events.js.html#l396"><code>src/base/events.js:396</code></a>
</p>
</div>
<div class="description">
<p>Fired when the playback ends the level switch</p>
</div>
</div>
<div id="event_PLAYBACK_LEVEL_SWITCH_START" class="events item inherited">
<h3 class="name"><code>PLAYBACK_LEVEL_SWITCH_START</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_LEVEL_SWITCH_START">Events</a>:
<a href="../files/src_base_events.js.html#l389"><code>src/base/events.js:389</code></a>
</p>
</div>
<div class="description">
<p>Fired when the playback starts to switch level</p>
</div>
</div>
<div id="event_PLAYBACK_LEVELS_AVAILABLE" class="events item inherited">
<h3 class="name"><code>PLAYBACK_LEVELS_AVAILABLE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_LEVELS_AVAILABLE">Events</a>:
<a href="../files/src_base_events.js.html#l379"><code>src/base/events.js:379</code></a>
</p>
</div>
<div class="description">
<p>Fired when the playback has its levels</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">levels
the</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
<div class="param-description">
<p>ordered levels, each one with the following format <code>{id: 1, label: '500kbps'}</code> ps: id should be a number >= 0</p>
</div>
</li>
<li class="param">
<code class="param-name">initial
the</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<div class="param-description">
<p>initial level otherwise -1 (AUTO)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_PLAYBACK_LOADEDMETADATA" class="events item inherited">
<h3 class="name"><code>PLAYBACK_LOADEDMETADATA</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_LOADEDMETADATA">Events</a>:
<a href="../files/src_base_events.js.html#l343"><code>src/base/events.js:343</code></a>
</p>
</div>
<div class="description">
<p>Fired when playback loaded its metadata</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">metadata</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
settings object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[duration]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the playback duration</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[data]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>extra meta data</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_PLAYBACK_PAUSE" class="events item inherited">
<h3 class="name"><code>PLAYBACK_PAUSE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_PAUSE">Events</a>:
<a href="../files/src_base_events.js.html#l442"><code>src/base/events.js:442</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media for a playback pauses.</p>
</div>
</div>
<div id="event_PLAYBACK_PLAY" class="events item inherited">
<h3 class="name"><code>PLAYBACK_PLAY</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_PLAY">Events</a>:
<a href="../files/src_base_events.js.html#l432"><code>src/base/events.js:432</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media for a playback starts playing.
This is not necessarily when the user requests <code>play()</code>
The media may have to buffer first.
I.e. <code>isPlaying()</code> might return <code>true</code> before this event is fired,
because <code>isPlaying()</code> represents the intended state.</p>
</div>
</div>
<div id="event_PLAYBACK_PLAYBACKSTATE" class="events item inherited">
<h3 class="name"><code>PLAYBACK_PLAYBACKSTATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_PLAYBACKSTATE">Events</a>:
<a href="../files/src_base_events.js.html#l404"><code>src/base/events.js:404</code></a>
</p>
</div>
<div class="description">
<p>Fired when playback internal state changes</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">state</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
state object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[type]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the playback type</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_PLAYBACK_PROGRESS" class="events item inherited">
<h3 class="name"><code>PLAYBACK_PROGRESS</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_PROGRESS">Events</a>:
<a href="../files/src_base_events.js.html#l284"><code>src/base/events.js:284</code></a>
</p>
</div>
<div class="description">
<p>Fired when the playback is downloading the media</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">progress</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
progress object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[start]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>initial downloaded content</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[current]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>current dowloaded content</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[total]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>total content to be downloaded</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_PLAYBACK_READY" class="events item inherited">
<h3 class="name"><code>PLAYBACK_READY</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_READY">Events</a>:
<a href="../files/src_base_events.js.html#l310"><code>src/base/events.js:310</code></a>
</p>
</div>
<div class="description">
<p>Fired when playback is ready</p>
</div>
</div>
<div id="event_PLAYBACK_SETTINGSUPDATE" class="events item inherited">
<h3 class="name"><code>PLAYBACK_SETTINGSUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_SETTINGSUPDATE">Events</a>:
<a href="../files/src_base_events.js.html#l337"><code>src/base/events.js:337</code></a>
</p>
</div>
<div class="description">
<p>Fired when playback changes any settings (volume, seek and etc)</p>
</div>
</div>
<div id="event_PLAYBACK_STOP" class="events item inherited">
<h3 class="name"><code>PLAYBACK_STOP</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_STOP">Events</a>:
<a href="../files/src_base_events.js.html#l448"><code>src/base/events.js:448</code></a>
</p>
</div>
<div class="description">
<p>Fired when the media for a playback is stopped.</p>
</div>
</div>
<div id="event_PLAYBACK_TIMEUPDATE" class="events item inherited">
<h3 class="name"><code>PLAYBACK_TIMEUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYBACK_TIMEUPDATE">Events</a>:
<a href="../files/src_base_events.js.html#l298"><code>src/base/events.js:298</code></a>
</p>
</div>
<div class="description">
<p>Fired when the time is updated on playback</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">progress</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
progress object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[current]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>current time</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[total]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>total time</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_PLAYER_ENDED" class="events item inherited">
<h3 class="name"><code>PLAYER_ENDED</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_ENDED">Events</a>:
<a href="../files/src_base_events.js.html#l243"><code>src/base/events.js:243</code></a>
</p>
</div>
<div class="description">
<p>Fired when player ends the video</p>
</div>
</div>
<div id="event_PLAYER_ERROR" class="events item inherited">
<h3 class="name"><code>PLAYER_ERROR</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_ERROR">Events</a>:
<a href="../files/src_base_events.js.html#l256"><code>src/base/events.js:256</code></a>
</p>
</div>
<div class="description">
<p>Fired when player receives an error</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">error</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>the error</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_PLAYER_FULLSCREEN" class="events item inherited">
<h3 class="name"><code>PLAYER_FULLSCREEN</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_FULLSCREEN">Events</a>:
<a href="../files/src_base_events.js.html#l218"><code>src/base/events.js:218</code></a>
</p>
</div>
<div class="description">
<p>Fired when player changes its fullscreen state</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">whether</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>or not the player is on fullscreen mode</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_PLAYER_PAUSE" class="events item inherited">
<h3 class="name"><code>PLAYER_PAUSE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_PAUSE">Events</a>:
<a href="../files/src_base_events.js.html#l231"><code>src/base/events.js:231</code></a>
</p>
</div>
<div class="description">
<p>Fired when player pauses</p>
</div>
</div>
<div id="event_PLAYER_PLAY" class="events item inherited">
<h3 class="name"><code>PLAYER_PLAY</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_PLAY">Events</a>:
<a href="../files/src_base_events.js.html#l225"><code>src/base/events.js:225</code></a>
</p>
</div>
<div class="description">
<p>Fired when player starts to play</p>
</div>
</div>
<div id="event_PLAYER_READY" class="events item inherited">
<h3 class="name"><code>PLAYER_READY</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_READY">Events</a>:
<a href="../files/src_base_events.js.html#l205"><code>src/base/events.js:205</code></a>
</p>
</div>
<div class="description">
<p>Fired when the player is ready on startup</p>
</div>
</div>
<div id="event_PLAYER_RESIZE" class="events item inherited">
<h3 class="name"><code>PLAYER_RESIZE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_RESIZE">Events</a>:
<a href="../files/src_base_events.js.html#l211"><code>src/base/events.js:211</code></a>
</p>
</div>
<div class="description">
<p>Fired when player resizes</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">currentSize</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>an object with the current size</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_PLAYER_SEEK" class="events item inherited">
<h3 class="name"><code>PLAYER_SEEK</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_SEEK">Events</a>:
<a href="../files/src_base_events.js.html#l249"><code>src/base/events.js:249</code></a>
</p>
</div>
<div class="description">
<p>Fired when player seeks the video</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">time</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<div class="param-description">
<p>the current time in seconds</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_PLAYER_STOP" class="events item inherited">
<h3 class="name"><code>PLAYER_STOP</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_STOP">Events</a>:
<a href="../files/src_base_events.js.html#l237"><code>src/base/events.js:237</code></a>
</p>
</div>
<div class="description">
<p>Fired when player stops</p>
</div>
</div>
<div id="event_PLAYER_TIMEUPDATE" class="events item inherited">
<h3 class="name"><code>PLAYER_TIMEUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_TIMEUPDATE">Events</a>:
<a href="../files/src_base_events.js.html#l263"><code>src/base/events.js:263</code></a>
</p>
</div>
<div class="description">
<p>Fired when the time is updated on player</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">progress</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Data
progress object</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[current]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>current time</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[total]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>total time</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="event_PLAYER_VOLUMEUPDATE" class="events item inherited">
<h3 class="name"><code>PLAYER_VOLUMEUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Events.html#event_PLAYER_VOLUMEUPDATE">Events</a>:
<a href="../files/src_base_events.js.html#l275"><code>src/base/events.js:275</code></a>
</p>
</div>
<div class="description">
<p>Fired when player updates its volume</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">volume</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
<div class="param-description">
<p>the current volume</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>