multimediaobject
Version:
Multimediaobject library
4,441 lines (1,095 loc) • 67.6 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Global - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="MultimediaObject.html">MultimediaObject</a></li></ul><h3>Global</h3><ul><li><a href="global.html#add">add</a></li><li><a href="global.html#addAnimationKeyframe">addAnimationKeyframe</a></li><li><a href="global.html#addAnimationProperties">addAnimationProperties</a></li><li><a href="global.html#addDefaultParameters">addDefaultParameters</a></li><li><a href="global.html#addGlobalStyle">addGlobalStyle</a></li><li><a href="global.html#addListener">addListener</a></li><li><a href="global.html#appendElementTo">appendElementTo</a></li><li><a href="global.html#applyAttributes">applyAttributes</a></li><li><a href="global.html#applyBreakpoints">applyBreakpoints</a></li><li><a href="global.html#applyDependencies">applyDependencies</a></li><li><a href="global.html#applyEvents">applyEvents</a></li><li><a href="global.html#applyFunctions">applyFunctions</a></li><li><a href="global.html#applyIteration">applyIteration</a></li><li><a href="global.html#applyStyle">applyStyle</a></li><li><a href="global.html#changeAnimation">changeAnimation</a></li><li><a href="global.html#checkBreakpoints">checkBreakpoints</a></li><li><a href="global.html#checkDep">checkDep</a></li><li><a href="global.html#deactivateEvent">deactivateEvent</a></li><li><a href="global.html#deleteAnimationKeyframe">deleteAnimationKeyframe</a></li><li><a href="global.html#deleteAnimationProperties">deleteAnimationProperties</a></li><li><a href="global.html#dispatchEvent">dispatchEvent</a></li><li><a href="global.html#exportToJSON">exportToJSON</a></li><li><a href="global.html#generate">generate</a></li><li><a href="global.html#getComputedStyle">getComputedStyle</a></li><li><a href="global.html#getSortedSteps">getSortedSteps</a></li><li><a href="global.html#getTotalAnimationTime">getTotalAnimationTime</a></li><li><a href="global.html#init">init</a></li><li><a href="global.html#interpolateStep">interpolateStep</a></li><li><a href="global.html#loadFromJSON">loadFromJSON</a></li><li><a href="global.html#preInterpolateStep">preInterpolateStep</a></li><li><a href="global.html#remove">remove</a></li><li><a href="global.html#removeDependencies">removeDependencies</a></li><li><a href="global.html#removeEvent">removeEvent</a></li><li><a href="global.html#removeFunction">removeFunction</a></li><li><a href="global.html#removeListener">removeListener</a></li><li><a href="global.html#removePropertie">removePropertie</a></li><li><a href="global.html#requireDependencies">requireDependencies</a></li><li><a href="global.html#restartAnimation">restartAnimation</a></li><li><a href="global.html#runAnimation">runAnimation</a></li><li><a href="global.html#setAbsoluteAssetURL">setAbsoluteAssetURL</a></li><li><a href="global.html#startAnimation">startAnimation</a></li><li><a href="global.html#stopAnimation">stopAnimation</a></li><li><a href="global.html#transformEvent">transformEvent</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(child)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>add children to MultimediaObject</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type">DOMElement</span>
</td>
<td class="description last"><p>the child to add</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line786">line 786</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="addAnimationKeyframe"><span class="type-signature"></span>addAnimationKeyframe<span class="signature">(time, prop, value, easing)</span><span class="type-signature"></span></h4>
<div class="description">
<p>An an animation keyframe</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>the time from which delete the propertie</p></td>
</tr>
<tr>
<td class="name"><code>prop</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the propertie name</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="description last"><p>the propertie value</p></td>
</tr>
<tr>
<td class="name"><code>easing</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the easing name</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1279">line 1279</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addAnimationProperties"><span class="type-signature"></span>addAnimationProperties<span class="signature">(propertieArray, absoluteTime)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Add a animation propertie</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertieArray</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>the propertie array propertie = { key, value }</p></td>
</tr>
<tr>
<td class="name"><code>absoluteTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>the time key in which to add the propertie</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1197">line 1197</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addDefaultParameters"><span class="type-signature"></span>addDefaultParameters<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Add the default parameters set in the config file based on the type</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line158">line 158</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addGlobalStyle"><span class="type-signature"></span>addGlobalStyle<span class="signature">(style, callback)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Add a global style object to the page</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>the CSS style properties to apply</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>the callback to execute</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line248">line 248</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="addListener"><span class="type-signature"></span>addListener<span class="signature">(listener, fn, glob)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Add an event listener or a custom event</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>listener</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the name of the event</p></td>
</tr>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>the function to execute on event dispatch</p></td>
</tr>
<tr>
<td class="name"><code>glob</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>is the custom event global or bind to the object id</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1128">line 1128</a>
</li></ul></dd>
</dl>
<h4 class="name" id="appendElementTo"><span class="type-signature"></span>appendElementTo<span class="signature">(container)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>append MultimediaObject.element to container parameter</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>container</code></td>
<td class="type">
<span class="param-type">DOMElement</span>
|
<span class="param-type"><a href="MultimediaObject.html">MultimediaObject</a></span>
</td>
<td class="description last"><p>the container to append to</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line746">line 746</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="applyAttributes"><span class="type-signature"></span>applyAttributes<span class="signature">(attributes)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Apply the attributes to the DOMElement and attributes propertie of the MultimediaObject</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>attributes</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>key = name of attribute, value = value.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line412">line 412</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="applyBreakpoints"><span class="type-signature"></span>applyBreakpoints<span class="signature">(breakpoints)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Apply the breakpoints</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>breakpoints</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>breakpoint object {{querie,style}}</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line433">line 433</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="applyDependencies"><span class="type-signature"></span>applyDependencies<span class="signature">(dependencies)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Require dependencies and add it to a dependencie bundle</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dependencies</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>the dependencies to fetch</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line200">line 200</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="applyEvents"><span class="type-signature"></span>applyEvents<span class="signature">(attributes)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Apply the events to the DOMElement and events propertie of the MultimediaObject</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>attributes</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>key = name of event, value = function.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line455">line 455</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="applyFunctions"><span class="type-signature"></span>applyFunctions<span class="signature">(functions)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Apply the functions as method of the MultimediaObject</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>functions</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>key = name of functions, value = function body.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line395">line 395</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="applyIteration"><span class="type-signature"></span>applyIteration<span class="signature">(iteration)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Apply the current iteration</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>iteration</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>the iteration pbject</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1025">line 1025</a>
</li></ul></dd>
</dl>
<h4 class="name" id="applyStyle"><span class="type-signature"></span>applyStyle<span class="signature">(properties)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Apply the object in parameter as style properties</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>properties</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>the CSS style properties to apply</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line276">line 276</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="changeAnimation"><span class="type-signature"></span>changeAnimation<span class="signature">(animationName)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Change the currentAnimation</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>animationName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
default
</td>
<td class="description last"><p>the animation name on which to switch</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1176">line 1176</a>
</li></ul></dd>
</dl>
<h4 class="name" id="checkBreakpoints"><span class="type-signature"></span>checkBreakpoints<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>check each breakpoints on container or window, and applyStyle
if needed</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line677">line 677</a>
</li></ul></dd>
</dl>
<h4 class="name" id="checkDep"><span class="type-signature"></span>checkDep<span class="signature">(dependency, pushOrSplice)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Check dependencies and perform action on the array</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dependency</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
</td>
<td class="description last"><p>the dependency</p></td>
</tr>
<tr>
<td class="name"><code>pushOrSplice</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
push
</td>
<td class="description last"><p>push or splice</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line178">line 178</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deactivateEvent"><span class="type-signature"></span>deactivateEvent<span class="signature">(eventName)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Deactivate events without deleting them</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>eventName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the event to deactivate</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line558">line 558</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deleteAnimationKeyframe"><span class="type-signature"></span>deleteAnimationKeyframe<span class="signature">(time, prop)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Delete an animation keyframe</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>the time from which delete the propertie</p></td>
</tr>
<tr>
<td class="name"><code>prop</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the propertie name</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1251">line 1251</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deleteAnimationProperties"><span class="type-signature"></span>deleteAnimationProperties<span class="signature">(propertieArray)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Delete an animation propertie</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertieArray</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>the propertie array propertie = { key, value }</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1226">line 1226</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dispatchEvent"><span class="type-signature"></span>dispatchEvent<span class="signature">(eventName, params, glob)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Dispatch a custom event</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>eventName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the name of the event</p></td>
</tr>
<tr>
<td class="name"><code>params</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>the parameter to transmit</p></td>
</tr>
<tr>
<td class="name"><code>glob</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>is the custom event global or bind to the object id</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1163">line 1163</a>
</li></ul></dd>
</dl>
<h4 class="name" id="exportToJSON"><span class="type-signature"></span>exportToJSON<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Export the object as a reusable JSON</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1330">line 1330</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the JSON representation of the object</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="generate"><span class="type-signature"></span>generate<span class="signature">(type)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Generates the DOMElement based on type parameter</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>type of DOMElement</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line728">line 728</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="getComputedStyle"><span class="type-signature"></span>getComputedStyle<span class="signature">(propertie)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>get the computed style of a CSS propertie</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertie</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the css propertie</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line825">line 825</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>css - pixel value</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="getSortedSteps"><span class="type-signature"></span>getSortedSteps<span class="signature">()</span><span class="type-signature"> → {array}</span></h4>
<div class="description">
<p>Sorts the animations steps</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1298">line 1298</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the numeric array of the steps sorted >=</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
<h4 class="name" id="getTotalAnimationTime"><span class="type-signature"></span>getTotalAnimationTime<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
<p>Return total animation time</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1319">line 1319</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the total animation time</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Inititalize the MultimediaObject
generates the DOMElement, applyAttributes, sorts animations steps</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line128">line 128</a>
</li></ul></dd>
</dl>
<h4 class="name" id="interpolateStep"><span class="type-signature"></span>interpolateStep<span class="signature">(currentIteration, seconds, fps)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>frame interpolation, takes the value present at a certain frame in the interpolatedSteps array and apply it as style
needs an animation loop</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>currentIteration</code></td>
<td class="type">
<span class="param-type">int</span>
</td>
<td class="description last"><p>the current frame</p></td>
</tr>
<tr>
<td class="name"><code>seconds</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="description last"><p>the current frame</p></td>
</tr>
<tr>
<td class="name"><code>fps</code></td>
<td class="type">
<span class="param-type">int</span>
</td>
<td class="description last"><p>the framerate to preinterpolate if needed</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line990">line 990</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="loadFromJSON"><span class="type-signature"></span>loadFromJSON<span class="signature">(json)</span><span class="type-signature"></span></h4>
<div class="description">
<p>load a JSON representation of a MultimediaObject</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>json</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>a json representation of a MultimediaObject</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line1402">line 1402</a>
</li></ul></dd>
</dl>
<h4 class="name" id="preInterpolateStep"><span class="type-signature"></span>preInterpolateStep<span class="signature">(fps)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>pre interpolate animations steps for interpolation</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fps</code></td>
<td class="type">
<span class="param-type">int</span>
</td>
<td class="description last"><p>the framerate to use as base for the frame computation</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MultimediaObject.js.html">MultimediaObject.js</a>, <a href="MultimediaObject.js.html#line835">line 835</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>MultimediaObject</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(child)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>removes a child from a MultimediaObject</