crossbrowdy

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>CrossBrowdy API documentation [printable] Class: CB_AudioFileSprites</title>  <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.yeti.css"> </head> <body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <div class="navbar navbar-default navbar-fixed-top "> <div class="container"> <div class="navbar-header"> <a class="navbar-brand" href="index.html">CrossBrowdy API documentation [printable]</a> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> <div class="navbar-collapse collapse" id="topNavigation"> <ul class="nav navbar-nav"> <li class="dropdown"> <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> <ul class="dropdown-menu inline"> <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li> </ul> </li> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu inline"> <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li> </ul> </li> <li class="dropdown"> <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> <ul class="dropdown-menu inline"> <li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li> </ul> </li> </ul> <div class="col-sm-3 col-md-3"> <form class="navbar-form" role="search"> <div class="input-group"> <input type="text" class="form-control" placeholder="Search" name="q" id="search-input"> <div class="input-group-btn"> <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button> </div> </div> </form> </div> </div> </div> </div> <div class="container" id="toc-content" style="width:100%;"> <div class="row" style="width:100%;"> <div class="col-md-8" style="width:85%;"> <div id="main"> <h1 class="page-title">Class: CB_AudioFileSprites</h1> <section> <header> <h2> CB_AudioFileSprites </h2> <div class="class-description"><p>Class to manage audio sprites of a <a href="CB_AudioFileCache.html"><code>CB_AudioFileCache</code></a> object (used internally).</p></div> </header> <article> <div class="container-overview"> <hr> <dt> <h4 class="name" id="CB_AudioFileSprites"><span class="type-signature"></span>new CB_AudioFileSprites<span class="signature">( [dataObject])</span><span class="type-signature"> → {<a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a>}</span></h4> </dt> <dd> <div class="description"> <p>The constructor is recommended to be called through a user-driven event (as onClick, onTouch, etc.), as some clients may need this at least the first time in order to be able to play the audio.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th style="width:12%; min-width:110px;">Name</th> <th style="width:12%; min-width:110px;">Type</th> <th style="width:12%; min-width:110px;">Argument</th> <th class="last" style="min-width:310px;">Description</th> </tr> </thead> <tbody> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>dataObject</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type"><a href="CB_AudioFileSprites.html#.DATA_OBJECT">CB_AudioFileSprites.DATA_OBJECT</a></span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Object with the desired data and options for the audio sprites. Although it can contain a "sprites" property, it will also be used as the first and unique parameter when calling the constructor of the <a href="CB_AudioFileCache.html"><code>CB_AudioFileCache</code></a> object internally.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-68">line 68</a> </li> </ul> </dd> <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt> <dd class="tag-todo"> <ul> <li>Do not allow to create one object with an "id" which has already been used (unless the value is undefined, null...).</li> <li>Think about using wrapper to replace "this" in callbacks (callbackOk, callbackError) to point to the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object itself.</li> <li>Method getCopy and static method filterProperties (similar to the ones from <a href="CB_GraphicSprites.html"><code>CB_GraphicSprites</code></a> and <a href="CB_GraphicSpritesScene.html"><code>CB_GraphicSpritesScene</code></a>).</li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns a new <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></span> </dd> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <hr> <dt class="name" id="audioFileCache"> <h4 id="audioFileCache"><span class="type-signature"><readonly> </span>audioFileCache<span class="type-signature"> :<a href="CB_AudioFileCache.html">CB_AudioFileCache</a></span></h4> </dt> <dd> <div class="description"> <p>Contains the <a href="CB_AudioFileCache.html"><code>CB_AudioFileCache</code></a> object. Internal usage only recommended.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-182">line 182</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="id"> <h4 id="id"><span class="type-signature"><readonly> </span>id<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Stores the identifier for the audio file sprites object.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-81">line 81</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="spriteSoundInstances"> <h4 id="spriteSoundInstances"><span class="type-signature"><readonly> </span>spriteSoundInstances<span class="type-signature"> :Object</span></h4> </dt> <dd> <div class="description"> <p>Object whose property names are the sprite identifiers (strings), including one called "_WITHOUT_SPRITE_ASSOCIATED" for sound instances without a sprite associated, and their values are an array containing the sound instance identifiers (created by the <a href="CB_AudioFileSprites.html#play"><code>CB_AudioFileSprites#play</code></a> method). Internal usage only recommended.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>{ "_WITHOUT_SPRITE_ASSOCIATED" : [] }</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-99">line 99</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id="sprites"> <h4 id="sprites"><span class="type-signature"><readonly> </span>sprites<span class="type-signature"> :<a href="CB_AudioFileSprites.html#.SPRITES_OBJECT">CB_AudioFileSprites.SPRITES_OBJECT</a></span></h4> </dt> <dd> <div class="description"> <p>Object with information about the sprites.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_AudioFileSprites.html#.SPRITES_OBJECT">CB_AudioFileSprites.SPRITES_OBJECT</a></span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>{}</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-90">line 90</a> </li> </ul> </dd> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <hr> <dt> <h4 class="name" id="cancelSoundInstance"><span class="type-signature"></span>cancelSoundInstance<span class="signature">(soundInstanceId [, cancel] [, affectWithObjectAssociated])</span><span class="type-signature"> → {boolean}</span></h4> </dt> <dd> <div class="description"> <p>Cancels (to prevent it starts playing) or enables a sound instance (created by the <a href="CB_AudioFileCache.html#play"><code>CB_AudioFileCache#play</code></a> method), by its identifier. Uses the <a href="CB_AudioFileCache.html#cancelSoundInstance"><code>CB_AudioFileCache#cancelSoundInstance</code></a> method internally and returns its returning value.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th style="width:12%; min-width:110px;">Name</th> <th style="width:12%; min-width:110px;">Type</th> <th style="width:12%; min-width:110px;">Argument</th> <th style="width:12%; min-width:110px;">Default</th> <th class="last" style="min-width:310px;">Description</th> </tr> </thead> <tbody> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>soundInstanceId</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type">integer</span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "soundInstanceId" parameter when calling the <a href="CB_AudioFileCache.html#cancelSoundInstance"><code>CB_AudioFileCache#cancelSoundInstance</code></a> method internally.</p></td> </tr> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>cancel</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type">boolean</span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> false </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "cancel" parameter when calling the <a href="CB_AudioFileCache.html#cancelSoundInstance"><code>CB_AudioFileCache#cancelSoundInstance</code></a> method internally.</p></td> </tr> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>affectWithObjectAssociated</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type">boolean</span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> false </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "affectWithObjectAssociated" parameter when calling the <a href="CB_AudioFileCache.html#cancelSoundInstance"><code>CB_AudioFileCache#cancelSoundInstance</code></a> method internally.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-975">line 975</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns true if the sound instance has been modified or false otherwise.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="cancelSoundInstances"><span class="type-signature"></span>cancelSoundInstances<span class="signature">( [cancel] [, affectWithObjectAssociated])</span><span class="type-signature"> → {integer}</span></h4> </dt> <dd> <div class="description"> <p>Cancels (to prevent they start playing) or enables all sound instances (created by the <a href="CB_AudioFileCache.html#play"><code>CB_AudioFileCache#play</code></a> method). Uses the <a href="CB_AudioFileCache.html#cancelSoundInstances"><code>CB_AudioFileCache#cancelSoundInstances</code></a> method internally and returns its returning value.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th style="width:12%; min-width:110px;">Name</th> <th style="width:12%; min-width:110px;">Type</th> <th style="width:12%; min-width:110px;">Argument</th> <th style="width:12%; min-width:110px;">Default</th> <th class="last" style="min-width:310px;">Description</th> </tr> </thead> <tbody> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>cancel</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type">boolean</span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> false </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "cancel" parameter when calling the <a href="CB_AudioFileCache.html#cancelSoundInstances"><code>CB_AudioFileCache#cancelSoundInstances</code></a> method internally.</p></td> </tr> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>affectWithObjectAssociated</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type">boolean</span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> false </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "affectWithObjectAssociated" parameter when calling the <a href="CB_AudioFileCache.html#cancelSoundInstances"><code>CB_AudioFileCache#cancelSoundInstances</code></a> method internally.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-961">line 961</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns the number of sound instances modified.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">integer</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="checkPlayingAll"><span class="type-signature"></span>checkPlayingAll<span class="signature">( [callbackOk] [, callbackError] [, ignoreQueue])</span><span class="type-signature"> → {integer}</span></h4> </dt> <dd> <div class="description"> <p>Checks whether each <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object whose <a href="CB_AudioFile.html#getStatus"><code>CB_AudioFile#getStatus</code></a> method returns the "unchecked" value (which belongs to the value of the <code>CB_AudioFile#UNCHECKED</code> property) can be played or not. After checking, if the audio can be played, the status of the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object will get the value of <a href="CB_AudioFile.html#.LOADED"><code>CB_AudioFile.LOADED</code></a>. Otherwise, if it cannot be played, the status of the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object will get the value of <a href="CB_AudioFile.html#.FAILED"><code>CB_AudioFile.FAILED</code></a>. If a <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object cannot be played and it is determined necessary, it will try to reload it internally (by calling the <a href="CB_AudioFileCache.html#removeAudioFile"><code>CB_AudioFileCache#removeAudioFile</code></a> method). It will call the <a href="CB_AudioFileCache.html#clearAudioFiles"><code>CB_AudioFileCache#clearAudioFiles</code></a> method internally after finishing. Uses the <a href="CB_AudioFileCache.html#checkPlayingAll"><code>CB_AudioFileCache#checkPlayingAll</code></a> method internally and returns its returning value. Recommended to be called through a user-driven event (as onClick, onTouch, etc.).</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th style="width:12%; min-width:110px;">Name</th> <th style="width:12%; min-width:110px;">Type</th> <th style="width:12%; min-width:110px;">Argument</th> <th style="width:12%; min-width:110px;">Default</th> <th class="last" style="min-width:310px;">Description</th> </tr> </thead> <tbody> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackOk</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type"><a href="CB_AudioFileCache.html#.checkPlayingAll_CALLBACK_OK">CB_AudioFileCache.checkPlayingAll_CALLBACK_OK</a></span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "callbackOk" parameter when calling the <a href="CB_AudioFileCache.html#checkPlayingAll"><code>CB_AudioFileCache#checkPlayingAll</code></a> method internally.</p></td> </tr> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackError</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type"><a href="CB_AudioFileCache.html#.checkPlayingAll_CALLBACK_ERROR">CB_AudioFileCache.checkPlayingAll_CALLBACK_ERROR</a></span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "callbackError" parameter when calling the <a href="CB_AudioFileCache.html#checkPlayingAll"><code>CB_AudioFileCache#checkPlayingAll</code></a> method internally.</p></td> </tr> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>ignoreQueue</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type">boolean</span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> false </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "ignoreQueue" parameter when calling the <a href="CB_AudioFileCache.html#checkPlayingAll"><code>CB_AudioFileCache#checkPlayingAll</code></a> method internally.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-1072">line 1072</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns the number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose status belonged to the "unchecked" value (the value of the <code>CB_AudioFile#UNCHECKED</code> property) before the execution of this method. It will return 0 (zero) if the method is tried to be executed while there is another previous call of it still running. It will also return 0 (zero) if the status of the audio file cache is not loaded (the <a href="CB_AudioFileCache.html#status"><code>CB_AudioFileCache#status</code></a> property does not belong to the value set in the <a href="CB_AudioFileCache.html#.LOADED"><code>CB_AudioFileCache.LOADED</code></a> property).</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">integer</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="clearAudioFiles"><span class="type-signature"></span>clearAudioFiles<span class="signature">( [avoidCallingCheckCacheLoaded])</span><span class="type-signature"> → {array}</span></h4> </dt> <dd> <div class="description"> <p>Cleans the array of the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects (taking off the undefined or null ones) which is in the <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a> property, just keeping the valid ones and clearing (destroying and removing) the others. For performance purposes. Uses the <a href="CB_AudioFileCache.html#clearAudioFiles"><code>CB_AudioFileCache#clearAudioFiles</code></a> method internally and returns its returning value. Internal usage only recommended.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th style="width:12%; min-width:110px;">Name</th> <th style="width:12%; min-width:110px;">Type</th> <th style="width:12%; min-width:110px;">Argument</th> <th style="width:12%; min-width:110px;">Default</th> <th class="last" style="min-width:310px;">Description</th> </tr> </thead> <tbody> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidCallingCheckCacheLoaded</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type">boolean</span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> false </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "avoidCallingCheckCacheLoaded" parameter when calling the <a href="CB_AudioFileCache.html#clearAudioFiles"><code>CB_AudioFileCache#clearAudioFiles</code></a> method internally.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-857">line 857</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns the value of the <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a> property.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="clearSoundInstances"><span class="type-signature"></span>clearSoundInstances<span class="signature">( [clearWithObjectAssociated])</span><span class="type-signature"> → {integer}</span></h4> </dt> <dd> <div class="description"> <p>Clears the sound instances (created by the <a href="CB_AudioFileCache.html#play"><code>CB_AudioFileCache#play</code></a> method) which have been cancelled. Uses the <a href="CB_AudioFileCache.html#clearSoundInstances"><code>CB_AudioFileCache#clearSoundInstances</code></a> method internally and returns its returning value.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th style="width:12%; min-width:110px;">Name</th> <th style="width:12%; min-width:110px;">Type</th> <th style="width:12%; min-width:110px;">Argument</th> <th style="width:12%; min-width:110px;">Default</th> <th class="last" style="min-width:310px;">Description</th> </tr> </thead> <tbody> <tr> <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>clearWithObjectAssociated</code></td> <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <span class="param-type">boolean</span> </td> <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <optional><br> </td> <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> false </td> <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Used as the "clearWithObjectAssociated" parameter when calling the <a href="CB_AudioFileCache.html#clearSoundInstances"><code>CB_AudioFileCache#clearSoundInstances</code></a> method internally.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html">CrossBase/audiovisual/audio/CB_AudioFileSprites.js</a>, <a href="CrossBase_audiovisual_audio_CB_AudioFileSprites.js.html#sunlight-1-line-923">line 923</a> </li> </ul> </dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns the number of cleared sound instances.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">integer</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="createAudioFile"><span class="type-signature"></span>createAudioFile<span class="signature">( [URIs] [, preferredAPIs] [, preferredFormats] [, audioObject] [, callbackOk] [, callbackError] [, storeURIsList] [, checkAutomatically])</span><span class="type-signature"> → {<a href="CB_AudioFile.html">CB_AudioFile</a>|null}</span></h4> </dt> <dd> <div class="description"> <p>Creates one internal <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object (inside the <a href="CB