Class createjs.Sound.FrameAudioPlayer.Frame

Defined in: sound.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	createjs.Sound.FrameAudioPlayer.Frame() An inner class that encapsulates an element.</div> </td> </tr> </tbody> </table> <!-- ============================== properties summary ===================== --> <!-- ============================== methods summary ======================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class createjs.Sound.FrameAudioPlayer.Frame."> <caption>Method Summary</caption> <thead> <tr> <th scope="col">Method Attributes</th> <th scope="col">Method Name and Description</th> </tr> </thead> <tbody> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/createjs.Sound.FrameAudioPlayer.Frame.html#clone">clone</a></b>(id, clone, offset, duration, player) </div> <div class="description">Creates a clone of the specified sound.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/createjs.Sound.FrameAudioPlayer.Frame.html#destroy">destroy</a></b>() </div> <div class="description">Destroys this player.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/createjs.Sound.FrameAudioPlayer.Frame.html#handleEvent">handleEvent</a></b>(event) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/createjs.Sound.FrameAudioPlayer.Frame.html#load">load</a></b>(id, buffer, player) </div> <div class="description">Starts loading the specified sound.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/createjs.Sound.FrameAudioPlayer.Frame.html#load_">load_</a></b>(id, buffer) </div> <div class="description">Loads the specified sound and decodes it.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/createjs.Sound.FrameAudioPlayer.Frame.html#play">play</a></b>(id, loop, volume) </div> <div class="description">Starts playing the specified sound.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/createjs.Sound.FrameAudioPlayer.Frame.html#setVolume">setVolume</a></b>(id, volume) </div> <div class="description">Changes the volume of the specified sound.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/createjs.Sound.FrameAudioPlayer.Frame.html#stop">stop</a></b>(id) </div> <div class="description">Stops playing the specified sound.</div> </td> </tr> </tbody> </table> <!-- ============================== events summary ======================== --> <!-- ============================== constructor details ==================== --> <div class="details"><a name="constructor"> </a> <div class="sectionTitle"> Class Detail </div> <div class="fixedFont"> <b>createjs.Sound.FrameAudioPlayer.Frame</b>() </div> <div class="description"> An inner class that encapsulates an <iframe> element. </div> </div> <!-- ============================== field details ========================== --> <!-- ============================== method details ========================= --> <div class="sectionTitle"> Method Detail </div> <a name="clone"> </a> <div class="fixedFont"> <b>clone</b>(id, clone, offset, duration, player) </div> <div class="description"> Creates a clone of the specified sound. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{string}</span> <b>id</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{string}</span> <b>clone</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{number}</span> <b>offset</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{number}</span> <b>duration</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{<a href="../symbols/createjs.Sound.FrameAudioPlayer.html">createjs.Sound.FrameAudioPlayer</a>}</span> <b>player</b> </dt> <dd></dd> </dl> <hr /> <a name="destroy"> </a> <div class="fixedFont"> <b>destroy</b>() </div> <div class="description"> Destroys this player. This player destroys the <iframe> element to delete all its resources, e.g. AudioBuffers, BufferSourceNodes, etc. </div> <hr /> <a name="handleEvent"> </a> <div class="fixedFont"> <b>handleEvent</b>(event) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>event</b> </dt> <dd></dd> </dl> <hr /> <a name="load"> </a> <div class="fixedFont"> <span class="light">{boolean}</span> <b>load</b>(id, buffer, player) </div> <div class="description"> Starts loading the specified sound. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{string}</span> <b>id</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{ArrayBuffer}</span> <b>buffer</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{<a href="../symbols/createjs.Sound.FrameAudioPlayer.html">createjs.Sound.FrameAudioPlayer</a>}</span> <b>player</b> </dt> <dd></dd> </dl> <dl class="detailList"> <dt class="heading">Returns:</dt> <dd><span class="light fixedFont">{boolean}</span> </dd> </dl> <hr /> <a name="load_"> </a> <div class="fixedFont"> <b>load_</b>(id, buffer) </div> <div class="description"> Loads the specified sound and decodes it. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{string}</span> <b>id</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{ArrayBuffer}</span> <b>buffer</b> </dt> <dd></dd> </dl> <hr /> <a name="play"> </a> <div class="fixedFont"> <b>play</b>(id, loop, volume) </div> <div class="description"> Starts playing the specified sound. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{string}</span> <b>id</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{number}</span> <b>loop</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{number}</span> <b>volume</b> </dt> <dd></dd> </dl> <hr /> <a name="setVolume"> </a> <div class="fixedFont"> <b>setVolume</b>(id, volume) </div> <div class="description"> Changes the volume of the specified sound. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{string}</span> <b>id</b> </dt> <dd></dd> <dt> <span class="light fixedFont">{number}</span> <b>volume</b> </dt> <dd></dd> </dl> <hr /> <a name="stop"> </a> <div class="fixedFont"> <b>stop</b>(id) </div> <div class="description"> Stops playing the specified sound. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{string}</span> <b>id</b> </dt> <dd></dd> </dl> <!-- ============================== event details ========================= --> <hr /> </div> <!-- ============================== footer ================================= --> <div class="fineprint" style="clear:both"> Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Tue Oct 04 2016 17:11:29 GMT+0900 (JST) </div> </body> </html>

Classes

Class createjs.Sound.FrameAudioPlayer.Frame