clappr
Version:
An extensible media player for the web
3,193 lines • 138 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Events - 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>Events Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/src_base_events.js.html#l47"><code>src/base/events.js:47</code></a>
</div>
Module: <a href="../modules/base.html">base</a>
</div>
<div class="box intro">
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Events" class="method item">
<h3 class="name"><code>Events</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_events.js.html#l47"><code>src/base/events.js:47</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 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">
<li class="index-item method">
<a href="#method_listenTo">listenTo</a>
</li>
<li class="index-item method">
<a href="#method_listenToOnce">listenToOnce</a>
</li>
<li class="index-item method">
<a href="#method_off">off</a>
</li>
<li class="index-item method">
<a href="#method_on">on</a>
</li>
<li class="index-item method">
<a href="#method_once">once</a>
</li>
<li class="index-item method">
<a href="#method_stopListening">stopListening</a>
</li>
<li class="index-item method">
<a href="#method_trigger">trigger</a>
</li>
</ul>
</div>
<div class="index-section events">
<h3>Events</h3>
<ul class="index-list events">
<li class="index-item event">
<a href="#event_CONTAINER_BITRATE">CONTAINER_BITRATE</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_HIGHDEFINITIONUPDATE">CONTAINER_HIGHDEFINITIONUPDATE</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_LOADEDMETADATA">CONTAINER_LOADEDMETADATA</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_MEDIACONTROL_HIDE">CONTAINER_MEDIACONTROL_HIDE</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_MEDIACONTROL_SHOW">CONTAINER_MEDIACONTROL_SHOW</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_OPTIONS_CHANGE">CONTAINER_OPTIONS_CHANGE</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_PLAYBACKSTATE">CONTAINER_PLAYBACKSTATE</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_PROGRESS">CONTAINER_PROGRESS</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_READY">CONTAINER_READY</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_SEEK">CONTAINER_SEEK</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_SETTINGSUPDATE">CONTAINER_SETTINGSUPDATE</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_STATE_BUFFERFULL">CONTAINER_STATE_BUFFERFULL</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_STATE_BUFFERING">CONTAINER_STATE_BUFFERING</a>
</li>
<li class="index-item event">
<a href="#event_CONTAINER_TIMEUPDATE">CONTAINER_TIMEUPDATE</a>
</li>
<li class="index-item event">
<a href="#event_CORE_OPTIONS_CHANGE">CORE_OPTIONS_CHANGE</a>
</li>
<li class="index-item event">
<a href="#event_CORE_READY">CORE_READY</a>
</li>
<li class="index-item event">
<a href="#event_CORE_READY">CORE_READY</a>
</li>
<li class="index-item event">
<a href="#event_MEDIACONTROL_CONTAINERCHANGED">MEDIACONTROL_CONTAINERCHANGED</a>
</li>
<li class="index-item event">
<a href="#event_MEDIACONTROL_FULLSCREEN">MEDIACONTROL_FULLSCREEN</a>
</li>
<li class="index-item event">
<a href="#event_MEDIACONTROL_HIDE">MEDIACONTROL_HIDE</a>
</li>
<li class="index-item event">
<a href="#event_MEDIACONTROL_MOUSELEAVE_SEEKBAR">MEDIACONTROL_MOUSELEAVE_SEEKBAR</a>
</li>
<li class="index-item event">
<a href="#event_MEDIACONTROL_MOUSEMOVE_SEEKBAR">MEDIACONTROL_MOUSEMOVE_SEEKBAR</a>
</li>
<li class="index-item event">
<a href="#event_MEDIACONTROL_NOTPLAYING">MEDIACONTROL_NOTPLAYING</a>
</li>
<li class="index-item event">
<a href="#event_MEDIACONTROL_PLAYING">MEDIACONTROL_PLAYING</a>
</li>
<li class="index-item event">
<a href="#event_MEDIACONTROL_SHOW">MEDIACONTROL_SHOW</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_BITRATE">PLAYBACK_BITRATE</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_BUFFERFULL">PLAYBACK_BUFFERFULL</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_BUFFERING">PLAYBACK_BUFFERING</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_DVR">PLAYBACK_DVR</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_ENDED">PLAYBACK_ENDED</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_ERROR">PLAYBACK_ERROR</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_HIGHDEFINITIONUPDATE">PLAYBACK_HIGHDEFINITIONUPDATE</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_LEVEL_SWITCH_END">PLAYBACK_LEVEL_SWITCH_END</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_LEVEL_SWITCH_START">PLAYBACK_LEVEL_SWITCH_START</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_LEVELS_AVAILABLE">PLAYBACK_LEVELS_AVAILABLE</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_LOADEDMETADATA">PLAYBACK_LOADEDMETADATA</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_PAUSE">PLAYBACK_PAUSE</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_PLAY">PLAYBACK_PLAY</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_PLAYBACKSTATE">PLAYBACK_PLAYBACKSTATE</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_PROGRESS">PLAYBACK_PROGRESS</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_READY">PLAYBACK_READY</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_SETTINGSUPDATE">PLAYBACK_SETTINGSUPDATE</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_STOP">PLAYBACK_STOP</a>
</li>
<li class="index-item event">
<a href="#event_PLAYBACK_TIMEUPDATE">PLAYBACK_TIMEUPDATE</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_ENDED">PLAYER_ENDED</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_ERROR">PLAYER_ERROR</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_FULLSCREEN">PLAYER_FULLSCREEN</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_PAUSE">PLAYER_PAUSE</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_PLAY">PLAYER_PLAY</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_READY">PLAYER_READY</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_RESIZE">PLAYER_RESIZE</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_SEEK">PLAYER_SEEK</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_STOP">PLAYER_STOP</a>
</li>
<li class="index-item event">
<a href="#event_PLAYER_TIMEUPDATE">PLAYER_TIMEUPDATE</a>
</li>
<li class="index-item event">
<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_listenTo" class="method item">
<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>
Defined in
<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">
<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>
Defined in
<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">
<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>
Defined in
<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">
<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>
Defined in
<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">
<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>
Defined in
<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_stopListening" class="method item">
<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>
Defined in
<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_trigger" class="method item">
<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>
Defined in
<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>
<div id="events" class="api-class-tabpanel">
<h2 class="off-left">Events</h2>
<div id="event_CONTAINER_BITRATE" class="events item">
<h3 class="name"><code>CONTAINER_BITRATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_HIGHDEFINITIONUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_LOADEDMETADATA</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_MEDIACONTROL_HIDE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_MEDIACONTROL_SHOW</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_OPTIONS_CHANGE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_PLAYBACKSTATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_PROGRESS</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_READY</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_SEEK</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_SETTINGSUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_STATE_BUFFERFULL</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_STATE_BUFFERING</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CONTAINER_TIMEUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CORE_OPTIONS_CHANGE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>CORE_READY</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined 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_CORE_READY" class="events item">
<h3 class="name"><code>CORE_READY</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_base_events.js.html#l481"><code>src/base/events.js:481</code></a>
</p>
</div>
<div class="description">
<p>Fired when the fullscreen state change</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_MEDIACONTROL_CONTAINERCHANGED" class="events item">
<h3 class="name"><code>MEDIACONTROL_CONTAINERCHANGED</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>MEDIACONTROL_FULLSCREEN</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>MEDIACONTROL_HIDE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>MEDIACONTROL_MOUSELEAVE_SEEKBAR</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>MEDIACONTROL_MOUSEMOVE_SEEKBAR</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>MEDIACONTROL_NOTPLAYING</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>MEDIACONTROL_PLAYING</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>MEDIACONTROL_SHOW</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_BITRATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_BUFFERFULL</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_BUFFERING</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_DVR</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_ENDED</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_ERROR</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_HIGHDEFINITIONUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_LEVEL_SWITCH_END</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_LEVEL_SWITCH_START</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_LEVELS_AVAILABLE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_LOADEDMETADATA</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_PAUSE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_PLAY</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_PLAYBACKSTATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_PROGRESS</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_READY</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_SETTINGSUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_STOP</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYBACK_TIMEUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_ENDED</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_ERROR</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_FULLSCREEN</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_PAUSE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_PLAY</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_READY</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_RESIZE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_SEEK</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_STOP</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_TIMEUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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">
<h3 class="name"><code>PLAYER_VOLUMEUPDATE</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<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>