UNPKG

395 kBHTMLView Raw
1<!DOCTYPE html>
2
3<html lang="en">
4<head>
5 <meta charset="utf-8">
6 <meta name="viewport" content="width=device-width">
7 <title>CrossBrowdy API documentation Class: CB_AudioFileSpritesPool</title>
8
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
13
14 <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
15
16</head>
17
18<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;">
19
20<div class="navbar navbar-default navbar-fixed-top ">
21<div class="container">
22 <div class="navbar-header">
23 <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
24 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
25 <span class="icon-bar"></span>
26 <span class="icon-bar"></span>
27 <span class="icon-bar"></span>
28 </button>
29 </div>
30 <div class="navbar-collapse collapse" id="topNavigation">
31 <ul class="nav navbar-nav">
32
33 <li class="dropdown">
34 <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
35 <ul class="dropdown-menu inline">
36 <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>
37 </ul>
38 </li>
39
40 <li class="dropdown">
41 <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
42 <ul class="dropdown-menu inline">
43 <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>
44 </ul>
45 </li>
46
47 <li class="dropdown">
48 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
49 <ul class="dropdown-menu inline">
50 <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>
51 </ul>
52 </li>
53
54 </ul>
55
56 <div class="col-sm-3 col-md-3">
57 <form class="navbar-form" role="search">
58 <div class="input-group">
59 <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
60 <div class="input-group-btn">
61 <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
62 </div>
63 </div>
64 </form>
65 </div>
66
67 </div>
68
69</div>
70</div>
71
72
73<div class="container" id="toc-content" style="width:100%;">
74<div class="row" style="width:100%;">
75
76
77 <div class="col-md-8" style="width:85%;">
78
79 <div id="main">
80
81
82
83 <h1 class="page-title">Class: CB_AudioFileSpritesPool</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_AudioFileSpritesPool
91 </h2>
92
93 <div class="class-description"><p>Class to manage many audio sprites stored in different groups, each with one <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object (used internally).</p></div>
94
95
96</header>
97
98
99<article>
100 <div class="container-overview">
101
102
103<hr>
104<dt>
105 <h4 class="name" id="CB_AudioFileSpritesPool"><span class="type-signature"></span>new CB_AudioFileSpritesPool<span class="signature">( [dataObject])</span><span class="type-signature"> &rarr; {<a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a>}</span></h4>
106
107
108</dt>
109<dd>
110
111
112 <div class="description">
113 <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>
114 </div>
115
116
117
118
119
120
121
122
123 <h5>Parameters:</h5>
124
125
126<table class="params table table-striped">
127 <thead>
128 <tr>
129
130 <th style="width:12%; min-width:110px;">Name</th>
131
132
133 <th style="width:12%; min-width:110px;">Type</th>
134
135
136 <th style="width:12%; min-width:110px;">Argument</th>
137
138
139
140
141 <th class="last" style="min-width:310px;">Description</th>
142 </tr>
143 </thead>
144
145 <tbody>
146
147
148 <tr>
149
150 <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>
151
152
153 <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;">
154
155
156<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.DATA_OBJECT">CB_AudioFileSpritesPool.DATA_OBJECT</a></span>
157
158
159
160
161 </td>
162
163
164 <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;">
165
166 &lt;optional><br>
167
168
169
170
171
172 </td>
173
174
175
176
177 <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 groups of audio sprites. Each group will have a <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object. Some of its properties (&quot;preferredAPIs&quot;, &quot;preferredFormats&quot;, &quot;minimumAudioFiles&quot;, &quot;maximumAudioFiles&quot;, &quot;minimumAudioFilesFree&quot;, &quot;newAudioFilesWhenNeeded&quot;, &quot;retries&quot;, &quot;checkManually&quot;, &quot;checkManuallyOnNeededCreated&quot;, &quot;checkManuallyOnPlayingFailed&quot;, &quot;checkManuallyOnCheckingFailed&quot; and &quot;disableAutoLoad&quot;) will be used as the default value to create internally the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> objects when the value is not given in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object (set as the value of the <code>CB_AudioFileSpritesPool.DATA_OBJECT#spritesGroups</code> property).</p></td>
178 </tr>
179
180
181 </tbody>
182</table>
183
184
185
186
187<dl class="details">
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
218 <dd class="tag-source">
219 <ul class="dummy">
220 <li>
221 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
222 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-55">line 55</a>
223 </li>
224 </ul>
225 </dd>
226
227
228
229
230
231
232
233 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
234 <dd class="tag-todo">
235 <ul>
236 <li>Do not allow to create one object with an "id" which has already been used (unless the value is undefined, null...).</li>
237
238 <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>
239 </ul>
240 </dd>
241
242</dl>
243
244
245
246
247
248
249
250
251
252
253
254
255
256 <h5>Returns:</h5>
257
258
259<div class="param-desc">
260 <p>Returns a new <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object.</p>
261</div>
262
263
264
265<dl>
266 <dt>
267 Type
268 </dt>
269 <dd>
270
271<span class="param-type"><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></span>
272
273
274
275 </dd>
276</dl>
277
278
279
280
281
282</dd>
283
284
285 </div>
286
287
288
289
290
291
292
293
294
295
296
297
298 <h3 class="subsection-title">Members</h3>
299
300 <dl>
301
302<hr>
303<dt class="name" id="audioFileSprites">
304 <h4 id="audioFileSprites"><span class="type-signature">&lt;readonly> </span>audioFileSprites<span class="type-signature"> :Object</span></h4>
305
306
307</dt>
308<dd>
309
310 <div class="description">
311 <p>Stores the internally-created <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> objects, using the name of each property as their group ID and the value being the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object itself. Internal usage only recommended.</p>
312 </div>
313
314
315
316 <h5>Type:</h5>
317 <ul>
318 <li>
319
320<span class="param-type">Object</span>
321
322
323
324 </li>
325 </ul>
326
327
328
329<dl class="details">
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
356 <dd class="tag-default">
357 <ul class="dummy">
358 <li>{}</li>
359 </ul>
360 </dd>
361
362
363
364
365
366 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
367 <dd class="tag-source">
368 <ul class="dummy">
369 <li>
370 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
371 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-204">line 204</a>
372 </li>
373 </ul>
374 </dd>
375
376
377
378
379
380
381
382</dl>
383
384
385
386</dd>
387
388
389
390<hr>
391<dt class="name" id="checkManually">
392 <h4 id="checkManually"><span class="type-signature">&lt;readonly> </span>checkManually<span class="type-signature"> :boolean</span></h4>
393
394
395</dt>
396<dd>
397
398 <div class="description">
399 <p>Tells whether the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects must be checked automatically or not (manually). Internal usage only recommended.</p>
400 </div>
401
402
403
404 <h5>Type:</h5>
405 <ul>
406 <li>
407
408<span class="param-type">boolean</span>
409
410
411
412 </li>
413 </ul>
414
415
416
417<dl class="details">
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
444 <dd class="tag-default">
445 <ul class="dummy">
446 <li>CB_AudioFileCache.checkManually_DEFAULT</li>
447 </ul>
448 </dd>
449
450
451
452
453
454 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
455 <dd class="tag-source">
456 <ul class="dummy">
457 <li>
458 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
459 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-141">line 141</a>
460 </li>
461 </ul>
462 </dd>
463
464
465
466
467
468
469
470</dl>
471
472
473
474</dd>
475
476
477
478<hr>
479<dt class="name" id="checkManuallyOnCheckingFailed">
480 <h4 id="checkManuallyOnCheckingFailed"><span class="type-signature">&lt;readonly> </span>checkManuallyOnCheckingFailed<span class="type-signature"> :boolean</span></h4>
481
482
483</dt>
484<dd>
485
486 <div class="description">
487 <p>Tells whether the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects must be checked automatically or not (manually) when checking one has failed and tries to reload it. Internal usage only recommended.</p>
488 </div>
489
490
491
492 <h5>Type:</h5>
493 <ul>
494 <li>
495
496<span class="param-type">boolean</span>
497
498
499
500 </li>
501 </ul>
502
503
504
505<dl class="details">
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
532 <dd class="tag-default">
533 <ul class="dummy">
534 <li>CB_AudioFileCache.checkManuallyOnCheckingFailed_DEFAULT</li>
535 </ul>
536 </dd>
537
538
539
540
541
542 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
543 <dd class="tag-source">
544 <ul class="dummy">
545 <li>
546 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
547 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-168">line 168</a>
548 </li>
549 </ul>
550 </dd>
551
552
553
554
555
556
557
558</dl>
559
560
561
562</dd>
563
564
565
566<hr>
567<dt class="name" id="checkManuallyOnNeededCreated">
568 <h4 id="checkManuallyOnNeededCreated"><span class="type-signature">&lt;readonly> </span>checkManuallyOnNeededCreated<span class="type-signature"> :boolean</span></h4>
569
570
571</dt>
572<dd>
573
574 <div class="description">
575 <p>Tells whether the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects must be checked automatically or not (manually) when creates a new <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object needed. Internal usage only recommended.</p>
576 </div>
577
578
579
580 <h5>Type:</h5>
581 <ul>
582 <li>
583
584<span class="param-type">boolean</span>
585
586
587
588 </li>
589 </ul>
590
591
592
593<dl class="details">
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
620 <dd class="tag-default">
621 <ul class="dummy">
622 <li>CB_AudioFileCache.checkManuallyOnNeededCreated_DEFAULT</li>
623 </ul>
624 </dd>
625
626
627
628
629
630 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
631 <dd class="tag-source">
632 <ul class="dummy">
633 <li>
634 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
635 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-150">line 150</a>
636 </li>
637 </ul>
638 </dd>
639
640
641
642
643
644
645
646</dl>
647
648
649
650</dd>
651
652
653
654<hr>
655<dt class="name" id="checkManuallyOnPlayingFailed">
656 <h4 id="checkManuallyOnPlayingFailed"><span class="type-signature">&lt;readonly> </span>checkManuallyOnPlayingFailed<span class="type-signature"> :boolean</span></h4>
657
658
659</dt>
660<dd>
661
662 <div class="description">
663 <p>Tells whether the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects must be checked automatically or not (manually) when playing one has failed and tries to reload it. Internal usage only recommended.</p>
664 </div>
665
666
667
668 <h5>Type:</h5>
669 <ul>
670 <li>
671
672<span class="param-type">boolean</span>
673
674
675
676 </li>
677 </ul>
678
679
680
681<dl class="details">
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
708 <dd class="tag-default">
709 <ul class="dummy">
710 <li>CB_AudioFileCache.checkManuallyOnPlayingFailed_DEFAULT</li>
711 </ul>
712 </dd>
713
714
715
716
717
718 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
719 <dd class="tag-source">
720 <ul class="dummy">
721 <li>
722 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
723 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-159">line 159</a>
724 </li>
725 </ul>
726 </dd>
727
728
729
730
731
732
733
734</dl>
735
736
737
738</dd>
739
740
741
742<hr>
743<dt class="name" id="disableAutoLoad">
744 <h4 id="disableAutoLoad"><span class="type-signature">&lt;readonly> </span>disableAutoLoad<span class="type-signature"> :boolean</span></h4>
745
746
747</dt>
748<dd>
749
750 <div class="description">
751 <p>If set to true, it will not create automatically the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects by calling the <a href="CB_AudioFileCache.html#createAudioFiles"><code>CB_AudioFileCache#createAudioFiles</code></a> method internally. Internal usage only recommended.</p>
752 </div>
753
754
755
756 <h5>Type:</h5>
757 <ul>
758 <li>
759
760<span class="param-type">boolean</span>
761
762
763
764 </li>
765 </ul>
766
767
768
769<dl class="details">
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
796 <dd class="tag-default">
797 <ul class="dummy">
798 <li>false</li>
799 </ul>
800 </dd>
801
802
803
804
805
806 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
807 <dd class="tag-source">
808 <ul class="dummy">
809 <li>
810 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
811 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-177">line 177</a>
812 </li>
813 </ul>
814 </dd>
815
816
817
818
819
820
821
822</dl>
823
824
825
826</dd>
827
828
829
830<hr>
831<dt class="name" id="id">
832 <h4 id="id"><span class="type-signature">&lt;readonly> </span>id<span class="type-signature"> :string</span></h4>
833
834
835</dt>
836<dd>
837
838 <div class="description">
839 <p>Stores the identifier for the audio file sprites pool object.</p>
840 </div>
841
842
843
844 <h5>Type:</h5>
845 <ul>
846 <li>
847
848<span class="param-type">string</span>
849
850
851
852 </li>
853 </ul>
854
855
856
857<dl class="details">
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
888 <dd class="tag-source">
889 <ul class="dummy">
890 <li>
891 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
892 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-68">line 68</a>
893 </li>
894 </ul>
895 </dd>
896
897
898
899
900
901
902
903</dl>
904
905
906
907</dd>
908
909
910
911<hr>
912<dt class="name" id="maximumAudioFiles">
913 <h4 id="maximumAudioFiles"><span class="type-signature">&lt;readonly> </span>maximumAudioFiles<span class="type-signature"> :integer|null</span></h4>
914
915
916</dt>
917<dd>
918
919 <div class="description">
920 <p>Maximum <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that are to be created internally for each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object. If it is set to null, there will not be a maximum (it will be unlimited). If an integer is provided, it must be the same number or greater than the value set in the <a href="CB_AudioFileCache.html#minimumAudioFiles"><code>CB_AudioFileCache#minimumAudioFiles</code></a> property, allowing 1 minimum. Internal usage only recommended.</p>
921 </div>
922
923
924
925 <h5>Type:</h5>
926 <ul>
927 <li>
928
929<span class="param-type">integer</span>
930|
931
932<span class="param-type">null</span>
933
934
935
936 </li>
937 </ul>
938
939
940
941<dl class="details">
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
968 <dd class="tag-default">
969 <ul class="dummy">
970 <li>CB_AudioFileCache.maximumAudioFiles_DEFAULT</li>
971 </ul>
972 </dd>
973
974
975
976
977
978 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
979 <dd class="tag-source">
980 <ul class="dummy">
981 <li>
982 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
983 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-104">line 104</a>
984 </li>
985 </ul>
986 </dd>
987
988
989
990
991
992
993
994</dl>
995
996
997
998</dd>
999
1000
1001
1002<hr>
1003<dt class="name" id="minimumAudioFiles">
1004 <h4 id="minimumAudioFiles"><span class="type-signature">&lt;readonly> </span>minimumAudioFiles<span class="type-signature"> :integer</span></h4>
1005
1006
1007</dt>
1008<dd>
1009
1010 <div class="description">
1011 <p>Minimum <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects to create internally for each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object. It must be an integer being 1 the minimum. Internal usage only recommended.</p>
1012 </div>
1013
1014
1015
1016 <h5>Type:</h5>
1017 <ul>
1018 <li>
1019
1020<span class="param-type">integer</span>
1021
1022
1023
1024 </li>
1025 </ul>
1026
1027
1028
1029<dl class="details">
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1056 <dd class="tag-default">
1057 <ul class="dummy">
1058 <li>CB_AudioFileCache.minimumAudioFiles_DEFAULT</li>
1059 </ul>
1060 </dd>
1061
1062
1063
1064
1065
1066 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1067 <dd class="tag-source">
1068 <ul class="dummy">
1069 <li>
1070 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1071 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-95">line 95</a>
1072 </li>
1073 </ul>
1074 </dd>
1075
1076
1077
1078
1079
1080
1081
1082</dl>
1083
1084
1085
1086</dd>
1087
1088
1089
1090<hr>
1091<dt class="name" id="minimumAudioFilesFree">
1092 <h4 id="minimumAudioFilesFree"><span class="type-signature">&lt;readonly> </span>minimumAudioFilesFree<span class="type-signature"> :integer</span></h4>
1093
1094
1095</dt>
1096<dd>
1097
1098 <div class="description">
1099 <p>New <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects will be created internally for each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object when the number of free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects reaches this limit. It must be an integer being 0 (zero) the minimum. Internal usage only recommended.</p>
1100 </div>
1101
1102
1103
1104 <h5>Type:</h5>
1105 <ul>
1106 <li>
1107
1108<span class="param-type">integer</span>
1109
1110
1111
1112 </li>
1113 </ul>
1114
1115
1116
1117<dl class="details">
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1144 <dd class="tag-default">
1145 <ul class="dummy">
1146 <li>parseInt(<a href="CB_AudioFileCache.html#minimumAudioFiles"><code>CB_AudioFileCache#minimumAudioFiles</code></a> * 0.25 + 0.5)</li>
1147 </ul>
1148 </dd>
1149
1150
1151
1152
1153
1154 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1155 <dd class="tag-source">
1156 <ul class="dummy">
1157 <li>
1158 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1159 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-113">line 113</a>
1160 </li>
1161 </ul>
1162 </dd>
1163
1164
1165
1166
1167
1168
1169
1170</dl>
1171
1172
1173
1174</dd>
1175
1176
1177
1178<hr>
1179<dt class="name" id="newAudioFilesWhenNeeded">
1180 <h4 id="newAudioFilesWhenNeeded"><span class="type-signature">&lt;readonly> </span>newAudioFilesWhenNeeded<span class="type-signature"> :integer</span></h4>
1181
1182
1183</dt>
1184<dd>
1185
1186 <div class="description">
1187 <p>Number of new <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects to create internally for each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object when the minimum limit of free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects (<a href="CB_AudioFileCache.html#minimumAudioFilesFree"><code>CB_AudioFileCache#minimumAudioFilesFree</code></a>) is reached. It must be an integer being 0 (zero) the minimum. Internal usage only recommended.</p>
1188 </div>
1189
1190
1191
1192 <h5>Type:</h5>
1193 <ul>
1194 <li>
1195
1196<span class="param-type">integer</span>
1197
1198
1199
1200 </li>
1201 </ul>
1202
1203
1204
1205<dl class="details">
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1232 <dd class="tag-default">
1233 <ul class="dummy">
1234 <li>Math.min(parseInt(<a href="CB_AudioFileCache.html#minimumAudioFiles"><code>CB_AudioFileCache#minimumAudioFiles</code></a> * 0.1 + 0.5), 1)</li>
1235 </ul>
1236 </dd>
1237
1238
1239
1240
1241
1242 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1243 <dd class="tag-source">
1244 <ul class="dummy">
1245 <li>
1246 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1247 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-122">line 122</a>
1248 </li>
1249 </ul>
1250 </dd>
1251
1252
1253
1254
1255
1256
1257
1258</dl>
1259
1260
1261
1262</dd>
1263
1264
1265
1266<hr>
1267<dt class="name" id="onError">
1268 <h4 id="onError"><span class="type-signature">&lt;readonly> </span>onError<span class="type-signature"> :function</span></h4>
1269
1270
1271</dt>
1272<dd>
1273
1274 <div class="description">
1275 <p>Desired function to be called when any kind of error happens. The first and unique parameter will be a string with the error description (if it could be determined), being &quot;this&quot; the current <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object. If a function is set, it will always be called through the <a href="CB_AudioFileSpritesPool.html#errorFunction"><code>CB_AudioFileSpritesPool#errorFunction</code></a> method whenever the &quot;onError&quot; event of an internally-created <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object is fired.</p>
1276 </div>
1277
1278
1279
1280 <h5>Type:</h5>
1281 <ul>
1282 <li>
1283
1284<span class="param-type">function</span>
1285
1286
1287
1288 </li>
1289 </ul>
1290
1291
1292
1293<dl class="details">
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1324 <dd class="tag-source">
1325 <ul class="dummy">
1326 <li>
1327 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1328 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-195">line 195</a>
1329 </li>
1330 </ul>
1331 </dd>
1332
1333
1334
1335
1336
1337
1338
1339</dl>
1340
1341
1342
1343</dd>
1344
1345
1346
1347<hr>
1348<dt class="name" id="onLoad">
1349 <h4 id="onLoad"><span class="type-signature">&lt;readonly> </span>onLoad<span class="type-signature"> :function</span></h4>
1350
1351
1352</dt>
1353<dd>
1354
1355 <div class="description">
1356 <p>Desired function to be called once the pool has been loaded. The first and unique parameter will be an integer with the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that still need to be checked, if any, being &quot;this&quot; the current <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object.</p>
1357 </div>
1358
1359
1360
1361 <h5>Type:</h5>
1362 <ul>
1363 <li>
1364
1365<span class="param-type">function</span>
1366
1367
1368
1369 </li>
1370 </ul>
1371
1372
1373
1374<dl class="details">
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1405 <dd class="tag-source">
1406 <ul class="dummy">
1407 <li>
1408 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1409 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-186">line 186</a>
1410 </li>
1411 </ul>
1412 </dd>
1413
1414
1415
1416
1417
1418
1419
1420</dl>
1421
1422
1423
1424</dd>
1425
1426
1427
1428<hr>
1429<dt class="name" id="preferredAPIs">
1430 <h4 id="preferredAPIs"><span class="type-signature">&lt;readonly> </span>preferredAPIs<span class="type-signature"> :array</span></h4>
1431
1432
1433</dt>
1434<dd>
1435
1436 <div class="description">
1437 <p>Stores an array of strings with the preferred audio API or audio APIs, in order of preference. Possible audio APIs are &quot;WAAPI&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API">HTML5 Web Audio API</a>), &quot;SM2&quot; (<a href="http://schillmania.com/projects/soundmanager2/">SoundManager 2</a>), &quot;ACMP&quot; (<a href="https://github.com/apache/cordova-plugin-media">Apache Cordova Media Plugin</a>) or &quot;AAPI&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/audio">HTML5 Audio API</a>). Internal usage only recommended.</p>
1438 </div>
1439
1440
1441
1442 <h5>Type:</h5>
1443 <ul>
1444 <li>
1445
1446<span class="param-type">array</span>
1447
1448
1449
1450 </li>
1451 </ul>
1452
1453
1454
1455<dl class="details">
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1482 <dd class="tag-default">
1483 <ul class="dummy">
1484 <li>CB_Configuration.CrossBase.CB_AudioFileCache_PREFERRED_AUDIO_APIS</li>
1485 </ul>
1486 </dd>
1487
1488
1489
1490
1491
1492 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1493 <dd class="tag-source">
1494 <ul class="dummy">
1495 <li>
1496 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1497 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-77">line 77</a>
1498 </li>
1499 </ul>
1500 </dd>
1501
1502
1503
1504
1505
1506
1507
1508</dl>
1509
1510
1511
1512</dd>
1513
1514
1515
1516<hr>
1517<dt class="name" id="preferredFormats">
1518 <h4 id="preferredFormats"><span class="type-signature">&lt;readonly> </span>preferredFormats<span class="type-signature"> :array</span></h4>
1519
1520
1521</dt>
1522<dd>
1523
1524 <div class="description">
1525 <p>Stores an array of strings with the preferred audio format or audio formats (they can include just the format as 'audio/ogg' or also the codec as for example 'audio/ogg; codecs=&quot;vorbis&quot;'), in order of preference. Internal usage only recommended.</p>
1526 </div>
1527
1528
1529
1530 <h5>Type:</h5>
1531 <ul>
1532 <li>
1533
1534<span class="param-type">array</span>
1535
1536
1537
1538 </li>
1539 </ul>
1540
1541
1542
1543<dl class="details">
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1570 <dd class="tag-default">
1571 <ul class="dummy">
1572 <li>CB_Configuration.CrossBase.CB_AudioFileCache_PREFERRED_AUDIO_FORMATS</li>
1573 </ul>
1574 </dd>
1575
1576
1577
1578
1579
1580 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1581 <dd class="tag-source">
1582 <ul class="dummy">
1583 <li>
1584 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1585 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-86">line 86</a>
1586 </li>
1587 </ul>
1588 </dd>
1589
1590
1591
1592
1593
1594
1595
1596</dl>
1597
1598
1599
1600</dd>
1601
1602
1603
1604<hr>
1605<dt class="name" id="retries">
1606 <h4 id="retries"><span class="type-signature">&lt;readonly> </span>retries<span class="type-signature"> :integer</span></h4>
1607
1608
1609</dt>
1610<dd>
1611
1612 <div class="description">
1613 <p>Number of retries to try to load a <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object internally before trying to load the next possible one internally (if any). It must be an integer being 0 the minimum. Internal usage only recommended.</p>
1614 </div>
1615
1616
1617
1618 <h5>Type:</h5>
1619 <ul>
1620 <li>
1621
1622<span class="param-type">integer</span>
1623
1624
1625
1626 </li>
1627 </ul>
1628
1629
1630
1631<dl class="details">
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1658 <dd class="tag-default">
1659 <ul class="dummy">
1660 <li>CB_AudioFileCache.retries_DEFAULT</li>
1661 </ul>
1662 </dd>
1663
1664
1665
1666
1667
1668 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1669 <dd class="tag-source">
1670 <ul class="dummy">
1671 <li>
1672 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1673 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-131">line 131</a>
1674 </li>
1675 </ul>
1676 </dd>
1677
1678
1679
1680
1681
1682
1683
1684</dl>
1685
1686
1687
1688</dd>
1689
1690
1691
1692<hr>
1693<dt class="name" id=".ABORTED">
1694 <h4 id=".ABORTED"><span class="type-signature">&lt;static, constant> </span>ABORTED<span class="type-signature"> :integer</span></h4>
1695
1696
1697</dt>
1698<dd>
1699
1700 <div class="description">
1701 <p>Status value for an audio file sprites pool which has been aborted. This will happen when the audio file sprites pool has been destroyed with the <a href="CB_AudioFileSpritesPool.html#destructor"><code>CB_AudioFileSpritesPool#destructor</code></a> method. Can be used to compare the value returned by the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method. Recommended for internal usage only.</p>
1702 </div>
1703
1704
1705
1706 <h5>Type:</h5>
1707 <ul>
1708 <li>
1709
1710<span class="param-type">integer</span>
1711
1712
1713
1714 </li>
1715 </ul>
1716
1717
1718
1719<dl class="details">
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1746 <dd class="tag-default">
1747 <ul class="dummy">
1748 <li>6</li>
1749 </ul>
1750 </dd>
1751
1752
1753
1754
1755
1756 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1757 <dd class="tag-source">
1758 <ul class="dummy">
1759 <li>
1760 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1761 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-277">line 277</a>
1762 </li>
1763 </ul>
1764 </dd>
1765
1766
1767
1768
1769
1770
1771
1772</dl>
1773
1774
1775
1776</dd>
1777
1778
1779
1780<hr>
1781<dt class="name" id=".CHECKING">
1782 <h4 id=".CHECKING"><span class="type-signature">&lt;static, constant> </span>CHECKING<span class="type-signature"> :integer</span></h4>
1783
1784
1785</dt>
1786<dd>
1787
1788 <div class="description">
1789 <p>Status value for an audio file sprites pool which is being checked currently. Can be used to compare the value returned by the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method. Recommended for internal usage only.</p>
1790 </div>
1791
1792
1793
1794 <h5>Type:</h5>
1795 <ul>
1796 <li>
1797
1798<span class="param-type">integer</span>
1799
1800
1801
1802 </li>
1803 </ul>
1804
1805
1806
1807<dl class="details">
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1834 <dd class="tag-default">
1835 <ul class="dummy">
1836 <li>3</li>
1837 </ul>
1838 </dd>
1839
1840
1841
1842
1843
1844 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1845 <dd class="tag-source">
1846 <ul class="dummy">
1847 <li>
1848 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1849 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-253">line 253</a>
1850 </li>
1851 </ul>
1852 </dd>
1853
1854
1855
1856
1857
1858
1859
1860</dl>
1861
1862
1863
1864</dd>
1865
1866
1867
1868<hr>
1869<dt class="name" id=".FAILED">
1870 <h4 id=".FAILED"><span class="type-signature">&lt;static, constant> </span>FAILED<span class="type-signature"> :integer</span></h4>
1871
1872
1873</dt>
1874<dd>
1875
1876 <div class="description">
1877 <p>Status value for an audio file sprites pool which failed to be loaded or failed for any other reason. Can be used to compare the value returned by the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method. Recommended for internal usage only.</p>
1878 </div>
1879
1880
1881
1882 <h5>Type:</h5>
1883 <ul>
1884 <li>
1885
1886<span class="param-type">integer</span>
1887
1888
1889
1890 </li>
1891 </ul>
1892
1893
1894
1895<dl class="details">
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1922 <dd class="tag-default">
1923 <ul class="dummy">
1924 <li>5</li>
1925 </ul>
1926 </dd>
1927
1928
1929
1930
1931
1932 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1933 <dd class="tag-source">
1934 <ul class="dummy">
1935 <li>
1936 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
1937 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-269">line 269</a>
1938 </li>
1939 </ul>
1940 </dd>
1941
1942
1943
1944
1945
1946
1947
1948</dl>
1949
1950
1951
1952</dd>
1953
1954
1955
1956<hr>
1957<dt class="name" id=".LOADED">
1958 <h4 id=".LOADED"><span class="type-signature">&lt;static, constant> </span>LOADED<span class="type-signature"> :integer</span></h4>
1959
1960
1961</dt>
1962<dd>
1963
1964 <div class="description">
1965 <p>Status value for an audio file sprites pool which has been loaded. Can be used to compare the value returned by the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method. Recommended for internal usage only.</p>
1966 </div>
1967
1968
1969
1970 <h5>Type:</h5>
1971 <ul>
1972 <li>
1973
1974<span class="param-type">integer</span>
1975
1976
1977
1978 </li>
1979 </ul>
1980
1981
1982
1983<dl class="details">
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
2010 <dd class="tag-default">
2011 <ul class="dummy">
2012 <li>4</li>
2013 </ul>
2014 </dd>
2015
2016
2017
2018
2019
2020 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2021 <dd class="tag-source">
2022 <ul class="dummy">
2023 <li>
2024 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
2025 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-261">line 261</a>
2026 </li>
2027 </ul>
2028 </dd>
2029
2030
2031
2032
2033
2034
2035
2036</dl>
2037
2038
2039
2040</dd>
2041
2042
2043
2044<hr>
2045<dt class="name" id=".LOADING">
2046 <h4 id=".LOADING"><span class="type-signature">&lt;static, constant> </span>LOADING<span class="type-signature"> :integer</span></h4>
2047
2048
2049</dt>
2050<dd>
2051
2052 <div class="description">
2053 <p>Status value for an audio file sprites pool which is loading. Can be used to compare the value returned by the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method. Recommended for internal usage only.</p>
2054 </div>
2055
2056
2057
2058 <h5>Type:</h5>
2059 <ul>
2060 <li>
2061
2062<span class="param-type">integer</span>
2063
2064
2065
2066 </li>
2067 </ul>
2068
2069
2070
2071<dl class="details">
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
2098 <dd class="tag-default">
2099 <ul class="dummy">
2100 <li>1</li>
2101 </ul>
2102 </dd>
2103
2104
2105
2106
2107
2108 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2109 <dd class="tag-source">
2110 <ul class="dummy">
2111 <li>
2112 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
2113 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-237">line 237</a>
2114 </li>
2115 </ul>
2116 </dd>
2117
2118
2119
2120
2121
2122
2123
2124</dl>
2125
2126
2127
2128</dd>
2129
2130
2131
2132<hr>
2133<dt class="name" id=".UNCHECKED">
2134 <h4 id=".UNCHECKED"><span class="type-signature">&lt;static, constant> </span>UNCHECKED<span class="type-signature"> :integer</span></h4>
2135
2136
2137</dt>
2138<dd>
2139
2140 <div class="description">
2141 <p>Status value for an audio file sprites pool which has not been checked yet. Can be used to compare the value returned by the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method. Recommended for internal usage only.</p>
2142 </div>
2143
2144
2145
2146 <h5>Type:</h5>
2147 <ul>
2148 <li>
2149
2150<span class="param-type">integer</span>
2151
2152
2153
2154 </li>
2155 </ul>
2156
2157
2158
2159<dl class="details">
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
2186 <dd class="tag-default">
2187 <ul class="dummy">
2188 <li>2</li>
2189 </ul>
2190 </dd>
2191
2192
2193
2194
2195
2196 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2197 <dd class="tag-source">
2198 <ul class="dummy">
2199 <li>
2200 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
2201 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-245">line 245</a>
2202 </li>
2203 </ul>
2204 </dd>
2205
2206
2207
2208
2209
2210
2211
2212</dl>
2213
2214
2215
2216</dd>
2217
2218
2219
2220<hr>
2221<dt class="name" id=".UNLOADED">
2222 <h4 id=".UNLOADED"><span class="type-signature">&lt;static, constant> </span>UNLOADED<span class="type-signature"> :integer</span></h4>
2223
2224
2225</dt>
2226<dd>
2227
2228 <div class="description">
2229 <p>Status value for audio file sprites pool which is unloaded. Can be used to compare the value returned by the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method. Recommended for internal usage only.</p>
2230 </div>
2231
2232
2233
2234 <h5>Type:</h5>
2235 <ul>
2236 <li>
2237
2238<span class="param-type">integer</span>
2239
2240
2241
2242 </li>
2243 </ul>
2244
2245
2246
2247<dl class="details">
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
2274 <dd class="tag-default">
2275 <ul class="dummy">
2276 <li>0</li>
2277 </ul>
2278 </dd>
2279
2280
2281
2282
2283
2284 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2285 <dd class="tag-source">
2286 <ul class="dummy">
2287 <li>
2288 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
2289 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-229">line 229</a>
2290 </li>
2291 </ul>
2292 </dd>
2293
2294
2295
2296
2297
2298
2299
2300</dl>
2301
2302
2303
2304</dd>
2305
2306 </dl>
2307
2308
2309
2310 <h3 class="subsection-title">Methods</h3>
2311
2312 <dl>
2313
2314<hr>
2315<dt>
2316 <h4 class="name" id="cancelSoundInstance"><span class="type-signature"></span>cancelSoundInstance<span class="signature">(soundInstanceId [, cancel] [, affectWithObjectAssociated])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
2317
2318
2319</dt>
2320<dd>
2321
2322
2323 <div class="description">
2324 <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_AudioFileSprites.html#cancelSoundInstance"><code>CB_AudioFileSprites#cancelSoundInstance</code></a> method internally.</p>
2325 </div>
2326
2327
2328
2329
2330
2331
2332
2333
2334 <h5>Parameters:</h5>
2335
2336
2337<table class="params table table-striped">
2338 <thead>
2339 <tr>
2340
2341 <th style="width:12%; min-width:110px;">Name</th>
2342
2343
2344 <th style="width:12%; min-width:110px;">Type</th>
2345
2346
2347 <th style="width:12%; min-width:110px;">Argument</th>
2348
2349
2350
2351 <th style="width:12%; min-width:110px;">Default</th>
2352
2353
2354 <th class="last" style="min-width:310px;">Description</th>
2355 </tr>
2356 </thead>
2357
2358 <tbody>
2359
2360
2361 <tr>
2362
2363 <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>
2364
2365
2366 <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;">
2367
2368
2369<span class="param-type">integer</span>
2370
2371
2372
2373
2374 </td>
2375
2376
2377 <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;">
2378
2379
2380
2381
2382
2383 </td>
2384
2385
2386
2387 <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;">
2388
2389 </td>
2390
2391
2392 <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 &quot;soundInstanceId&quot; parameter when calling the <a href="CB_AudioFileSprites.html#cancelSoundInstance"><code>CB_AudioFileSprites#cancelSoundInstance</code></a> method internally.</p></td>
2393 </tr>
2394
2395
2396
2397 <tr>
2398
2399 <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>
2400
2401
2402 <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;">
2403
2404
2405<span class="param-type">boolean</span>
2406
2407
2408
2409
2410 </td>
2411
2412
2413 <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;">
2414
2415 &lt;optional><br>
2416
2417
2418
2419
2420
2421 </td>
2422
2423
2424
2425 <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;">
2426
2427 false
2428
2429 </td>
2430
2431
2432 <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 &quot;cancel&quot; parameter when calling the <a href="CB_AudioFileSprites.html#cancelSoundInstance"><code>CB_AudioFileSprites#cancelSoundInstance</code></a> method internally.</p></td>
2433 </tr>
2434
2435
2436
2437 <tr>
2438
2439 <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>
2440
2441
2442 <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;">
2443
2444
2445<span class="param-type">boolean</span>
2446
2447
2448
2449
2450 </td>
2451
2452
2453 <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;">
2454
2455 &lt;optional><br>
2456
2457
2458
2459
2460
2461 </td>
2462
2463
2464
2465 <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;">
2466
2467 false
2468
2469 </td>
2470
2471
2472 <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 &quot;affectWithObjectAssociated&quot; parameter when calling the <a href="CB_AudioFileSprites.html#cancelSoundInstance"><code>CB_AudioFileSprites#cancelSoundInstance</code></a> method internally.</p></td>
2473 </tr>
2474
2475
2476 </tbody>
2477</table>
2478
2479
2480
2481
2482<dl class="details">
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2513 <dd class="tag-source">
2514 <ul class="dummy">
2515 <li>
2516 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
2517 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-901">line 901</a>
2518 </li>
2519 </ul>
2520 </dd>
2521
2522
2523
2524
2525
2526
2527
2528</dl>
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542 <h5>Returns:</h5>
2543
2544
2545<div class="param-desc">
2546 <p>Returns true if the sound instance has been modified or false otherwise.</p>
2547</div>
2548
2549
2550
2551<dl>
2552 <dt>
2553 Type
2554 </dt>
2555 <dd>
2556
2557<span class="param-type">boolean</span>
2558
2559
2560
2561 </dd>
2562</dl>
2563
2564
2565
2566
2567
2568</dd>
2569
2570
2571
2572<hr>
2573<dt>
2574 <h4 class="name" id="cancelSoundInstances"><span class="type-signature"></span>cancelSoundInstances<span class="signature">( [cancel] [, affectWithObjectAssociated])</span><span class="type-signature"> &rarr; {integer}</span></h4>
2575
2576
2577</dt>
2578<dd>
2579
2580
2581 <div class="description">
2582 <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_AudioFileSprites.html#cancelSoundInstances"><code>CB_AudioFileSprites#cancelSoundInstances</code></a> method internally.</p>
2583 </div>
2584
2585
2586
2587
2588
2589
2590
2591
2592 <h5>Parameters:</h5>
2593
2594
2595<table class="params table table-striped">
2596 <thead>
2597 <tr>
2598
2599 <th style="width:12%; min-width:110px;">Name</th>
2600
2601
2602 <th style="width:12%; min-width:110px;">Type</th>
2603
2604
2605 <th style="width:12%; min-width:110px;">Argument</th>
2606
2607
2608
2609 <th style="width:12%; min-width:110px;">Default</th>
2610
2611
2612 <th class="last" style="min-width:310px;">Description</th>
2613 </tr>
2614 </thead>
2615
2616 <tbody>
2617
2618
2619 <tr>
2620
2621 <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>
2622
2623
2624 <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;">
2625
2626
2627<span class="param-type">boolean</span>
2628
2629
2630
2631
2632 </td>
2633
2634
2635 <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;">
2636
2637 &lt;optional><br>
2638
2639
2640
2641
2642
2643 </td>
2644
2645
2646
2647 <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;">
2648
2649 false
2650
2651 </td>
2652
2653
2654 <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 &quot;cancel&quot; parameter when calling the <a href="CB_AudioFileSprites.html#cancelSoundInstances"><code>CB_AudioFileSprites#cancelSoundInstances</code></a> method internally.</p></td>
2655 </tr>
2656
2657
2658
2659 <tr>
2660
2661 <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>
2662
2663
2664 <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;">
2665
2666
2667<span class="param-type">boolean</span>
2668
2669
2670
2671
2672 </td>
2673
2674
2675 <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;">
2676
2677 &lt;optional><br>
2678
2679
2680
2681
2682
2683 </td>
2684
2685
2686
2687 <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;">
2688
2689 false
2690
2691 </td>
2692
2693
2694 <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 &quot;affectWithObjectAssociated&quot; parameter when calling the <a href="CB_AudioFileSprites.html#cancelSoundInstances"><code>CB_AudioFileSprites#cancelSoundInstances</code></a> method internally.</p></td>
2695 </tr>
2696
2697
2698 </tbody>
2699</table>
2700
2701
2702
2703
2704<dl class="details">
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2735 <dd class="tag-source">
2736 <ul class="dummy">
2737 <li>
2738 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
2739 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-882">line 882</a>
2740 </li>
2741 </ul>
2742 </dd>
2743
2744
2745
2746
2747
2748
2749
2750</dl>
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764 <h5>Returns:</h5>
2765
2766
2767<div class="param-desc">
2768 <p>Returns the number of sound instances modified.</p>
2769</div>
2770
2771
2772
2773<dl>
2774 <dt>
2775 Type
2776 </dt>
2777 <dd>
2778
2779<span class="param-type">integer</span>
2780
2781
2782
2783 </dd>
2784</dl>
2785
2786
2787
2788
2789
2790</dd>
2791
2792
2793
2794<hr>
2795<dt>
2796 <h4 class="name" id="checkPlayingAll"><span class="type-signature"></span>checkPlayingAll<span class="signature">( [callbackOk] [, callbackError] [, ignoreQueue] [, ignoreStatus])</span><span class="type-signature"> &rarr; {integer}</span></h4>
2797
2798
2799</dt>
2800<dd>
2801
2802
2803 <div class="description">
2804 <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 &quot;unchecked&quot; 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 each call to the <a href="CB_AudioFileSprites.html#checkPlayingAll"><code>CB_AudioFileSprites#checkPlayingAll</code></a> method. Uses the <a href="CB_AudioFileSprites.html#checkPlayingAll"><code>CB_AudioFileSprites#checkPlayingAll</code></a> method internally. Recommended to be called through a user-driven event (as onClick, onTouch, etc.).</p>
2805 </div>
2806
2807
2808
2809
2810
2811
2812
2813
2814 <h5>Parameters:</h5>
2815
2816
2817<table class="params table table-striped">
2818 <thead>
2819 <tr>
2820
2821 <th style="width:12%; min-width:110px;">Name</th>
2822
2823
2824 <th style="width:12%; min-width:110px;">Type</th>
2825
2826
2827 <th style="width:12%; min-width:110px;">Argument</th>
2828
2829
2830
2831 <th style="width:12%; min-width:110px;">Default</th>
2832
2833
2834 <th class="last" style="min-width:310px;">Description</th>
2835 </tr>
2836 </thead>
2837
2838 <tbody>
2839
2840
2841 <tr>
2842
2843 <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>
2844
2845
2846 <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;">
2847
2848
2849<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.checkPlayingAll_CALLBACK_OK">CB_AudioFileSpritesPool.checkPlayingAll_CALLBACK_OK</a></span>
2850
2851
2852
2853
2854 </td>
2855
2856
2857 <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;">
2858
2859 &lt;optional><br>
2860
2861
2862
2863
2864
2865 </td>
2866
2867
2868
2869 <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;">
2870
2871 </td>
2872
2873
2874 <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>A function which will be called if all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose <a href="CB_AudioFile.html#getStatus"><code>CB_AudioFile#getStatus</code></a> method returned the &quot;unchecked&quot; value (which belongs to the value of the <code>CB_AudioFile#UNCHECKED</code> property) could finally be checked successfully and all can be played, being &quot;this&quot; the <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object itself.</p></td>
2875 </tr>
2876
2877
2878
2879 <tr>
2880
2881 <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>
2882
2883
2884 <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;">
2885
2886
2887<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.checkPlayingAll_CALLBACK_ERROR">CB_AudioFileSpritesPool.checkPlayingAll_CALLBACK_ERROR</a></span>
2888
2889
2890
2891
2892 </td>
2893
2894
2895 <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;">
2896
2897 &lt;optional><br>
2898
2899
2900
2901
2902
2903 </td>
2904
2905
2906
2907 <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;">
2908
2909 </td>
2910
2911
2912 <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>A function which will be called if not all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose <a href="CB_AudioFile.html#getStatus"><code>CB_AudioFile#getStatus</code></a> method returned the &quot;unchecked&quot; value (which belongs to the value of the <code>CB_AudioFile#UNCHECKED</code> property) could finally be checked successfully and any cannot be played, being &quot;this&quot; the <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object itself. This function will be called immediately if the method was previously called and it is still running currently.</p></td>
2913 </tr>
2914
2915
2916
2917 <tr>
2918
2919 <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>
2920
2921
2922 <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;">
2923
2924
2925<span class="param-type">boolean</span>
2926
2927
2928
2929
2930 </td>
2931
2932
2933 <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;">
2934
2935 &lt;optional><br>
2936
2937
2938
2939
2940
2941 </td>
2942
2943
2944
2945 <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;">
2946
2947 false
2948
2949 </td>
2950
2951
2952 <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 &quot;ignoreQueue&quot; parameter when calling the <a href="CB_AudioFileSprites.html#checkPlayingAll"><code>CB_AudioFileSprites#checkPlayingAll</code></a> method internally.</p></td>
2953 </tr>
2954
2955
2956
2957 <tr>
2958
2959 <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>ignoreStatus</code></td>
2960
2961
2962 <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;">
2963
2964
2965<span class="param-type">boolean</span>
2966
2967
2968
2969
2970 </td>
2971
2972
2973 <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;">
2974
2975 &lt;optional><br>
2976
2977
2978
2979
2980
2981 </td>
2982
2983
2984
2985 <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;">
2986
2987 false
2988
2989 </td>
2990
2991
2992 <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>If it is set to false and the sprites pool object is loaded (the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method returns the value set in the <a href="CB_AudioFileSpritesPool.html#.LOADED"><code>CB_AudioFileSpritesPool.LOADED</code></a> property), it will exit returning an error. Otherwise, if it is set to true, it will ignore the current sprites pool object status.</p></td>
2993 </tr>
2994
2995
2996 </tbody>
2997</table>
2998
2999
3000
3001
3002<dl class="details">
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3033 <dd class="tag-source">
3034 <ul class="dummy">
3035 <li>
3036 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
3037 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1039">line 1039</a>
3038 </li>
3039 </ul>
3040 </dd>
3041
3042
3043
3044
3045
3046
3047
3048</dl>
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062 <h5>Returns:</h5>
3063
3064
3065<div class="param-desc">
3066 <p>Returns the number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose status belonged to the &quot;unchecked&quot; 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 audio sprites pool is neither loaded (the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method does not returns the value set in the <a href="CB_AudioFileSpritesPool.html#.LOADED"><code>CB_AudioFileSpritesPool.LOADED</code></a> property) nor unchecked (the <code>CB_AudioFileSpritesPool#status</code> method does not return the value set in the <a href="CB_AudioFileSpritesPool.html#.UNCHECKED"><code>CB_AudioFileSpritesPool.UNCHECKED</code></a> property).</p>
3067</div>
3068
3069
3070
3071<dl>
3072 <dt>
3073 Type
3074 </dt>
3075 <dd>
3076
3077<span class="param-type">integer</span>
3078
3079
3080
3081 </dd>
3082</dl>
3083
3084
3085
3086
3087
3088</dd>
3089
3090
3091
3092<hr>
3093<dt>
3094 <h4 class="name" id="clearAudioFiles"><span class="type-signature"></span>clearAudioFiles<span class="signature">( [avoidCallingCheckCacheLoaded])</span><span class="type-signature"> &rarr; {array}</span></h4>
3095
3096
3097</dt>
3098<dd>
3099
3100
3101 <div class="description">
3102 <p>Cleans the arrays 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 used by each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object, just keeping the valid ones and clearing (destroying and removing) the others. For performance purposes. Uses the <a href="CB_AudioFileSprites.html#clearAudioFiles"><code>CB_AudioFileSprites#clearAudioFiles</code></a> method internally. Internal usage only recommended.</p>
3103 </div>
3104
3105
3106
3107
3108
3109
3110
3111
3112 <h5>Parameters:</h5>
3113
3114
3115<table class="params table table-striped">
3116 <thead>
3117 <tr>
3118
3119 <th style="width:12%; min-width:110px;">Name</th>
3120
3121
3122 <th style="width:12%; min-width:110px;">Type</th>
3123
3124
3125 <th style="width:12%; min-width:110px;">Argument</th>
3126
3127
3128
3129 <th style="width:12%; min-width:110px;">Default</th>
3130
3131
3132 <th class="last" style="min-width:310px;">Description</th>
3133 </tr>
3134 </thead>
3135
3136 <tbody>
3137
3138
3139 <tr>
3140
3141 <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>
3142
3143
3144 <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;">
3145
3146
3147<span class="param-type">boolean</span>
3148
3149
3150
3151
3152 </td>
3153
3154
3155 <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;">
3156
3157 &lt;optional><br>
3158
3159
3160
3161
3162
3163 </td>
3164
3165
3166
3167 <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;">
3168
3169 false
3170
3171 </td>
3172
3173
3174 <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 &quot;avoidCallingCheckCacheLoaded&quot; parameter when calling the <a href="CB_AudioFileSprites.html#clearAudioFiles"><code>CB_AudioFileSprites#clearAudioFiles</code></a> method internally.</p></td>
3175 </tr>
3176
3177
3178 </tbody>
3179</table>
3180
3181
3182
3183
3184<dl class="details">
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3215 <dd class="tag-source">
3216 <ul class="dummy">
3217 <li>
3218 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
3219 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-810">line 810</a>
3220 </li>
3221 </ul>
3222 </dd>
3223
3224
3225
3226
3227
3228
3229
3230</dl>
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244 <h5>Returns:</h5>
3245
3246
3247<div class="param-desc">
3248 <p>Returns an object whose each property name is the sprites group ID and each value is the returning value of calling internally the <a href="CB_AudioFileSprites.html#clearAudioFiles"><code>CB_AudioFileSprites#clearAudioFiles</code></a> method.</p>
3249</div>
3250
3251
3252
3253<dl>
3254 <dt>
3255 Type
3256 </dt>
3257 <dd>
3258
3259<span class="param-type">array</span>
3260
3261
3262
3263 </dd>
3264</dl>
3265
3266
3267
3268
3269
3270</dd>
3271
3272
3273
3274<hr>
3275<dt>
3276 <h4 class="name" id="clearSoundInstances"><span class="type-signature"></span>clearSoundInstances<span class="signature">( [clearWithObjectAssociated])</span><span class="type-signature"> &rarr; {integer}</span></h4>
3277
3278
3279</dt>
3280<dd>
3281
3282
3283 <div class="description">
3284 <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_AudioFileSprites.html#clearSoundInstances"><code>CB_AudioFileSprites#clearSoundInstances</code></a> method internally.</p>
3285 </div>
3286
3287
3288
3289
3290
3291
3292
3293
3294 <h5>Parameters:</h5>
3295
3296
3297<table class="params table table-striped">
3298 <thead>
3299 <tr>
3300
3301 <th style="width:12%; min-width:110px;">Name</th>
3302
3303
3304 <th style="width:12%; min-width:110px;">Type</th>
3305
3306
3307 <th style="width:12%; min-width:110px;">Argument</th>
3308
3309
3310
3311 <th style="width:12%; min-width:110px;">Default</th>
3312
3313
3314 <th class="last" style="min-width:310px;">Description</th>
3315 </tr>
3316 </thead>
3317
3318 <tbody>
3319
3320
3321 <tr>
3322
3323 <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>
3324
3325
3326 <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;">
3327
3328
3329<span class="param-type">boolean</span>
3330
3331
3332
3333
3334 </td>
3335
3336
3337 <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;">
3338
3339 &lt;optional><br>
3340
3341
3342
3343
3344
3345 </td>
3346
3347
3348
3349 <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;">
3350
3351 false
3352
3353 </td>
3354
3355
3356 <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 &quot;clearWithObjectAssociated&quot; parameter when calling the <a href="CB_AudioFileSprites.html#clearSoundInstances"><code>CB_AudioFileSprites#clearSoundInstances</code></a> method internally.</p></td>
3357 </tr>
3358
3359
3360 </tbody>
3361</table>
3362
3363
3364
3365
3366<dl class="details">
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3397 <dd class="tag-source">
3398 <ul class="dummy">
3399 <li>
3400 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
3401 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-864">line 864</a>
3402 </li>
3403 </ul>
3404 </dd>
3405
3406
3407
3408
3409
3410
3411
3412</dl>
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426 <h5>Returns:</h5>
3427
3428
3429<div class="param-desc">
3430 <p>Returns the number of cleared sound instances.</p>
3431</div>
3432
3433
3434
3435<dl>
3436 <dt>
3437 Type
3438 </dt>
3439 <dd>
3440
3441<span class="param-type">integer</span>
3442
3443
3444
3445 </dd>
3446</dl>
3447
3448
3449
3450
3451
3452</dd>
3453
3454
3455
3456<hr>
3457<dt>
3458 <h4 class="name" id="destroyAll"><span class="type-signature"></span>destroyAll<span class="signature">( [stopSounds])</span><span class="type-signature"> &rarr; {integer}</span></h4>
3459
3460
3461</dt>
3462<dd>
3463
3464
3465 <div class="description">
3466 <p>Destroys all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects and frees memory, by calling <a href="CB_AudioFile.html#destructor"><code>CB_AudioFile#destructor</code></a>(stopSounds, false, true). Uses the <a href="CB_AudioFileSprites.html#destroyAll"><code>CB_AudioFileSprites#destroyAll</code></a> method internally.</p>
3467 </div>
3468
3469
3470
3471
3472
3473
3474
3475
3476 <h5>Parameters:</h5>
3477
3478
3479<table class="params table table-striped">
3480 <thead>
3481 <tr>
3482
3483 <th style="width:12%; min-width:110px;">Name</th>
3484
3485
3486 <th style="width:12%; min-width:110px;">Type</th>
3487
3488
3489 <th style="width:12%; min-width:110px;">Argument</th>
3490
3491
3492
3493 <th style="width:12%; min-width:110px;">Default</th>
3494
3495
3496 <th class="last" style="min-width:310px;">Description</th>
3497 </tr>
3498 </thead>
3499
3500 <tbody>
3501
3502
3503 <tr>
3504
3505 <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>stopSounds</code></td>
3506
3507
3508 <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;">
3509
3510
3511<span class="param-type">boolean</span>
3512
3513
3514
3515
3516 </td>
3517
3518
3519 <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;">
3520
3521 &lt;optional><br>
3522
3523
3524
3525
3526
3527 </td>
3528
3529
3530
3531 <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;">
3532
3533 false
3534
3535 </td>
3536
3537
3538 <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 &quot;stopSounds&quot; parameter when calling the <a href="CB_AudioFileSprites.html#destroyAll"><code>CB_AudioFileSprites#destroyAll</code></a> method internally.</p></td>
3539 </tr>
3540
3541
3542 </tbody>
3543</table>
3544
3545
3546
3547
3548<dl class="details">
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3579 <dd class="tag-source">
3580 <ul class="dummy">
3581 <li>
3582 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
3583 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-993">line 993</a>
3584 </li>
3585 </ul>
3586 </dd>
3587
3588
3589
3590
3591
3592
3593
3594</dl>
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608 <h5>Returns:</h5>
3609
3610
3611<div class="param-desc">
3612 <p>Returns the number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose <a href="CB_AudioFile.html#destructor"><code>CB_AudioFile#destructor</code></a> has been called.</p>
3613</div>
3614
3615
3616
3617<dl>
3618 <dt>
3619 Type
3620 </dt>
3621 <dd>
3622
3623<span class="param-type">integer</span>
3624
3625
3626
3627 </dd>
3628</dl>
3629
3630
3631
3632
3633
3634</dd>
3635
3636
3637
3638<hr>
3639<dt>
3640 <h4 class="name" id="destructor"><span class="type-signature"></span>destructor<span class="signature">( [stopSounds] [, preventAbortedStatus])</span><span class="type-signature"></span></h4>
3641
3642
3643</dt>
3644<dd>
3645
3646
3647 <div class="description">
3648 <p>Destroys the audio file sprites pool object (removing all sprites, etc.), including the internal audio file sprites objects, and frees memory. By default, unless the &quot;preventAbortedStatus&quot; is set to true, sets the current status of all the <a href="CB_AudioFileCache.html"><code>CB_AudioFileCache</code></a> objects as ABORTED (<a href="CB_AudioFileCache.html#.ABORTED"><code>CB_AudioFileCache.ABORTED</code></a> value). Internally, calls the <a href="CB_AudioFileSprites.html#destructor"><code>CB_AudioFileSprites#destructor</code></a> method of all the internally-created <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> objects.</p>
3649 </div>
3650
3651
3652
3653
3654
3655
3656
3657
3658 <h5>Parameters:</h5>
3659
3660
3661<table class="params table table-striped">
3662 <thead>
3663 <tr>
3664
3665 <th style="width:12%; min-width:110px;">Name</th>
3666
3667
3668 <th style="width:12%; min-width:110px;">Type</th>
3669
3670
3671 <th style="width:12%; min-width:110px;">Argument</th>
3672
3673
3674
3675 <th style="width:12%; min-width:110px;">Default</th>
3676
3677
3678 <th class="last" style="min-width:310px;">Description</th>
3679 </tr>
3680 </thead>
3681
3682 <tbody>
3683
3684
3685 <tr>
3686
3687 <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>stopSounds</code></td>
3688
3689
3690 <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;">
3691
3692
3693<span class="param-type">boolean</span>
3694
3695
3696
3697
3698 </td>
3699
3700
3701 <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;">
3702
3703 &lt;optional><br>
3704
3705
3706
3707
3708
3709 </td>
3710
3711
3712
3713 <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;">
3714
3715 false
3716
3717 </td>
3718
3719
3720 <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 &quot;stopSounds&quot; parameter when calling internally the <a href="CB_AudioFileSprites.html#destructor"><code>CB_AudioFileSprites#destructor</code></a> method of all the internally-created <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> objects.</p></td>
3721 </tr>
3722
3723
3724
3725 <tr>
3726
3727 <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>preventAbortedStatus</code></td>
3728
3729
3730 <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;">
3731
3732
3733<span class="param-type">boolean</span>
3734
3735
3736
3737
3738 </td>
3739
3740
3741 <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;">
3742
3743 &lt;optional><br>
3744
3745
3746
3747
3748
3749 </td>
3750
3751
3752
3753 <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;">
3754
3755 false
3756
3757 </td>
3758
3759
3760 <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>If set to true (not recommended), it will not assign the status of &quot;ABORTED&quot; (it will not set the <code>CB_AudioFileSpritesPool#_aborted</code> property to true}. Used as the &quot;preventAbortedStatus&quot; parameter when calling internally the <a href="CB_AudioFileSprites.html#destructor"><code>CB_AudioFileSprites#destructor</code></a> method of all the internally-created <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> objects.</p></td>
3761 </tr>
3762
3763
3764 </tbody>
3765</table>
3766
3767
3768
3769
3770<dl class="details">
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3801 <dd class="tag-source">
3802 <ul class="dummy">
3803 <li>
3804 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
3805 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-326">line 326</a>
3806 </li>
3807 </ul>
3808 </dd>
3809
3810
3811
3812
3813
3814
3815
3816</dl>
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832</dd>
3833
3834
3835
3836<hr>
3837<dt>
3838 <h4 class="name" id="errorFunction"><span class="type-signature"></span>errorFunction<span class="signature">( [message] [, ignorePreviousExecution])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3839
3840
3841</dt>
3842<dd>
3843
3844
3845 <div class="description">
3846 <p>Calls the error function which should be set in the <code>CB_AudioFileSprites#onError</code> property (if any), being &quot;this&quot; the <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object itself. Internal usage only recommended.</p>
3847 </div>
3848
3849
3850
3851
3852
3853
3854
3855
3856 <h5>Parameters:</h5>
3857
3858
3859<table class="params table table-striped">
3860 <thead>
3861 <tr>
3862
3863 <th style="width:12%; min-width:110px;">Name</th>
3864
3865
3866 <th style="width:12%; min-width:110px;">Type</th>
3867
3868
3869 <th style="width:12%; min-width:110px;">Argument</th>
3870
3871
3872
3873 <th style="width:12%; min-width:110px;">Default</th>
3874
3875
3876 <th class="last" style="min-width:310px;">Description</th>
3877 </tr>
3878 </thead>
3879
3880 <tbody>
3881
3882
3883 <tr>
3884
3885 <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>message</code></td>
3886
3887
3888 <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;">
3889
3890
3891<span class="param-type">string</span>
3892
3893
3894
3895
3896 </td>
3897
3898
3899 <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;">
3900
3901 &lt;optional><br>
3902
3903
3904
3905
3906
3907 </td>
3908
3909
3910
3911 <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;">
3912
3913 </td>
3914
3915
3916 <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>The message describing the error that will be sent to the set <code>CB_AudioFileSprites#onError</code> function (if any) as the first and unique parameter.</p></td>
3917 </tr>
3918
3919
3920
3921 <tr>
3922
3923 <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>ignorePreviousExecution</code></td>
3924
3925
3926 <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;">
3927
3928
3929<span class="param-type">boolean</span>
3930
3931
3932
3933
3934 </td>
3935
3936
3937 <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;">
3938
3939 &lt;optional><br>
3940
3941
3942
3943
3944
3945 </td>
3946
3947
3948
3949 <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;">
3950
3951 false
3952
3953 </td>
3954
3955
3956 <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>If it is set to false, the function set in the <code>CB_AudioFileSprites#onError</code> property (if any) will only be called if it was not executed previously.</p></td>
3957 </tr>
3958
3959
3960 </tbody>
3961</table>
3962
3963
3964
3965
3966<dl class="details">
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3997 <dd class="tag-source">
3998 <ul class="dummy">
3999 <li>
4000 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
4001 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1698">line 1698</a>
4002 </li>
4003 </ul>
4004 </dd>
4005
4006
4007
4008
4009
4010
4011
4012</dl>
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026 <h5>Returns:</h5>
4027
4028
4029<div class="param-desc">
4030 <p>Returns true if the <code>CB_AudioFileSprites#onError</code> function could be called or false otherwise.</p>
4031</div>
4032
4033
4034
4035<dl>
4036 <dt>
4037 Type
4038 </dt>
4039 <dd>
4040
4041<span class="param-type">boolean</span>
4042
4043
4044
4045 </dd>
4046</dl>
4047
4048
4049
4050
4051
4052</dd>
4053
4054
4055
4056<hr>
4057<dt>
4058 <h4 class="name" id="executeAll"><span class="type-signature"></span>executeAll<span class="signature">()</span><span class="type-signature"></span></h4>
4059
4060
4061</dt>
4062<dd>
4063
4064
4065 <div class="description">
4066 <p>Alias for <a href="CB_AudioFileSpritesPool.html#executeFunctionAll"><code>CB_AudioFileSpritesPool#executeFunctionAll</code></a>.</p>
4067 </div>
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078<dl class="details">
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4109 <dd class="tag-source">
4110 <ul class="dummy">
4111 <li>
4112 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
4113 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-930">line 930</a>
4114 </li>
4115 </ul>
4116 </dd>
4117
4118
4119
4120
4121
4122 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
4123 <dd class="tag-see">
4124 <ul>
4125 <li><a href="CB_AudioFileSpritesPool.html#executeFunctionAll"><code>CB_AudioFileSpritesPool#executeFunctionAll</code></a></li>
4126 </ul>
4127 </dd>
4128
4129
4130
4131</dl>
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147</dd>
4148
4149
4150
4151<hr>
4152<dt>
4153 <h4 class="name" id="executeAllSprites"><span class="type-signature"></span>executeAllSprites<span class="signature">()</span><span class="type-signature"></span></h4>
4154
4155
4156</dt>
4157<dd>
4158
4159
4160 <div class="description">
4161 <p>Alias for <a href="CB_AudioFileSpritesPool.html#executeFunctionAllSprites"><code>CB_AudioFileSpritesPool#executeFunctionAllSprites</code></a>.</p>
4162 </div>
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173<dl class="details">
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4204 <dd class="tag-source">
4205 <ul class="dummy">
4206 <li>
4207 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
4208 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-759">line 759</a>
4209 </li>
4210 </ul>
4211 </dd>
4212
4213
4214
4215
4216
4217 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
4218 <dd class="tag-see">
4219 <ul>
4220 <li><a href="CB_AudioFileSpritesPool.html#executeFunctionAllSprites"><code>CB_AudioFileSpritesPool#executeFunctionAllSprites</code></a></li>
4221 </ul>
4222 </dd>
4223
4224
4225
4226</dl>
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242</dd>
4243
4244
4245
4246<hr>
4247<dt>
4248 <h4 class="name" id="executeAllSubSprites"><span class="type-signature"></span>executeAllSubSprites<span class="signature">()</span><span class="type-signature"></span></h4>
4249
4250
4251</dt>
4252<dd>
4253
4254
4255 <div class="description">
4256 <p>Alias for <code>CB_AudioFileSpritesPool#executeFunctionAllSubSprites</code>.</p>
4257 </div>
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268<dl class="details">
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4299 <dd class="tag-source">
4300 <ul class="dummy">
4301 <li>
4302 <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
4303 <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1253">line 1253</a>
4304 </li>
4305 </ul>
4306 </dd>
4307
4308
4309
4310
4311
4312 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
4313 <dd class="tag-see">
4314 <ul>
4315 <li><code>CB_AudioFileSpritesPool#executeFunctionAllSubSprites</code></li>
4316 </ul>
4317 </dd>
4318
4319
4320
4321</dl>
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337</dd>
4338
4339
4340
4341<hr>
4342<dt>
4343 <h4 class="name" id="executeFunctionAll"><span class="type-signature"></span>executeFunctionAll<span class="signature">(functionEach [, delayBetweenEach] [, audioFiles] [, returnArrayOfSetTimeoutsArray] [, delayBetweenEachAffectsFirst] [, functionFinish])</span><span class="type-signature"> &rarr; {integer|array}</span></h4>
4344
4345
4346</dt>
4347<dd>
4348
4349
4350 <div class="description">
4351 <p>Performs a desired action, using the provided function, on all the existing <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects or on the desired ones (if provided). Uses the <a href="CB_AudioFileSprites.html#executeFunctionAll"><code>CB_AudioFileSprites#executeFunctionAll</code></a> method internally.</p>
4352 </div>
4353
4354
4355
4356
4357
4358
4359
4360
4361 <h5>Parameters:</h5>
4362
4363
4364<table class="params table table-striped">
4365 <thead>
4366 <tr>
4367
4368 <th style="width:12%; min-width:110px;">Name</th>
4369
4370
4371 <th style="width:12%; min-width:110px;">Type</th>
4372
4373
4374 <th style="width:12%; min-width:110px;">Argument</th>
4375
4376
4377
4378 <th style="width:12%; min-width:110px;">Default</th>
4379
4380
4381 <th class="last" style="min-width:310px;">Description</th>
4382 </tr>
4383 </thead>
4384
4385 <tbody>
4386
4387
4388 <tr>
4389
4390 <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>functionEach</code></td>
4391
4392
4393 <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;">
4394
4395
4396<span class="param-type">CB_Arrays.CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</span>
4397
4398
4399
4400
4401 </td>
4402
4403
4404 <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;">
4405
4406
4407
4408
4409
4410 </td>
4411
4412
4413
4414 <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;">
4415
4416 </td>
4417
4418
4419 <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 &quot;functionEach&quot; parameter when calling the <a href="CB_AudioFileSprites.html#executeFunctionAll"><code>CB_AudioFileSprites#executeFunctionAll</code></a> method internally.</p></td>
4420 </tr>
4421
4422
4423
4424 <tr>
4425
4426 <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>delayBetweenEach</code></td>
4427
4428
4429 <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;">
4430
4431
4432<span class="param-type">number</span>
4433|
4434
4435<span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_LOOP_CALLBACK">CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</a></span>
4436
4437
4438
4439
4440 </td>
4441
4442
4443 <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;">
4444
4445 &lt;optional><br>
4446
4447
4448
4449
4450
4451 </td>
4452
4453
4454
4455 <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;">
4456
4457 0
4458
4459 </td>
4460
4461
4462 <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 &quot;delayBetweenEach&quot; parameter when calling the <a href="CB_AudioFileSprites.html#executeFunctionAll"><code>CB_AudioFileSprites#executeFunctionAll</code></a> method internally. Note that each call to the <a href="CB_AudioFileSprites.html#executeFunctionAll"><code>CB_AudioFileSprites#executeFunctionAll</code></a> method will be performed sequentially one after the other, without adding a delay.</p></td>
4463 </tr>
4464
4465
4466
4467 <tr>
4468
4469 <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>audioFiles</code></td>
4470
4471
4472 <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;">
4473
4474
4475<span class="param-type">array</span>
4476
4477
4478
4479
4480 </td>
4481
4482
4483 <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;">
4484
4485 &lt;optional><br>
4486
4487
4488
4489
4490
4491 </td>
4492
4493
4494
4495 <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;">
4496
4497 <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a>
4498
4499 </td>
4500
4501
4502 <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 &quot;audioFiles&quot; parameter when calling the <a href="CB_AudioFileSprites.html#executeFunctionAll"><code>CB_AudioFileSprites#executeFunctionAll</code></a> method internally.</p></td>
4503 </tr>
4504
4505
4506
4507 <tr>
4508
4509 <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>returnArrayOfSetTimeoutsArray</code></td>
4510
4511
4512 <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;">
4513
4514
4515<span class="param-type">boolean</span>
4516
4517
4518
4519
4520 </td>
4521
4522
4523 <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;">
4524
4525 &lt;optional><br>
4526
4527
4528
4529
4530
4531 </td>
4532
4533
4534
4535 <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;">
4536
4537 false
4538
4539 </td>
4540
4541
4542 <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>If it is set to false, it will return the number of calls to the &quot;functionEach&quot; function that were performed. Otherwise, if it is set to true, it will return a numeric array and each value (which will belong to each sprites group) will be another numeric array with a <a href="CB_AudioFileCache.html#.executeFunctionAll_OBJECT"><code>CB_AudioFileCache.executeFunctionAll_OBJECT</code></a> object for each <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> of that sprites group.</p></td>
4543 </tr>
4544
4545
4546
4547 <tr>
4548
4549 <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>delayBetweenEachAffectsFirst</code></td>
4550
4551
4552 <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;">
4553
4554
4555<span class="param-type">boolean</span>
4556
4557
4558
4559
4560 </td>
4561
4562
4563 <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;">
4564
4565 &lt;optional><br>
4566
4567
4568
4569
4570
4571 </td>
4572
4573
4574
4575 <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;">
4576
4577 false
4578
4579 </td>
4580
4581
4582 <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 &quot;delayBetweenEachAffectsFirst&quot; parameter when calling the <a href="CB_AudioFileSprites.html#executeFunctionAll"><code>CB_AudioFileSprites#executeFunctionAll</code></a> method internally. Note that each call to the <a href="CB_AudioFileSprites.html#executeFunctionAll"><code>CB_AudioFileSprites#executeFunctionAll</code></a> method will be performed sequentially one after the other, without adding a delay.</p></td>
4583 </tr>
4584
4585
4586
4587 <tr>
4588
4589 <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>functionFinish</code></td>
4590
4591
4592 <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;">
4593
4594
4595<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.executeFunctionAll_ON_FINISH_CALLBACK">CB_AudioFileSpritesPool.executeFunctionAll_ON_FINISH_CALLBACK</a></span>
4596
4597
4598
4599
4600 </td>
4601
4602
4603 <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;">
4604
4605 &lt;optional><br>
4606
4607
4608
4609
4610
4611 </td>
4612
4613
4614
4615 <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;">
4616
4617 </td>
4618
4619
4620 <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>Function that will be called for when it has finished looping all the items. The first parameter will be the array containing all the items which were looped, the second parameter will be the number of times that the &quot;functionEach&quot; callback was called (the most likely, matches the number of elements unless they are undefined or null), and the third parameter will be the maximum &quot;delay&quot; used, being &quot;this&quot; the array itself.</p></td>
4621 </tr>
4622
4623
4624 </tbody>
4625</table>
4626
4627
4628
4629
4630<dl class="details">
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4661 <dd class="tag-source">
4662 <ul class="dummy">
4663 <li>
4664 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
4665 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-952">line 952</a>
4666 </li>
4667 </ul>
4668 </dd>
4669
4670
4671
4672
4673
4674
4675
4676 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
4677 <dd class="tag-todo">
4678 <ul>
4679 <li>Think about consider executing only one by one (now it will loop <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects from different sprites groups simultaneously).</li>
4680 </ul>
4681 </dd>
4682
4683</dl>
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697 <h5>Returns:</h5>
4698
4699
4700<div class="param-desc">
4701 <p>If the &quot;returnArrayOfSetTimeoutsArray&quot; parameter is set to false, it will return the number of calls to the &quot;functionEach&quot; function that were performed. Otherwise, if the &quot;returnArrayOfSetTimeoutsArray&quot; is set to true, it will return a numeric array and each value will be another numeric array with a <a href="CB_AudioFileCache.html#.executeFunctionAll_OBJECT"><code>CB_AudioFileCache.executeFunctionAll_OBJECT</code></a> object for each <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> given. Note that if a value greater than 0 (zero) for the &quot;delayBetweenEach&quot; parameter has been provided, perhaps not all calls of the &quot;functionEach&quot; function will have been performed yet when exiting this method because of the asynchronous nature of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> function.</p>
4702</div>
4703
4704
4705
4706<dl>
4707 <dt>
4708 Type
4709 </dt>
4710 <dd>
4711
4712<span class="param-type">integer</span>
4713|
4714
4715<span class="param-type">array</span>
4716
4717
4718
4719 </dd>
4720</dl>
4721
4722
4723
4724
4725
4726</dd>
4727
4728
4729
4730<hr>
4731<dt>
4732 <h4 class="name" id="executeFunctionAllSprites"><span class="type-signature"></span>executeFunctionAllSprites<span class="signature">(functionEach [, delayBetweenEach] [, includeWithoutSpriteAssociated] [, avoidCancelled] [, delayBetweenEachAffectsFirst] [, functionFinish])</span><span class="type-signature"> &rarr; {integer}</span></h4>
4733
4734
4735</dt>
4736<dd>
4737
4738
4739 <div class="description">
4740 <p>Executes a desired function for all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects used by all the sound instances currently created of each sprite group. It calls the <a href="CB_AudioFileSprites.html#executeFunctionAllSprites"><code>CB_AudioFileSprites#executeFunctionAllSprites</code></a> method internally.</p>
4741 </div>
4742
4743
4744
4745
4746
4747
4748
4749
4750 <h5>Parameters:</h5>
4751
4752
4753<table class="params table table-striped">
4754 <thead>
4755 <tr>
4756
4757 <th style="width:12%; min-width:110px;">Name</th>
4758
4759
4760 <th style="width:12%; min-width:110px;">Type</th>
4761
4762
4763 <th style="width:12%; min-width:110px;">Argument</th>
4764
4765
4766
4767 <th style="width:12%; min-width:110px;">Default</th>
4768
4769
4770 <th class="last" style="min-width:310px;">Description</th>
4771 </tr>
4772 </thead>
4773
4774 <tbody>
4775
4776
4777 <tr>
4778
4779 <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>functionEach</code></td>
4780
4781
4782 <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;">
4783
4784
4785<span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_LOOP_CALLBACK">CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</a></span>
4786
4787
4788
4789
4790 </td>
4791
4792
4793 <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;">
4794
4795
4796
4797
4798
4799 </td>
4800
4801
4802
4803 <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;">
4804
4805 </td>
4806
4807
4808 <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 &quot;functionEach&quot; parameter when calling the <a href="CB_AudioFileSprites.html#executeFunctionAllSprites"><code>CB_AudioFileSprites#executeFunctionAllSprites</code></a> method internally.</p></td>
4809 </tr>
4810
4811
4812
4813 <tr>
4814
4815 <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>delayBetweenEach</code></td>
4816
4817
4818 <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;">
4819
4820
4821<span class="param-type">number</span>
4822|
4823
4824<span class="param-type"><a href="CB_Arrays.html#.executeFunctionAll_ON_LOOP_CALLBACK">CB_Arrays.executeFunctionAll_ON_LOOP_CALLBACK</a></span>
4825
4826
4827
4828
4829 </td>
4830
4831
4832 <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;">
4833
4834 &lt;optional><br>
4835
4836
4837
4838
4839
4840 </td>
4841
4842
4843
4844 <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;">
4845
4846 0
4847
4848 </td>
4849
4850
4851 <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 &quot;delayBetweenEach&quot; parameter when calling the <a href="CB_AudioFileSprites.html#executeFunctionAllSprites"><code>CB_AudioFileSprites#executeFunctionAllSprites</code></a> method internally. Note that each call to the <a href="CB_AudioFileSprites.html#executeFunctionAllSprites"><code>CB_AudioFileSprites#executeFunctionAllSprites</code></a> method will be performed sequentially one after the other, without adding a delay.</p></td>
4852 </tr>
4853
4854
4855
4856 <tr>
4857
4858 <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>includeWithoutSpriteAssociated</code></td>
4859
4860
4861 <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;">
4862
4863
4864<span class="param-type">boolean</span>
4865
4866
4867
4868
4869 </td>
4870
4871
4872 <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;">
4873
4874 &lt;optional><br>
4875
4876
4877
4878
4879
4880 </td>
4881
4882
4883
4884 <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;">
4885
4886 false
4887
4888 </td>
4889
4890
4891 <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 &quot;includeWithoutSpriteAssociated&quot; parameter when calling the <a href="CB_AudioFileSprites.html#executeFunctionAllSprites"><code>CB_AudioFileSprites#executeFunctionAllSprites</code></a> method internally.</p></td>
4892 </tr>
4893
4894
4895
4896 <tr>
4897
4898 <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>avoidCancelled</code></td>
4899
4900
4901 <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;">
4902
4903
4904<span class="param-type">boolean</span>
4905
4906
4907
4908
4909 </td>
4910
4911
4912 <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;">
4913
4914 &lt;optional><br>
4915
4916
4917
4918
4919
4920 </td>
4921
4922
4923
4924 <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;">
4925
4926 false
4927
4928 </td>
4929
4930
4931 <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 &quot;avoidCancelled&quot; parameter when calling the <a href="CB_AudioFileSprites.html#executeFunctionAllSprites"><code>CB_AudioFileSprites#executeFunctionAllSprites</code></a> method internally.</p></td>
4932 </tr>
4933
4934
4935
4936 <tr>
4937
4938 <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>delayBetweenEachAffectsFirst</code></td>
4939
4940
4941 <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;">
4942
4943
4944<span class="param-type">boolean</span>
4945
4946
4947
4948
4949 </td>
4950
4951
4952 <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;">
4953
4954 &lt;optional><br>
4955
4956
4957
4958
4959
4960 </td>
4961
4962
4963
4964 <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;">
4965
4966 false
4967
4968 </td>
4969
4970
4971 <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 &quot;delayBetweenEachAffectsFirst&quot; parameter when calling the <a href="CB_AudioFileSprites.html#executeFunctionAllSprites"><code>CB_AudioFileSprites#executeFunctionAllSprites</code></a> method internally. Internal usage only recommended. Note that each call to the <a href="CB_AudioFileSprites.html#executeFunctionAllSprites"><code>CB_AudioFileSprites#executeFunctionAllSprites</code></a> method will be performed sequentially one after the other, without adding a delay.</p></td>
4972 </tr>
4973
4974
4975
4976 <tr>
4977
4978 <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>functionFinish</code></td>
4979
4980
4981 <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;">
4982
4983
4984<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.executeFunctionAll_ON_FINISH_CALLBACK">CB_AudioFileSpritesPool.executeFunctionAll_ON_FINISH_CALLBACK</a></span>
4985
4986
4987
4988
4989 </td>
4990
4991
4992 <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;">
4993
4994 &lt;optional><br>
4995
4996
4997
4998
4999
5000 </td>
5001
5002
5003
5004 <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;">
5005
5006 </td>
5007
5008
5009 <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>Function that will be called for when it has finished looping all the items. The first parameter will be the array containing all the items which were looped, the second parameter will be the number of times that the &quot;functionEach&quot; callback was called (the most likely, matches the number of elements unless they are undefined or null), and the third parameter will be the maximum &quot;delay&quot; used, being &quot;this&quot; the array itself.</p></td>
5010 </tr>
5011
5012
5013 </tbody>
5014</table>
5015
5016
5017
5018
5019<dl class="details">
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5050 <dd class="tag-source">
5051 <ul class="dummy">
5052 <li>
5053 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
5054 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-782">line 782</a>
5055 </li>
5056 </ul>
5057 </dd>
5058
5059
5060
5061
5062
5063
5064
5065 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
5066 <dd class="tag-todo">
5067 <ul>
5068 <li>Think about implementing a "returnSetTimeoutsArray" or similar (as in <a href="CB_AudioFileSprites.html#executeFunctionAllSprites"><code>CB_AudioFileSprites#executeFunctionAllSprites</code></a>).</li>
5069
5070 <li>Think about consider executing only one by one (now it will loop <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects from different sprites groups simultaneously).</li>
5071 </ul>
5072 </dd>
5073
5074</dl>
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088 <h5>Returns:</h5>
5089
5090
5091<div class="param-desc">
5092 <p>It will return the number of calls to the &quot;functionEach&quot; function that were performed (which should be the same number as the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects used by the sound instances that belong to the sprites of each sprites group). Note that if a value greater than 0 (zero) for the &quot;delayBetweenEach&quot; parameter has been provided, perhaps not all calls of the &quot;functionEach&quot; function will have been performed yet when exiting this method because of the asynchronous nature of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> function.</p>
5093</div>
5094
5095
5096
5097<dl>
5098 <dt>
5099 Type
5100 </dt>
5101 <dd>
5102
5103<span class="param-type">integer</span>
5104
5105
5106
5107 </dd>
5108</dl>
5109
5110
5111
5112
5113
5114</dd>
5115
5116
5117
5118<hr>
5119<dt>
5120 <h4 class="name" id="forEach"><span class="type-signature"></span>forEach<span class="signature">()</span><span class="type-signature"></span></h4>
5121
5122
5123</dt>
5124<dd>
5125
5126
5127 <div class="description">
5128 <p>Alias for <a href="CB_AudioFileSpritesPool.html#executeFunctionAll"><code>CB_AudioFileSpritesPool#executeFunctionAll</code></a>.</p>
5129 </div>
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140<dl class="details">
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5171 <dd class="tag-source">
5172 <ul class="dummy">
5173 <li>
5174 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
5175 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-935">line 935</a>
5176 </li>
5177 </ul>
5178 </dd>
5179
5180
5181
5182
5183
5184 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
5185 <dd class="tag-see">
5186 <ul>
5187 <li><a href="CB_AudioFileSpritesPool.html#executeFunctionAll"><code>CB_AudioFileSpritesPool#executeFunctionAll</code></a></li>
5188 </ul>
5189 </dd>
5190
5191
5192
5193</dl>
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209</dd>
5210
5211
5212
5213<hr>
5214<dt>
5215 <h4 class="name" id="forEachSprite"><span class="type-signature"></span>forEachSprite<span class="signature">()</span><span class="type-signature"></span></h4>
5216
5217
5218</dt>
5219<dd>
5220
5221
5222 <div class="description">
5223 <p>Alias for <a href="CB_AudioFileSpritesPool.html#executeFunctionAllSprites"><code>CB_AudioFileSpritesPool#executeFunctionAllSprites</code></a>.</p>
5224 </div>
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235<dl class="details">
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5266 <dd class="tag-source">
5267 <ul class="dummy">
5268 <li>
5269 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
5270 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-764">line 764</a>
5271 </li>
5272 </ul>
5273 </dd>
5274
5275
5276
5277
5278
5279 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
5280 <dd class="tag-see">
5281 <ul>
5282 <li><a href="CB_AudioFileSpritesPool.html#executeFunctionAllSprites"><code>CB_AudioFileSpritesPool#executeFunctionAllSprites</code></a></li>
5283 </ul>
5284 </dd>
5285
5286
5287
5288</dl>
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304</dd>
5305
5306
5307
5308<hr>
5309<dt>
5310 <h4 class="name" id="forEachSubSprite"><span class="type-signature"></span>forEachSubSprite<span class="signature">()</span><span class="type-signature"></span></h4>
5311
5312
5313</dt>
5314<dd>
5315
5316
5317 <div class="description">
5318 <p>Alias for <code>CB_AudioFileSpritesPool#executeFunctionAllSubSprites</code>.</p>
5319 </div>
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330<dl class="details">
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5361 <dd class="tag-source">
5362 <ul class="dummy">
5363 <li>
5364 <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html">CrossBase/audiovisual/image/CB_GraphicSprites.js</a>,
5365 <a href="CrossBase_audiovisual_image_CB_GraphicSprites.js.html#sunlight-1-line-1258">line 1258</a>
5366 </li>
5367 </ul>
5368 </dd>
5369
5370
5371
5372
5373
5374 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
5375 <dd class="tag-see">
5376 <ul>
5377 <li><code>CB_AudioFileSpritesPool#executeFunctionAllSubSprites</code></li>
5378 </ul>
5379 </dd>
5380
5381
5382
5383</dl>
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399</dd>
5400
5401
5402
5403<hr>
5404<dt>
5405 <h4 class="name" id="getAudioFileBySoundInstanceId"><span class="type-signature"></span>getAudioFileBySoundInstanceId<span class="signature">(soundInstanceId [, avoidCancelled])</span><span class="type-signature"> &rarr; {<a href="CB_AudioFile.html">CB_AudioFile</a>|null}</span></h4>
5406
5407
5408</dt>
5409<dd>
5410
5411
5412 <div class="description">
5413 <p>Gets the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object associated to a given sound instance ID (created by the <a href="CB_AudioFileCache.html#play"><code>CB_AudioFileCache#play</code></a> method), if any, or null otherwise. Uses the <a href="CB_AudioFileSprites.html#getAudioFileBySoundInstanceId"><code>CB_AudioFileSprites#getAudioFileBySoundInstanceId</code></a> method internally.</p>
5414 </div>
5415
5416
5417
5418
5419
5420
5421
5422
5423 <h5>Parameters:</h5>
5424
5425
5426<table class="params table table-striped">
5427 <thead>
5428 <tr>
5429
5430 <th style="width:12%; min-width:110px;">Name</th>
5431
5432
5433 <th style="width:12%; min-width:110px;">Type</th>
5434
5435
5436 <th style="width:12%; min-width:110px;">Argument</th>
5437
5438
5439
5440 <th style="width:12%; min-width:110px;">Default</th>
5441
5442
5443 <th class="last" style="min-width:310px;">Description</th>
5444 </tr>
5445 </thead>
5446
5447 <tbody>
5448
5449
5450 <tr>
5451
5452 <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>
5453
5454
5455 <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;">
5456
5457
5458<span class="param-type">integer</span>
5459
5460
5461
5462
5463 </td>
5464
5465
5466 <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;">
5467
5468
5469
5470
5471
5472 </td>
5473
5474
5475
5476 <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;">
5477
5478 </td>
5479
5480
5481 <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 &quot;soundInstanceId&quot; parameter when calling the <a href="CB_AudioFileSprites.html#getAudioFileBySoundInstanceId"><code>CB_AudioFileSprites#getAudioFileBySoundInstanceId</code></a> method internally.</p></td>
5482 </tr>
5483
5484
5485
5486 <tr>
5487
5488 <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>avoidCancelled</code></td>
5489
5490
5491 <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;">
5492
5493
5494<span class="param-type">boolean</span>
5495
5496
5497
5498
5499 </td>
5500
5501
5502 <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;">
5503
5504 &lt;optional><br>
5505
5506
5507
5508
5509
5510 </td>
5511
5512
5513
5514 <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;">
5515
5516 false
5517
5518 </td>
5519
5520
5521 <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 &quot;avoidCancelled&quot; parameter when calling the <a href="CB_AudioFileSprites.html#getAudioFileBySoundInstanceId"><code>CB_AudioFileSprites#getAudioFileBySoundInstanceId</code></a> method internally.</p></td>
5522 </tr>
5523
5524
5525 </tbody>
5526</table>
5527
5528
5529
5530
5531<dl class="details">
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5562 <dd class="tag-source">
5563 <ul class="dummy">
5564 <li>
5565 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
5566 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-918">line 918</a>
5567 </li>
5568 </ul>
5569 </dd>
5570
5571
5572
5573
5574
5575
5576
5577</dl>
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591 <h5>Returns:</h5>
5592
5593
5594<div class="param-desc">
5595 <p>Returns the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object associated to a given sound instance ID, if any, or null otherwise.</p>
5596</div>
5597
5598
5599
5600<dl>
5601 <dt>
5602 Type
5603 </dt>
5604 <dd>
5605
5606<span class="param-type"><a href="CB_AudioFile.html">CB_AudioFile</a></span>
5607|
5608
5609<span class="param-type">null</span>
5610
5611
5612
5613 </dd>
5614</dl>
5615
5616
5617
5618
5619
5620</dd>
5621
5622
5623
5624<hr>
5625<dt>
5626 <h4 class="name" id="getAudioFiles"><span class="type-signature"></span>getAudioFiles<span class="signature">( [copy] [, oneDimension])</span><span class="type-signature"> &rarr; {Object|array}</span></h4>
5627
5628
5629</dt>
5630<dd>
5631
5632
5633 <div class="description">
5634 <p>Gets an object with arrays or a one-dimension array with all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects. Uses the <a href="CB_AudioFileSprites.html#getAudioFiles"><code>CB_AudioFileSprites#getAudioFiles</code></a> method internally.</p>
5635 </div>
5636
5637
5638
5639
5640
5641
5642
5643
5644 <h5>Parameters:</h5>
5645
5646
5647<table class="params table table-striped">
5648 <thead>
5649 <tr>
5650
5651 <th style="width:12%; min-width:110px;">Name</th>
5652
5653
5654 <th style="width:12%; min-width:110px;">Type</th>
5655
5656
5657 <th style="width:12%; min-width:110px;">Argument</th>
5658
5659
5660
5661 <th style="width:12%; min-width:110px;">Default</th>
5662
5663
5664 <th class="last" style="min-width:310px;">Description</th>
5665 </tr>
5666 </thead>
5667
5668 <tbody>
5669
5670
5671 <tr>
5672
5673 <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>copy</code></td>
5674
5675
5676 <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;">
5677
5678
5679<span class="param-type">boolean</span>
5680
5681
5682
5683
5684 </td>
5685
5686
5687 <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;">
5688
5689 &lt;optional><br>
5690
5691
5692
5693
5694
5695 </td>
5696
5697
5698
5699 <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;">
5700
5701 false
5702
5703 </td>
5704
5705
5706 <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 &quot;copy&quot; parameter when calling the <a href="CB_AudioFileSprites.html#getAudioFiles"><code>CB_AudioFileSprites#getAudioFiles</code></a> method internally.</p></td>
5707 </tr>
5708
5709
5710
5711 <tr>
5712
5713 <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>oneDimension</code></td>
5714
5715
5716 <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;">
5717
5718
5719<span class="param-type">boolean</span>
5720
5721
5722
5723
5724 </td>
5725
5726
5727 <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;">
5728
5729 &lt;optional><br>
5730
5731
5732
5733
5734
5735 </td>
5736
5737
5738
5739 <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;">
5740
5741 false
5742
5743 </td>
5744
5745
5746 <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>If it is set to true, the method will return an array with all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects. Otherwise, if it is set to false, the method will return an object whose property names will be the ID of each sprites group and their value will be an array with all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that belong to that sprites group.</p></td>
5747 </tr>
5748
5749
5750 </tbody>
5751</table>
5752
5753
5754
5755
5756<dl class="details">
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5787 <dd class="tag-source">
5788 <ul class="dummy">
5789 <li>
5790 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
5791 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1483">line 1483</a>
5792 </li>
5793 </ul>
5794 </dd>
5795
5796
5797
5798
5799
5800
5801
5802</dl>
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816 <h5>Returns:</h5>
5817
5818
5819<div class="param-desc">
5820 <p>If the &quot;oneDimension&quot; parameter is set to true, returns an array with all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects. Otherwise, if the &quot;oneDimension&quot; parameter is set to false, it will return an object whose property names will be the ID of each sprites group and their value will be an array with all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that belong to that sprites group.</p>
5821</div>
5822
5823
5824
5825<dl>
5826 <dt>
5827 Type
5828 </dt>
5829 <dd>
5830
5831<span class="param-type">Object</span>
5832|
5833
5834<span class="param-type">array</span>
5835
5836
5837
5838 </dd>
5839</dl>
5840
5841
5842
5843
5844
5845</dd>
5846
5847
5848
5849<hr>
5850<dt>
5851 <h4 class="name" id="getAudioFilesBusy"><span class="type-signature"></span>getAudioFilesBusy<span class="signature">( [oneDimension])</span><span class="type-signature"> &rarr; {Object|array}</span></h4>
5852
5853
5854</dt>
5855<dd>
5856
5857
5858 <div class="description">
5859 <p>Gets an object with arrays or a one-dimension array with the busy <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects (the objects which are not available and ready to use). Uses the <a href="CB_AudioFileSprites.html#getAudioFilesBusy"><code>CB_AudioFileSprites#getAudioFilesBusy</code></a> method internally.</p>
5860 </div>
5861
5862
5863
5864
5865
5866
5867
5868
5869 <h5>Parameters:</h5>
5870
5871
5872<table class="params table table-striped">
5873 <thead>
5874 <tr>
5875
5876 <th style="width:12%; min-width:110px;">Name</th>
5877
5878
5879 <th style="width:12%; min-width:110px;">Type</th>
5880
5881
5882 <th style="width:12%; min-width:110px;">Argument</th>
5883
5884
5885
5886 <th style="width:12%; min-width:110px;">Default</th>
5887
5888
5889 <th class="last" style="min-width:310px;">Description</th>
5890 </tr>
5891 </thead>
5892
5893 <tbody>
5894
5895
5896 <tr>
5897
5898 <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>oneDimension</code></td>
5899
5900
5901 <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;">
5902
5903
5904<span class="param-type">boolean</span>
5905
5906
5907
5908
5909 </td>
5910
5911
5912 <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;">
5913
5914 &lt;optional><br>
5915
5916
5917
5918
5919
5920 </td>
5921
5922
5923
5924 <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;">
5925
5926 false
5927
5928 </td>
5929
5930
5931 <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>If it is set to true, the method will return an array with the busy <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects. Otherwise, if it is set to false, the method will return an object whose property names will be the ID of each sprites group and their value will be an array with the busy <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that belong to that sprites group.</p></td>
5932 </tr>
5933
5934
5935 </tbody>
5936</table>
5937
5938
5939
5940
5941<dl class="details">
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5972 <dd class="tag-source">
5973 <ul class="dummy">
5974 <li>
5975 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
5976 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1559">line 1559</a>
5977 </li>
5978 </ul>
5979 </dd>
5980
5981
5982
5983
5984
5985
5986
5987</dl>
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001 <h5>Returns:</h5>
6002
6003
6004<div class="param-desc">
6005 <p>If the &quot;oneDimension&quot; parameter is set to true, returns an array with the busy <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects. Otherwise, if the &quot;oneDimension&quot; parameter is set to false, it will return an object whose property names will be the ID of each sprites group and their value will be an array with the busy <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that belong to that sprites group.</p>
6006</div>
6007
6008
6009
6010<dl>
6011 <dt>
6012 Type
6013 </dt>
6014 <dd>
6015
6016<span class="param-type">Object</span>
6017|
6018
6019<span class="param-type">array</span>
6020
6021
6022
6023 </dd>
6024</dl>
6025
6026
6027
6028
6029
6030</dd>
6031
6032
6033
6034<hr>
6035<dt>
6036 <h4 class="name" id="getAudioFilesFree"><span class="type-signature"></span>getAudioFilesFree<span class="signature">( [oneDimension])</span><span class="type-signature"> &rarr; {Object|array}</span></h4>
6037
6038
6039</dt>
6040<dd>
6041
6042
6043 <div class="description">
6044 <p>Gets an object with arrays or a one-dimension array with the free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects (the objects which are available and ready to use). Uses the <a href="CB_AudioFileSprites.html#getAudioFilesFree"><code>CB_AudioFileSprites#getAudioFilesFree</code></a> method internally.</p>
6045 </div>
6046
6047
6048
6049
6050
6051
6052
6053
6054 <h5>Parameters:</h5>
6055
6056
6057<table class="params table table-striped">
6058 <thead>
6059 <tr>
6060
6061 <th style="width:12%; min-width:110px;">Name</th>
6062
6063
6064 <th style="width:12%; min-width:110px;">Type</th>
6065
6066
6067 <th style="width:12%; min-width:110px;">Argument</th>
6068
6069
6070
6071 <th style="width:12%; min-width:110px;">Default</th>
6072
6073
6074 <th class="last" style="min-width:310px;">Description</th>
6075 </tr>
6076 </thead>
6077
6078 <tbody>
6079
6080
6081 <tr>
6082
6083 <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>oneDimension</code></td>
6084
6085
6086 <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;">
6087
6088
6089<span class="param-type">boolean</span>
6090
6091
6092
6093
6094 </td>
6095
6096
6097 <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;">
6098
6099 &lt;optional><br>
6100
6101
6102
6103
6104
6105 </td>
6106
6107
6108
6109 <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;">
6110
6111 false
6112
6113 </td>
6114
6115
6116 <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>If it is set to true, the method will return an array with the free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects. Otherwise, if it is set to false, the method will return an object whose property names will be the ID of each sprites group and their value will be an array with the free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that belong to that sprites group.</p></td>
6117 </tr>
6118
6119
6120 </tbody>
6121</table>
6122
6123
6124
6125
6126<dl class="details">
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
6157 <dd class="tag-source">
6158 <ul class="dummy">
6159 <li>
6160 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
6161 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1521">line 1521</a>
6162 </li>
6163 </ul>
6164 </dd>
6165
6166
6167
6168
6169
6170
6171
6172</dl>
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186 <h5>Returns:</h5>
6187
6188
6189<div class="param-desc">
6190 <p>If the &quot;oneDimension&quot; parameter is set to true, returns an array with the free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects. Otherwise, if the &quot;oneDimension&quot; parameter is set to false, it will return an object whose property names will be the ID of each sprites group and their value will be an array with the free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that belong to that sprites group.</p>
6191</div>
6192
6193
6194
6195<dl>
6196 <dt>
6197 Type
6198 </dt>
6199 <dd>
6200
6201<span class="param-type">Object</span>
6202|
6203
6204<span class="param-type">array</span>
6205
6206
6207
6208 </dd>
6209</dl>
6210
6211
6212
6213
6214
6215</dd>
6216
6217
6218
6219<hr>
6220<dt>
6221 <h4 class="name" id="getAudioFilesFreeNumber"><span class="type-signature"></span>getAudioFilesFreeNumber<span class="signature">()</span><span class="type-signature"> &rarr; {integer}</span></h4>
6222
6223
6224</dt>
6225<dd>
6226
6227
6228 <div class="description">
6229 <p>Tells the current number of free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects (the number of objects which are available and ready to use). Uses the <a href="CB_AudioFileSprites.html#getAudioFilesFreeNumber"><code>CB_AudioFileSprites#getAudioFilesFreeNumber</code></a> method internally.</p>
6230 </div>
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241<dl class="details">
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
6272 <dd class="tag-source">
6273 <ul class="dummy">
6274 <li>
6275 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
6276 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1465">line 1465</a>
6277 </li>
6278 </ul>
6279 </dd>
6280
6281
6282
6283
6284
6285
6286
6287</dl>
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301 <h5>Returns:</h5>
6302
6303
6304<div class="param-desc">
6305 <p>Returns the current number of free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects (the number of objects which are available and ready to use).</p>
6306</div>
6307
6308
6309
6310<dl>
6311 <dt>
6312 Type
6313 </dt>
6314 <dd>
6315
6316<span class="param-type">integer</span>
6317
6318
6319
6320 </dd>
6321</dl>
6322
6323
6324
6325
6326
6327</dd>
6328
6329
6330
6331<hr>
6332<dt>
6333 <h4 class="name" id="getAudioFilesNumber"><span class="type-signature"></span>getAudioFilesNumber<span class="signature">( [real])</span><span class="type-signature"> &rarr; {integer}</span></h4>
6334
6335
6336</dt>
6337<dd>
6338
6339
6340 <div class="description">
6341 <p>Tells the number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects created. Uses the <a href="CB_AudioFileSprites.html#getAudioFilesNumber"><code>CB_AudioFileSprites#getAudioFilesNumber</code></a> method internally.</p>
6342 </div>
6343
6344
6345
6346
6347
6348
6349
6350
6351 <h5>Parameters:</h5>
6352
6353
6354<table class="params table table-striped">
6355 <thead>
6356 <tr>
6357
6358 <th style="width:12%; min-width:110px;">Name</th>
6359
6360
6361 <th style="width:12%; min-width:110px;">Type</th>
6362
6363
6364 <th style="width:12%; min-width:110px;">Argument</th>
6365
6366
6367
6368 <th style="width:12%; min-width:110px;">Default</th>
6369
6370
6371 <th class="last" style="min-width:310px;">Description</th>
6372 </tr>
6373 </thead>
6374
6375 <tbody>
6376
6377
6378 <tr>
6379
6380 <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>real</code></td>
6381
6382
6383 <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;">
6384
6385
6386<span class="param-type">boolean</span>
6387
6388
6389
6390
6391 </td>
6392
6393
6394 <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;">
6395
6396 &lt;optional><br>
6397
6398
6399
6400
6401
6402 </td>
6403
6404
6405
6406 <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;">
6407
6408 false
6409
6410 </td>
6411
6412
6413 <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 &quot;real&quot; parameter when calling the <a href="CB_AudioFileSprites.html#getAudioFilesNumber"><code>CB_AudioFileSprites#getAudioFilesNumber</code></a> method internally.</p></td>
6414 </tr>
6415
6416
6417 </tbody>
6418</table>
6419
6420
6421
6422
6423<dl class="details">
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
6454 <dd class="tag-source">
6455 <ul class="dummy">
6456 <li>
6457 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
6458 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1597">line 1597</a>
6459 </li>
6460 </ul>
6461 </dd>
6462
6463
6464
6465
6466
6467
6468
6469</dl>
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483 <h5>Returns:</h5>
6484
6485
6486<div class="param-desc">
6487 <p>Returns the number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects created.</p>
6488</div>
6489
6490
6491
6492<dl>
6493 <dt>
6494 Type
6495 </dt>
6496 <dd>
6497
6498<span class="param-type">integer</span>
6499
6500
6501
6502 </dd>
6503</dl>
6504
6505
6506
6507
6508
6509</dd>
6510
6511
6512
6513<hr>
6514<dt>
6515 <h4 class="name" id="getAudioFilesUsed"><span class="type-signature"></span>getAudioFilesUsed<span class="signature">( [oneDimension] [, includeWithoutSpriteAssociated] [, avoidCancelled])</span><span class="type-signature"> &rarr; {<a href="CB_AudioFileSprites.html#.getAudioFilesUsed_OBJECT">CB_AudioFileSprites.getAudioFilesUsed_OBJECT</a>|array}</span></h4>
6516
6517
6518</dt>
6519<dd>
6520
6521
6522 <div class="description">
6523 <p>Returns the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects used by all the sounds instances of all the sprites groups.</p>
6524 </div>
6525
6526
6527
6528
6529
6530
6531
6532
6533 <h5>Parameters:</h5>
6534
6535
6536<table class="params table table-striped">
6537 <thead>
6538 <tr>
6539
6540 <th style="width:12%; min-width:110px;">Name</th>
6541
6542
6543 <th style="width:12%; min-width:110px;">Type</th>
6544
6545
6546 <th style="width:12%; min-width:110px;">Argument</th>
6547
6548
6549
6550 <th style="width:12%; min-width:110px;">Default</th>
6551
6552
6553 <th class="last" style="min-width:310px;">Description</th>
6554 </tr>
6555 </thead>
6556
6557 <tbody>
6558
6559
6560 <tr>
6561
6562 <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>oneDimension</code></td>
6563
6564
6565 <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;">
6566
6567
6568<span class="param-type">boolean</span>
6569
6570
6571
6572
6573 </td>
6574
6575
6576 <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;">
6577
6578 &lt;optional><br>
6579
6580
6581
6582
6583
6584 </td>
6585
6586
6587
6588 <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;">
6589
6590 false
6591
6592 </td>
6593
6594
6595 <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>If set to false, it will return an object whose property names will be the ID of each sprites group and their value will be the an object whose property names are the sprite identifiers (including the &quot;_WITHOUT_SPRITE_ASSOCIATED&quot; property for sound instances without a sprite associated, if the &quot;includeWithoutSpriteAssociated&quot; is set to true) and their value will be a numeric array with the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects used. Otherwise, if set to true, it will return a numeric array with the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects used (if the &quot;includeWithoutSpriteAssociated&quot; parameter is set to true, it will also contain the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose sound instance ID is not associated to any sprite).</p></td>
6596 </tr>
6597
6598
6599
6600 <tr>
6601
6602 <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>includeWithoutSpriteAssociated</code></td>
6603
6604
6605 <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;">
6606
6607
6608<span class="param-type">boolean</span>
6609
6610
6611
6612
6613 </td>
6614
6615
6616 <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;">
6617
6618 &lt;optional><br>
6619
6620
6621
6622
6623
6624 </td>
6625
6626
6627
6628 <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;">
6629
6630 false
6631
6632 </td>
6633
6634
6635 <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>If set to true, it will also return the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose sound instance ID is not associated to any sprite. Used as the &quot;includeWithoutSpriteAssociated&quot; parameter when calling the <a href="CB_AudioFileSprites.html#getAudioFilesUsed"><code>CB_AudioFileSprites#getAudioFilesUsed</code></a> method internally.</p></td>
6636 </tr>
6637
6638
6639
6640 <tr>
6641
6642 <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>avoidCancelled</code></td>
6643
6644
6645 <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;">
6646
6647
6648<span class="param-type">boolean</span>
6649
6650
6651
6652
6653 </td>
6654
6655
6656 <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;">
6657
6658 &lt;optional><br>
6659
6660
6661
6662
6663
6664 </td>
6665
6666
6667
6668 <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;">
6669
6670 false
6671
6672 </td>
6673
6674
6675 <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>If set to true, it will not return the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose sound instance has been cancelled. Used as the &quot;avoidCancelled&quot; parameter when calling the <a href="CB_AudioFileSprites.html#getAudioFilesUsed"><code>CB_AudioFileSprites#getAudioFilesUsed</code></a> method internally.</p></td>
6676 </tr>
6677
6678
6679 </tbody>
6680</table>
6681
6682
6683
6684
6685<dl class="details">
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
6716 <dd class="tag-source">
6717 <ul class="dummy">
6718 <li>
6719 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
6720 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-718">line 718</a>
6721 </li>
6722 </ul>
6723 </dd>
6724
6725
6726
6727
6728
6729
6730
6731</dl>
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745 <h5>Returns:</h5>
6746
6747
6748<div class="param-desc">
6749 <p>Returns the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects used by all the sounds instances of all the sprites groups. If the &quot;oneDimension&quot; parameter is set to false, it will return a <a href="CB_AudioFileSpritesPool.html#.getAudioFilesUsed_OBJECT"><code>CB_AudioFileSpritesPool.getAudioFilesUsed_OBJECT</code></a> object whose property names will be the ID of each sprites group and their value will be a <a href="CB_AudioFileSprites.html#.getAudioFilesUsed_OBJECT"><code>CB_AudioFileSprites.getAudioFilesUsed_OBJECT</code></a> object whose property names are the sprite identifiers (including the &quot;_WITHOUT_SPRITE_ASSOCIATED&quot; property for sound instances without a sprite associated, if the &quot;includeWithoutSpriteAssociated&quot; is set to true) and their value will be a numeric array with the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects used. Otherwise, if the &quot;oneDimension&quot; parameter set to true, it will return a numeric array with the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects used (if the &quot;includeWithoutSpriteAssociated&quot; parameter is set to true, it will also contain the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose sound instance ID is not associated to any sprite).</p>
6750</div>
6751
6752
6753
6754<dl>
6755 <dt>
6756 Type
6757 </dt>
6758 <dd>
6759
6760<span class="param-type"><a href="CB_AudioFileSprites.html#.getAudioFilesUsed_OBJECT">CB_AudioFileSprites.getAudioFilesUsed_OBJECT</a></span>
6761|
6762
6763<span class="param-type">array</span>
6764
6765
6766
6767 </dd>
6768</dl>
6769
6770
6771
6772
6773
6774</dd>
6775
6776
6777
6778<hr>
6779<dt>
6780 <h4 class="name" id="getProgress"><span class="type-signature"></span>getProgress<span class="signature">( [countLoadedObjects] [, alsoUncheckedAndCheckingObjects])</span><span class="type-signature"> &rarr; {number}</span></h4>
6781
6782
6783</dt>
6784<dd>
6785
6786
6787 <div class="description">
6788 <p>Returns a number representing the percentage of the loading progress for the audio sprites pool object (from 0 to 100, being 100 a complete loading progress). The way to calculate it internally may differ from one audio API to another and it is not totally reliable. Uses the <a href="CB_AudioFileSprites.html#getProgress"><code>CB_AudioFileSprites#getProgress</code></a> method internally.</p>
6789 </div>
6790
6791
6792
6793
6794
6795
6796
6797
6798 <h5>Parameters:</h5>
6799
6800
6801<table class="params table table-striped">
6802 <thead>
6803 <tr>
6804
6805 <th style="width:12%; min-width:110px;">Name</th>
6806
6807
6808 <th style="width:12%; min-width:110px;">Type</th>
6809
6810
6811 <th style="width:12%; min-width:110px;">Argument</th>
6812
6813
6814
6815 <th style="width:12%; min-width:110px;">Default</th>
6816
6817
6818 <th class="last" style="min-width:310px;">Description</th>
6819 </tr>
6820 </thead>
6821
6822 <tbody>
6823
6824
6825 <tr>
6826
6827 <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>countLoadedObjects</code></td>
6828
6829
6830 <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;">
6831
6832
6833<span class="param-type">boolean</span>
6834
6835
6836
6837
6838 </td>
6839
6840
6841 <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;">
6842
6843 &lt;optional><br>
6844
6845
6846
6847
6848
6849 </td>
6850
6851
6852
6853 <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;">
6854
6855 false
6856
6857 </td>
6858
6859
6860 <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 &quot;countLoadedObjects&quot; parameter when calling the <a href="CB_AudioFileSprites.html#getProgress"><code>CB_AudioFileSprites#getProgress</code></a> method internally.</p></td>
6861 </tr>
6862
6863
6864
6865 <tr>
6866
6867 <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>alsoUncheckedAndCheckingObjects</code></td>
6868
6869
6870 <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;">
6871
6872
6873<span class="param-type">boolean</span>
6874
6875
6876
6877
6878 </td>
6879
6880
6881 <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;">
6882
6883 &lt;optional><br>
6884
6885
6886
6887
6888
6889 </td>
6890
6891
6892
6893 <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;">
6894
6895 false
6896
6897 </td>
6898
6899
6900 <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 &quot;alsoUncheckedAndCheckingObjects&quot; parameter when calling the <a href="CB_AudioFileSprites.html#getProgress"><code>CB_AudioFileSprites#getProgress</code></a> method internally.</p></td>
6901 </tr>
6902
6903
6904 </tbody>
6905</table>
6906
6907
6908
6909
6910<dl class="details">
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
6941 <dd class="tag-source">
6942 <ul class="dummy">
6943 <li>
6944 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
6945 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1615">line 1615</a>
6946 </li>
6947 </ul>
6948 </dd>
6949
6950
6951
6952
6953
6954
6955
6956</dl>
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970 <h5>Returns:</h5>
6971
6972
6973<div class="param-desc">
6974 <p>Returns a number representing the percentage of the loading progress for the audio sprites pool object (from 0 to 100, being 100 a complete loading progress). The way to calculate it internally may differ from one audio API to another and it is not totally reliable.</p>
6975</div>
6976
6977
6978
6979<dl>
6980 <dt>
6981 Type
6982 </dt>
6983 <dd>
6984
6985<span class="param-type">number</span>
6986
6987
6988
6989 </dd>
6990</dl>
6991
6992
6993
6994
6995
6996</dd>
6997
6998
6999
7000<hr>
7001<dt>
7002 <h4 class="name" id="getSoundInstancesId"><span class="type-signature"></span>getSoundInstancesId<span class="signature">( [oneDimension] [, includeWithoutSpriteAssociated])</span><span class="type-signature"> &rarr; {Object|array}</span></h4>
7003
7004
7005</dt>
7006<dd>
7007
7008
7009 <div class="description">
7010 <p>Returns the sound instances (their ID) used (stored in the <a href="CB_AudioFileSprites.html#spriteSoundInstances"><code>CB_AudioFileSprites#spriteSoundInstances</code></a> property of each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object).</p>
7011 </div>
7012
7013
7014
7015
7016
7017
7018
7019
7020 <h5>Parameters:</h5>
7021
7022
7023<table class="params table table-striped">
7024 <thead>
7025 <tr>
7026
7027 <th style="width:12%; min-width:110px;">Name</th>
7028
7029
7030 <th style="width:12%; min-width:110px;">Type</th>
7031
7032
7033 <th style="width:12%; min-width:110px;">Argument</th>
7034
7035
7036
7037 <th style="width:12%; min-width:110px;">Default</th>
7038
7039
7040 <th class="last" style="min-width:310px;">Description</th>
7041 </tr>
7042 </thead>
7043
7044 <tbody>
7045
7046
7047 <tr>
7048
7049 <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>oneDimension</code></td>
7050
7051
7052 <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;">
7053
7054
7055<span class="param-type">boolean</span>
7056
7057
7058
7059
7060 </td>
7061
7062
7063 <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;">
7064
7065 &lt;optional><br>
7066
7067
7068
7069
7070
7071 </td>
7072
7073
7074
7075 <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;">
7076
7077 false
7078
7079 </td>
7080
7081
7082 <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>If set to false, it will return an object whose property names will be the ID of each sprites group and their value will be the <a href="CB_AudioFileSprites.html#spriteSoundInstances"><code>CB_AudioFileSprites#spriteSoundInstances</code></a> property of each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object (which includes the &quot;_WITHOUT_SPRITE_ASSOCIATED&quot; property for sound instances without a sprite associated) which belongs to that sprites group. Otherwise, if it is set to true, it will return a numeric array whose values are the sound instance IDs.</p></td>
7083 </tr>
7084
7085
7086
7087 <tr>
7088
7089 <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>includeWithoutSpriteAssociated</code></td>
7090
7091
7092 <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;">
7093
7094
7095<span class="param-type">boolean</span>
7096
7097
7098
7099
7100 </td>
7101
7102
7103 <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;">
7104
7105 &lt;optional><br>
7106
7107
7108
7109
7110
7111 </td>
7112
7113
7114
7115 <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;">
7116
7117 false
7118
7119 </td>
7120
7121
7122 <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>If set to true, it will also return the sound instance identifiers which are not associated to any sprite. Used as the &quot;includeWithoutSpriteAssociated&quot; parameter when calling the <a href="CB_AudioFileSprites.html#getSoundInstancesId"><code>CB_AudioFileSprites#getSoundInstancesId</code></a> method internally. Only used when the &quot;oneDimension&quot; parameter is set to true.</p></td>
7123 </tr>
7124
7125
7126 </tbody>
7127</table>
7128
7129
7130
7131
7132<dl class="details">
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
7163 <dd class="tag-source">
7164 <ul class="dummy">
7165 <li>
7166 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
7167 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-671">line 671</a>
7168 </li>
7169 </ul>
7170 </dd>
7171
7172
7173
7174
7175
7176
7177
7178</dl>
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192 <h5>Returns:</h5>
7193
7194
7195<div class="param-desc">
7196 <p>Returns the sound instances (their ID) used (stored in the <a href="CB_AudioFileSprites.html#spriteSoundInstances"><code>CB_AudioFileSprites#spriteSoundInstances</code></a> property). If the &quot;oneDimension&quot; parameter is set to false, it will return an object whose property names will be the ID of each sprites group and their value will be the <a href="CB_AudioFileSprites.html#spriteSoundInstances"><code>CB_AudioFileSprites#spriteSoundInstances</code></a> property of each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object (which includes the &quot;_WITHOUT_SPRITE_ASSOCIATED&quot; property for sound instances without a sprite associated) which belongs to that sprites group. If the &quot;oneDimension&quot; parameter is set to true, it will return a numeric array whose values are the sound instance identifiers (if the &quot;includeWithoutSpriteAssociated&quot; parameter it set to true, it will also include the sound instances which are not associated to any sprite).</p>
7197</div>
7198
7199
7200
7201<dl>
7202 <dt>
7203 Type
7204 </dt>
7205 <dd>
7206
7207<span class="param-type">Object</span>
7208|
7209
7210<span class="param-type">array</span>
7211
7212
7213
7214 </dd>
7215</dl>
7216
7217
7218
7219
7220
7221</dd>
7222
7223
7224
7225<hr>
7226<dt>
7227 <h4 class="name" id="getSprites"><span class="type-signature"></span>getSprites<span class="signature">( [includeWithoutSpriteAssociated] [, orderBySpritesGroup])</span><span class="type-signature"> &rarr; {<a href="CB_AudioFileSprites.html#.SPRITES_OBJECT">CB_AudioFileSprites.SPRITES_OBJECT</a>|Object}</span></h4>
7228
7229
7230</dt>
7231<dd>
7232
7233
7234 <div class="description">
7235 <p>Returns an object with the sprites (and includes &quot;_WITHOUT_SPRITE_ASSOCIATED&quot; if we want to). Internally, uses the <a href="CB_AudioFileSprites.html#getSprites"><code>CB_AudioFileSprites#getSprites</code></a> method.</p>
7236 </div>
7237
7238
7239
7240
7241
7242
7243
7244
7245 <h5>Parameters:</h5>
7246
7247
7248<table class="params table table-striped">
7249 <thead>
7250 <tr>
7251
7252 <th style="width:12%; min-width:110px;">Name</th>
7253
7254
7255 <th style="width:12%; min-width:110px;">Type</th>
7256
7257
7258 <th style="width:12%; min-width:110px;">Argument</th>
7259
7260
7261
7262 <th style="width:12%; min-width:110px;">Default</th>
7263
7264
7265 <th class="last" style="min-width:310px;">Description</th>
7266 </tr>
7267 </thead>
7268
7269 <tbody>
7270
7271
7272 <tr>
7273
7274 <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>includeWithoutSpriteAssociated</code></td>
7275
7276
7277 <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;">
7278
7279
7280<span class="param-type">boolean</span>
7281
7282
7283
7284
7285 </td>
7286
7287
7288 <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;">
7289
7290 &lt;optional><br>
7291
7292
7293
7294
7295
7296 </td>
7297
7298
7299
7300 <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;">
7301
7302 false
7303
7304 </td>
7305
7306
7307 <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>If set to true, the returning object will also contain a property called &quot;_WITHOUT_SPRITE_ASSOCIATED&quot; whose value will be an empty object (unless the &quot;orderBySpritesGroup&quot; parameter is set to true and the property existed before in the object stored in the <a href="CB_AudioFileSprites.html#sprites"><code>CB_AudioFileSprites#sprites</code></a> property and had a value which is not an empty object). If set to false and the &quot;orderBySpritesGroup&quot; parameter is also set to false, the returning object will not contain the &quot;_WITHOUT_SPRITE_ASSOCIATED&quot; property. If set to false and the &quot;orderBySpritesGroup&quot; parameter is set to true, the returning object will not contain the &quot;_WITHOUT_SPRITE_ASSOCIATED&quot; property unless the property existed before in the object stored in the <a href="CB_AudioFileSprites.html#sprites"><code>CB_AudioFileSprites#sprites</code></a> property.</p></td>
7308 </tr>
7309
7310
7311
7312 <tr>
7313
7314 <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>orderBySpritesGroup</code></td>
7315
7316
7317 <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;">
7318
7319
7320<span class="param-type">boolean</span>
7321
7322
7323
7324
7325 </td>
7326
7327
7328 <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;">
7329
7330 &lt;optional><br>
7331
7332
7333
7334
7335
7336 </td>
7337
7338
7339
7340 <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;">
7341
7342 false
7343
7344 </td>
7345
7346
7347 <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>If set to false, it will return a <a href="CB_AudioFileSprites.html#.SPRITES_OBJECT"><code>CB_AudioFileSprites.SPRITES_OBJECT</code></a> object whose properties will be the ID of each sprite (each sprite ID should be unique) and their value will be a <a href="CB_AudioFileSprites.html#.SPRITE_OBJECT"><code>CB_AudioFileSprites.SPRITE_OBJECT</code></a> object. If set to true, it will return an object whose properties will be the ID of each sprites group and the value will be a <a href="CB_AudioFileSprites.html#.SPRITES_OBJECT"><code>CB_AudioFileSprites.SPRITES_OBJECT</code></a> object which will include its sprites.</p></td>
7348 </tr>
7349
7350
7351 </tbody>
7352</table>
7353
7354
7355
7356
7357<dl class="details">
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
7388 <dd class="tag-source">
7389 <ul class="dummy">
7390 <li>
7391 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
7392 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-634">line 634</a>
7393 </li>
7394 </ul>
7395 </dd>
7396
7397
7398
7399
7400
7401
7402
7403</dl>
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417 <h5>Returns:</h5>
7418
7419
7420<div class="param-desc">
7421 <p>If the &quot;orderBySpritesGroup&quot; is set to false, it will return a <a href="CB_AudioFileSprites.html#.SPRITES_OBJECT"><code>CB_AudioFileSprites.SPRITES_OBJECT</code></a> object whose properties will be the ID of each sprite (each sprite ID should be unique) and their value will be a <a href="CB_AudioFileSprites.html#.SPRITE_OBJECT"><code>CB_AudioFileSprites.SPRITE_OBJECT</code></a> object. If the &quot;orderBySpritesGroup&quot; is set to true, it will return an object whose properties will be the ID of each sprites group and the value will be a <a href="CB_AudioFileSprites.html#.SPRITES_OBJECT"><code>CB_AudioFileSprites.SPRITES_OBJECT</code></a> object which will include its sprites.</p>
7422</div>
7423
7424
7425
7426<dl>
7427 <dt>
7428 Type
7429 </dt>
7430 <dd>
7431
7432<span class="param-type"><a href="CB_AudioFileSprites.html#.SPRITES_OBJECT">CB_AudioFileSprites.SPRITES_OBJECT</a></span>
7433|
7434
7435<span class="param-type">Object</span>
7436
7437
7438
7439 </dd>
7440</dl>
7441
7442
7443
7444
7445
7446</dd>
7447
7448
7449
7450<hr>
7451<dt>
7452 <h4 class="name" id="getSpritesGroup"><span class="type-signature"></span>getSpritesGroup<span class="signature">(spritesGroupId [, withoutChecking])</span><span class="type-signature"> &rarr; {<a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a>|undefined|*|null}</span></h4>
7453
7454
7455</dt>
7456<dd>
7457
7458
7459 <div class="description">
7460 <p>Returns a sprites group (the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object) by its ID.</p>
7461 </div>
7462
7463
7464
7465
7466
7467
7468
7469
7470 <h5>Parameters:</h5>
7471
7472
7473<table class="params table table-striped">
7474 <thead>
7475 <tr>
7476
7477 <th style="width:12%; min-width:110px;">Name</th>
7478
7479
7480 <th style="width:12%; min-width:110px;">Type</th>
7481
7482
7483 <th style="width:12%; min-width:110px;">Argument</th>
7484
7485
7486
7487 <th style="width:12%; min-width:110px;">Default</th>
7488
7489
7490 <th class="last" style="min-width:310px;">Description</th>
7491 </tr>
7492 </thead>
7493
7494 <tbody>
7495
7496
7497 <tr>
7498
7499 <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>spritesGroupId</code></td>
7500
7501
7502 <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;">
7503
7504
7505<span class="param-type">string</span>
7506
7507
7508
7509
7510 </td>
7511
7512
7513 <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;">
7514
7515
7516
7517
7518
7519 </td>
7520
7521
7522
7523 <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;">
7524
7525 </td>
7526
7527
7528 <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>The identifier for the sprites group.</p></td>
7529 </tr>
7530
7531
7532
7533 <tr>
7534
7535 <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>withoutChecking</code></td>
7536
7537
7538 <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;">
7539
7540
7541<span class="param-type">boolean</span>
7542
7543
7544
7545
7546 </td>
7547
7548
7549 <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;">
7550
7551 &lt;optional><br>
7552
7553
7554
7555
7556
7557 </td>
7558
7559
7560
7561 <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;">
7562
7563 false
7564
7565 </td>
7566
7567
7568 <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>If set to true and the sprites group cannot be found, the method will return undefined (or whatever is stored by the given ID) instead of null.</p></td>
7569 </tr>
7570
7571
7572 </tbody>
7573</table>
7574
7575
7576
7577
7578<dl class="details">
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
7609 <dd class="tag-source">
7610 <ul class="dummy">
7611 <li>
7612 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
7613 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-605">line 605</a>
7614 </li>
7615 </ul>
7616 </dd>
7617
7618
7619
7620
7621
7622
7623
7624</dl>
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638 <h5>Returns:</h5>
7639
7640
7641<div class="param-desc">
7642 <p>Returns null if the &quot;withoutChecking&quot; parameter is set to true and the sprites group cannot be found. Otherwise, it will return what is stored internally by the given ID which can be a <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object if found or undefined (or whatever is stored by the given ID) if not found.</p>
7643</div>
7644
7645
7646
7647<dl>
7648 <dt>
7649 Type
7650 </dt>
7651 <dd>
7652
7653<span class="param-type"><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></span>
7654|
7655
7656<span class="param-type">undefined</span>
7657|
7658
7659<span class="param-type">*</span>
7660|
7661
7662<span class="param-type">null</span>
7663
7664
7665
7666 </dd>
7667</dl>
7668
7669
7670
7671
7672
7673</dd>
7674
7675
7676
7677<hr>
7678<dt>
7679 <h4 class="name" id="getSpritesGroups"><span class="type-signature"></span>getSpritesGroups<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
7680
7681
7682</dt>
7683<dd>
7684
7685
7686 <div class="description">
7687 <p>Returns an object with the sprites groups (all the internally-created <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> objects), being the name of each property their group ID and the value being the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object itself. Internally, it just returns the <a href="CB_AudioFileSpritesPool.html#audioFileSprites"><code>CB_AudioFileSpritesPool#audioFileSprites</code></a> property.</p>
7688 </div>
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699<dl class="details">
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
7730 <dd class="tag-source">
7731 <ul class="dummy">
7732 <li>
7733 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
7734 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-621">line 621</a>
7735 </li>
7736 </ul>
7737 </dd>
7738
7739
7740
7741
7742
7743
7744
7745</dl>
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759 <h5>Returns:</h5>
7760
7761
7762<div class="param-desc">
7763 <p>Returns an object with the sprites groups (all the internally-created <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> objects), being the name of each property their group ID and the value being the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object itself. Internally, it just returns the <a href="CB_AudioFileSpritesPool.html#audioFileSprites"><code>CB_AudioFileSpritesPool#audioFileSprites</code></a> property.</p>
7764</div>
7765
7766
7767
7768<dl>
7769 <dt>
7770 Type
7771 </dt>
7772 <dd>
7773
7774<span class="param-type">Object</span>
7775
7776
7777
7778 </dd>
7779</dl>
7780
7781
7782
7783
7784
7785</dd>
7786
7787
7788
7789<hr>
7790<dt>
7791 <h4 class="name" id="getStatus"><span class="type-signature"></span>getStatus<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
7792
7793
7794</dt>
7795<dd>
7796
7797
7798 <div class="description">
7799 <p>Gets the current status of the audio file sprites pool object. Uses the <a href="CB_AudioFileSprites.html#getStatus"><code>CB_AudioFileSprites#getStatus</code></a> method internally.</p>
7800 </div>
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811<dl class="details">
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
7842 <dd class="tag-source">
7843 <ul class="dummy">
7844 <li>
7845 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
7846 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1634">line 1634</a>
7847 </li>
7848 </ul>
7849 </dd>
7850
7851
7852
7853
7854
7855
7856
7857</dl>
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871 <h5>Returns:</h5>
7872
7873
7874<div class="param-desc">
7875 <p>Returns the current status of the audio file sprites pool object. It is a number, affected by the returning value of the <a href="CB_AudioFileSprites.html#getStatus"><code>CB_AudioFileSprites#getStatus</code></a> method of each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object used internally, which should match the value of the <a href="CB_AudioFileCache.html#.UNLOADED"><code>CB_AudioFileCache.UNLOADED</code></a> (still unloaded), <a href="CB_AudioFileCache.html#.LOADING"><code>CB_AudioFileCache.LOADING</code></a> (loading), <a href="CB_AudioFileCache.html#.UNCHECKED"><code>CB_AudioFileCache.UNCHECKED</code></a> (not checked by calling the <a href="CB_AudioFileCache.html#checkPlayingAll"><code>CB_AudioFileCache#checkPlayingAll</code></a> method yet), <a href="CB_AudioFileCache.html#.CHECKING"><code>CB_AudioFileCache.CHECKING</code></a> (being checked by the <a href="CB_AudioFileCache.html#checkPlayingAll"><code>CB_AudioFileCache#checkPlayingAll</code></a> method), <a href="CB_AudioFileCache.html#.LOADED"><code>CB_AudioFileCache.LOADED</code></a> (loaded), <a href="CB_AudioFileCache.html#.FAILED"><code>CB_AudioFileCache.FAILED</code></a> (failed loading or failed to play or by any other reason) or <a href="CB_AudioFileCache.html#.ABORTED"><code>CB_AudioFileCache.ABORTED</code></a> (aborted because it was destroyed with the &quot;destructor&quot; method) property.</p>
7876</div>
7877
7878
7879
7880<dl>
7881 <dt>
7882 Type
7883 </dt>
7884 <dd>
7885
7886<span class="param-type">number</span>
7887
7888
7889
7890 </dd>
7891</dl>
7892
7893
7894
7895
7896
7897</dd>
7898
7899
7900
7901<hr>
7902<dt>
7903 <h4 class="name" id="getStatusString"><span class="type-signature"></span>getStatusString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
7904
7905
7906</dt>
7907<dd>
7908
7909
7910 <div class="description">
7911 <p>Gets the current status of the audio file sprites pool object, as a string.</p>
7912 </div>
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923<dl class="details">
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
7954 <dd class="tag-source">
7955 <ul class="dummy">
7956 <li>
7957 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
7958 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1682">line 1682</a>
7959 </li>
7960 </ul>
7961 </dd>
7962
7963
7964
7965
7966
7967
7968
7969</dl>
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983 <h5>Returns:</h5>
7984
7985
7986<div class="param-desc">
7987 <p>Returns the current status of the audio file sprites pool object, as a string. Possible return values are &quot;UNLOADED&quot;, &quot;LOADING&quot;, &quot;UNCHECKED&quot;, &quot;CHECKING&quot;, &quot;LOADED&quot;, &quot;FAILED&quot;, &quot;ABORTED&quot; or &quot;UNKNOWN (UNKNOWN_STATUS)&quot; (where &quot;UNKNOWN_STATUS&quot; will be a returning value from the <a href="CB_AudioFileSpritesPool.html#getStatus"><code>CB_AudioFileSpritesPool#getStatus</code></a> method not recognized as any possible status).</p>
7988</div>
7989
7990
7991
7992<dl>
7993 <dt>
7994 Type
7995 </dt>
7996 <dd>
7997
7998<span class="param-type">string</span>
7999
8000
8001
8002 </dd>
8003</dl>
8004
8005
8006
8007
8008
8009</dd>
8010
8011
8012
8013<hr>
8014<dt>
8015 <h4 class="name" id="insertSpritesGroup"><span class="type-signature"></span>insertSpritesGroup<span class="signature">(spritesGroupId [, dataObject] [, avoidCheckingLoaded])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
8016
8017
8018</dt>
8019<dd>
8020
8021
8022 <div class="description">
8023 <p>Inserts the given sprites group to the audio file sprites pool object.</p>
8024 </div>
8025
8026
8027
8028
8029
8030
8031
8032
8033 <h5>Parameters:</h5>
8034
8035
8036<table class="params table table-striped">
8037 <thead>
8038 <tr>
8039
8040 <th style="width:12%; min-width:110px;">Name</th>
8041
8042
8043 <th style="width:12%; min-width:110px;">Type</th>
8044
8045
8046 <th style="width:12%; min-width:110px;">Argument</th>
8047
8048
8049
8050 <th style="width:12%; min-width:110px;">Default</th>
8051
8052
8053 <th class="last" style="min-width:310px;">Description</th>
8054 </tr>
8055 </thead>
8056
8057 <tbody>
8058
8059
8060 <tr>
8061
8062 <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>spritesGroupId</code></td>
8063
8064
8065 <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;">
8066
8067
8068<span class="param-type">string</span>
8069
8070
8071
8072
8073 </td>
8074
8075
8076 <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;">
8077
8078
8079
8080
8081
8082 </td>
8083
8084
8085
8086 <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;">
8087
8088 </td>
8089
8090
8091 <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>The identifier for the sprites group.</p></td>
8092 </tr>
8093
8094
8095
8096 <tr>
8097
8098 <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>
8099
8100
8101 <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;">
8102
8103
8104<span class="param-type"><a href="CB_AudioFileSprites.html#.DATA_OBJECT">CB_AudioFileSprites.DATA_OBJECT</a></span>
8105
8106
8107
8108
8109 </td>
8110
8111
8112 <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;">
8113
8114 &lt;optional><br>
8115
8116
8117
8118
8119
8120 </td>
8121
8122
8123
8124 <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;">
8125
8126 </td>
8127
8128
8129 <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 data of the sprites group. Optional but recommended.</p></td>
8130 </tr>
8131
8132
8133
8134 <tr>
8135
8136 <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>avoidCheckingLoaded</code></td>
8137
8138
8139 <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;">
8140
8141
8142<span class="param-type">boolean</span>
8143
8144
8145
8146
8147 </td>
8148
8149
8150 <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;">
8151
8152 &lt;optional><br>
8153
8154
8155
8156
8157
8158 </td>
8159
8160
8161
8162 <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;">
8163
8164 false
8165
8166 </td>
8167
8168
8169 <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>If set to true, it will not check whether all sprites groups has been loaded after inserting the desired one. This is done internally by the <code>CB_AudioFileSpritesPool#_checkSpritesGroupsLoaded</code> method which will fire the <a href="CB_AudioFileSpritesPool.html#onLoad"><code>CB_AudioFileSpritesPool#onLoad</code></a> function (if any).</p></td>
8170 </tr>
8171
8172
8173 </tbody>
8174</table>
8175
8176
8177
8178
8179<dl class="details">
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
8210 <dd class="tag-source">
8211 <ul class="dummy">
8212 <li>
8213 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
8214 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-498">line 498</a>
8215 </li>
8216 </ul>
8217 </dd>
8218
8219
8220
8221
8222
8223
8224
8225</dl>
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239 <h5>Returns:</h5>
8240
8241
8242<div class="param-desc">
8243 <p>Returns true if the sprites group has been inserted or false otherwise.</p>
8244</div>
8245
8246
8247
8248<dl>
8249 <dt>
8250 Type
8251 </dt>
8252 <dd>
8253
8254<span class="param-type">boolean</span>
8255
8256
8257
8258 </dd>
8259</dl>
8260
8261
8262
8263
8264
8265</dd>
8266
8267
8268
8269<hr>
8270<dt>
8271 <h4 class="name" id="insertSpritesGroups"><span class="type-signature"></span>insertSpritesGroups<span class="signature">(sprites)</span><span class="type-signature"> &rarr; {integer}</span></h4>
8272
8273
8274</dt>
8275<dd>
8276
8277
8278 <div class="description">
8279 <p>Inserts the given sprites groups.</p>
8280 </div>
8281
8282
8283
8284
8285
8286
8287
8288
8289 <h5>Parameters:</h5>
8290
8291
8292<table class="params table table-striped">
8293 <thead>
8294 <tr>
8295
8296 <th style="width:12%; min-width:110px;">Name</th>
8297
8298
8299 <th style="width:12%; min-width:110px;">Type</th>
8300
8301
8302
8303
8304
8305 <th class="last" style="min-width:310px;">Description</th>
8306 </tr>
8307 </thead>
8308
8309 <tbody>
8310
8311
8312 <tr>
8313
8314 <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>sprites</code></td>
8315
8316
8317 <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;">
8318
8319
8320<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT">CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</a></span>
8321
8322
8323
8324
8325 </td>
8326
8327
8328
8329
8330
8331 <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 sprites groups.</p></td>
8332 </tr>
8333
8334
8335 </tbody>
8336</table>
8337
8338
8339
8340
8341<dl class="details">
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
8372 <dd class="tag-source">
8373 <ul class="dummy">
8374 <li>
8375 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
8376 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-470">line 470</a>
8377 </li>
8378 </ul>
8379 </dd>
8380
8381
8382
8383
8384
8385
8386
8387</dl>
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401 <h5>Returns:</h5>
8402
8403
8404<div class="param-desc">
8405 <p>Returns the number of sprites groups inserted.</p>
8406</div>
8407
8408
8409
8410<dl>
8411 <dt>
8412 Type
8413 </dt>
8414 <dd>
8415
8416<span class="param-type">integer</span>
8417
8418
8419
8420 </dd>
8421</dl>
8422
8423
8424
8425
8426
8427</dd>
8428
8429
8430
8431<hr>
8432<dt>
8433 <h4 class="name" id="isAudioFileFree"><span class="type-signature"></span>isAudioFileFree<span class="signature">(id)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
8434
8435
8436</dt>
8437<dd>
8438
8439
8440 <div class="description">
8441 <p>Tells whether a desired <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object is free (it is in the <a href="CB_AudioFileCache.html#audioFilesFree"><code>CB_AudioFileCache#audioFilesFree</code></a> property of any <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object) or not, by its identifier. A free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object is an object which is not being used and it is available to be used. Uses the <a href="CB_AudioFileSprites.html#isAudioFileFree"><code>CB_AudioFileSprites#isAudioFileFree</code></a> method internally.</p>
8442 </div>
8443
8444
8445
8446
8447
8448
8449
8450
8451 <h5>Parameters:</h5>
8452
8453
8454<table class="params table table-striped">
8455 <thead>
8456 <tr>
8457
8458 <th style="width:12%; min-width:110px;">Name</th>
8459
8460
8461 <th style="width:12%; min-width:110px;">Type</th>
8462
8463
8464
8465
8466
8467 <th class="last" style="min-width:310px;">Description</th>
8468 </tr>
8469 </thead>
8470
8471 <tbody>
8472
8473
8474 <tr>
8475
8476 <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>id</code></td>
8477
8478
8479 <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;">
8480
8481
8482<span class="param-type">string</span>
8483
8484
8485
8486
8487 </td>
8488
8489
8490
8491
8492
8493 <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 &quot;id&quot; parameter when calling the <a href="CB_AudioFileSprites.html#isAudioFileFree"><code>CB_AudioFileSprites#isAudioFileFree</code></a> method internally.</p></td>
8494 </tr>
8495
8496
8497 </tbody>
8498</table>
8499
8500
8501
8502
8503<dl class="details">
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
8534 <dd class="tag-source">
8535 <ul class="dummy">
8536 <li>
8537 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
8538 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-848">line 848</a>
8539 </li>
8540 </ul>
8541 </dd>
8542
8543
8544
8545
8546
8547
8548
8549</dl>
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563 <h5>Returns:</h5>
8564
8565
8566<div class="param-desc">
8567 <p>Returns whether a desired <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object is free (it is in the <a href="CB_AudioFileCache.html#audioFilesFree"><code>CB_AudioFileCache#audioFilesFree</code></a> property of any <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object) or not, by its identifier. A free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object is an object which is not being used and it is available to be used.</p>
8568</div>
8569
8570
8571
8572<dl>
8573 <dt>
8574 Type
8575 </dt>
8576 <dd>
8577
8578<span class="param-type">boolean</span>
8579
8580
8581
8582 </dd>
8583</dl>
8584
8585
8586
8587
8588
8589</dd>
8590
8591
8592
8593<hr>
8594<dt>
8595 <h4 class="name" id="isPlaying"><span class="type-signature"></span>isPlaying<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
8596
8597
8598</dt>
8599<dd>
8600
8601
8602 <div class="description">
8603 <p>Tells whether any of the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects is playing or not. Uses the <a href="CB_AudioFileSprites.html#isPlaying"><code>CB_AudioFileSprites#isPlaying</code></a> method internally.</p>
8604 </div>
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615<dl class="details">
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
8646 <dd class="tag-source">
8647 <ul class="dummy">
8648 <li>
8649 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
8650 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1450">line 1450</a>
8651 </li>
8652 </ul>
8653 </dd>
8654
8655
8656
8657
8658
8659
8660
8661</dl>
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675 <h5>Returns:</h5>
8676
8677
8678<div class="param-desc">
8679 <p>Returns whether any of the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects is playing or not.</p>
8680</div>
8681
8682
8683
8684<dl>
8685 <dt>
8686 Type
8687 </dt>
8688 <dd>
8689
8690<span class="param-type">boolean</span>
8691
8692
8693
8694 </dd>
8695</dl>
8696
8697
8698
8699
8700
8701</dd>
8702
8703
8704
8705<hr>
8706<dt>
8707 <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(dataObject)</span><span class="type-signature"> &rarr; {<a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a>|null}</span></h4>
8708
8709
8710</dt>
8711<dd>
8712
8713
8714 <div class="description">
8715 <p>Loads the audio file sprites pool with the desired data given. This method is called by the constructor automatically. 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>
8716 </div>
8717
8718
8719
8720
8721
8722
8723
8724
8725 <h5>Parameters:</h5>
8726
8727
8728<table class="params table table-striped">
8729 <thead>
8730 <tr>
8731
8732 <th style="width:12%; min-width:110px;">Name</th>
8733
8734
8735 <th style="width:12%; min-width:110px;">Type</th>
8736
8737
8738
8739
8740
8741 <th class="last" style="min-width:310px;">Description</th>
8742 </tr>
8743 </thead>
8744
8745 <tbody>
8746
8747
8748 <tr>
8749
8750 <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>
8751
8752
8753 <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;">
8754
8755
8756<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.DATA_OBJECT">CB_AudioFileSpritesPool.DATA_OBJECT</a></span>
8757
8758
8759
8760
8761 </td>
8762
8763
8764
8765
8766
8767 <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 file sprites.</p></td>
8768 </tr>
8769
8770
8771 </tbody>
8772</table>
8773
8774
8775
8776
8777<dl class="details">
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
8808 <dd class="tag-source">
8809 <ul class="dummy">
8810 <li>
8811 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
8812 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-365">line 365</a>
8813 </li>
8814 </ul>
8815 </dd>
8816
8817
8818
8819
8820
8821
8822
8823</dl>
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837 <h5>Returns:</h5>
8838
8839
8840<div class="param-desc">
8841 <p>If a &quot;dataObject&quot; is given, it returns the current <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object. Otherwise, it returns null.</p>
8842</div>
8843
8844
8845
8846<dl>
8847 <dt>
8848 Type
8849 </dt>
8850 <dd>
8851
8852<span class="param-type"><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></span>
8853|
8854
8855<span class="param-type">null</span>
8856
8857
8858
8859 </dd>
8860</dl>
8861
8862
8863
8864
8865
8866</dd>
8867
8868
8869
8870<hr>
8871<dt>
8872 <h4 class="name" id="muteAll"><span class="type-signature"></span>muteAll<span class="signature">( [onMute] [, audioFiles])</span><span class="type-signature"> &rarr; {integer}</span></h4>
8873
8874
8875</dt>
8876<dd>
8877
8878
8879 <div class="description">
8880 <p>Mutes all the existing <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects or the desired ones (if provided). Uses the <a href="CB_AudioFileSprites.html#muteAll"><code>CB_AudioFileSprites#muteAll</code></a> method internally.</p>
8881 </div>
8882
8883
8884
8885
8886
8887
8888
8889
8890 <h5>Parameters:</h5>
8891
8892
8893<table class="params table table-striped">
8894 <thead>
8895 <tr>
8896
8897 <th style="width:12%; min-width:110px;">Name</th>
8898
8899
8900 <th style="width:12%; min-width:110px;">Type</th>
8901
8902
8903 <th style="width:12%; min-width:110px;">Argument</th>
8904
8905
8906
8907 <th style="width:12%; min-width:110px;">Default</th>
8908
8909
8910 <th class="last" style="min-width:310px;">Description</th>
8911 </tr>
8912 </thead>
8913
8914 <tbody>
8915
8916
8917 <tr>
8918
8919 <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>onMute</code></td>
8920
8921
8922 <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;">
8923
8924
8925<span class="param-type">function</span>
8926
8927
8928
8929
8930 </td>
8931
8932
8933 <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;">
8934
8935 &lt;optional><br>
8936
8937
8938
8939
8940
8941 </td>
8942
8943
8944
8945 <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;">
8946
8947 </td>
8948
8949
8950 <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 &quot;onMute&quot; parameter when calling the <a href="CB_AudioFileSprites.html#muteAll"><code>CB_AudioFileSprites#muteAll</code></a> method internally.</p></td>
8951 </tr>
8952
8953
8954
8955 <tr>
8956
8957 <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>audioFiles</code></td>
8958
8959
8960 <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;">
8961
8962
8963<span class="param-type">array</span>
8964
8965
8966
8967
8968 </td>
8969
8970
8971 <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;">
8972
8973 &lt;optional><br>
8974
8975
8976
8977
8978
8979 </td>
8980
8981
8982
8983 <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;">
8984
8985 <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a>
8986
8987 </td>
8988
8989
8990 <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 &quot;audioFiles&quot; parameter when calling the <a href="CB_AudioFileSprites.html#muteAll"><code>CB_AudioFileSprites#muteAll</code></a> method internally.</p></td>
8991 </tr>
8992
8993
8994 </tbody>
8995</table>
8996
8997
8998
8999
9000<dl class="details">
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
9031 <dd class="tag-source">
9032 <ul class="dummy">
9033 <li>
9034 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
9035 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1239">line 1239</a>
9036 </li>
9037 </ul>
9038 </dd>
9039
9040
9041
9042
9043
9044
9045
9046</dl>
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060 <h5>Returns:</h5>
9061
9062
9063<div class="param-desc">
9064 <p>Returns the number of calls to the <a href="CB_AudioFile.html#mute"><code>CB_AudioFile#mute</code></a> method that were performed.</p>
9065</div>
9066
9067
9068
9069<dl>
9070 <dt>
9071 Type
9072 </dt>
9073 <dd>
9074
9075<span class="param-type">integer</span>
9076
9077
9078
9079 </dd>
9080</dl>
9081
9082
9083
9084
9085
9086</dd>
9087
9088
9089
9090<hr>
9091<dt>
9092 <h4 class="name" id="pauseAll"><span class="type-signature"></span>pauseAll<span class="signature">( [onPause] [, audioFiles])</span><span class="type-signature"> &rarr; {integer}</span></h4>
9093
9094
9095</dt>
9096<dd>
9097
9098
9099 <div class="description">
9100 <p>Tries to pause all the existing <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects or the desired ones (if provided), which are being played, by calling their <a href="CB_AudioFile.html#pause"><code>CB_AudioFile#pause</code></a> method internally. Uses the <a href="CB_AudioFileSprites.html#pauseAll"><code>CB_AudioFileSprites#pauseAll</code></a> method internally.</p>
9101 </div>
9102
9103
9104
9105
9106
9107
9108
9109
9110 <h5>Parameters:</h5>
9111
9112
9113<table class="params table table-striped">
9114 <thead>
9115 <tr>
9116
9117 <th style="width:12%; min-width:110px;">Name</th>
9118
9119
9120 <th style="width:12%; min-width:110px;">Type</th>
9121
9122
9123 <th style="width:12%; min-width:110px;">Argument</th>
9124
9125
9126
9127 <th style="width:12%; min-width:110px;">Default</th>
9128
9129
9130 <th class="last" style="min-width:310px;">Description</th>
9131 </tr>
9132 </thead>
9133
9134 <tbody>
9135
9136
9137 <tr>
9138
9139 <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>onPause</code></td>
9140
9141
9142 <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;">
9143
9144
9145<span class="param-type">function</span>
9146
9147
9148
9149
9150 </td>
9151
9152
9153 <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;">
9154
9155 &lt;optional><br>
9156
9157
9158
9159
9160
9161 </td>
9162
9163
9164
9165 <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;">
9166
9167 </td>
9168
9169
9170 <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 &quot;onPause&quot; parameter when calling the <a href="CB_AudioFileSprites.html#pauseAll"><code>CB_AudioFileSprites#pauseAll</code></a> method internally.</p></td>
9171 </tr>
9172
9173
9174
9175 <tr>
9176
9177 <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>audioFiles</code></td>
9178
9179
9180 <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;">
9181
9182
9183<span class="param-type">array</span>
9184
9185
9186
9187
9188 </td>
9189
9190
9191 <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;">
9192
9193 &lt;optional><br>
9194
9195
9196
9197
9198
9199 </td>
9200
9201
9202
9203 <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;">
9204
9205 <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a>
9206
9207 </td>
9208
9209
9210 <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 &quot;audioFiles&quot; parameter when calling the <a href="CB_AudioFileSprites.html#pauseAll"><code>CB_AudioFileSprites#pauseAll</code></a> method internally.</p></td>
9211 </tr>
9212
9213
9214 </tbody>
9215</table>
9216
9217
9218
9219
9220<dl class="details">
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
9251 <dd class="tag-source">
9252 <ul class="dummy">
9253 <li>
9254 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
9255 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1198">line 1198</a>
9256 </li>
9257 </ul>
9258 </dd>
9259
9260
9261
9262
9263
9264
9265
9266</dl>
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280 <h5>Returns:</h5>
9281
9282
9283<div class="param-desc">
9284 <p>Returns the number of calls to the <a href="CB_AudioFile.html#pause"><code>CB_AudioFile#pause</code></a> method that were performed.</p>
9285</div>
9286
9287
9288
9289<dl>
9290 <dt>
9291 Type
9292 </dt>
9293 <dd>
9294
9295<span class="param-type">integer</span>
9296
9297
9298
9299 </dd>
9300</dl>
9301
9302
9303
9304
9305
9306</dd>
9307
9308
9309
9310<hr>
9311<dt>
9312 <h4 class="name" id="playAll"><span class="type-signature"></span>playAll<span class="signature">( [startAt] [, stopAt] [, loop] [, volume] [, avoidDelayedPlay] [, allowedRecursiveDelay] [, onPlayStart] [, onStop] [, includingPlaying])</span><span class="type-signature"> &rarr; {integer}</span></h4>
9313
9314
9315</dt>
9316<dd>
9317
9318
9319 <div class="description">
9320 <p>Tries to play all the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects by calling their <a href="CB_AudioFile.html#play"><code>CB_AudioFile#play</code></a> method internally. 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). Uses the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p>
9321 </div>
9322
9323
9324
9325
9326
9327
9328
9329
9330 <h5>Parameters:</h5>
9331
9332
9333<table class="params table table-striped">
9334 <thead>
9335 <tr>
9336
9337 <th style="width:12%; min-width:110px;">Name</th>
9338
9339
9340 <th style="width:12%; min-width:110px;">Type</th>
9341
9342
9343 <th style="width:12%; min-width:110px;">Argument</th>
9344
9345
9346
9347 <th style="width:12%; min-width:110px;">Default</th>
9348
9349
9350 <th class="last" style="min-width:310px;">Description</th>
9351 </tr>
9352 </thead>
9353
9354 <tbody>
9355
9356
9357 <tr>
9358
9359 <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>startAt</code></td>
9360
9361
9362 <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;">
9363
9364
9365<span class="param-type">number</span>
9366
9367
9368
9369
9370 </td>
9371
9372
9373 <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;">
9374
9375 &lt;optional><br>
9376
9377
9378
9379
9380
9381 </td>
9382
9383
9384
9385 <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;">
9386
9387 0 | <a href="CB_AudioFile_API.WAAPI.html#lastStartAt"><code>CB_AudioFile_API.WAAPI#lastStartAt</code></a> | <a href="CB_AudioFile_API.SM2.html#lastStartAt"><code>CB_AudioFile_API.SM2#lastStartAt</code></a> | <a href="CB_AudioFile_API.ACMP.html#lastStartAt"><code>CB_AudioFile_API.ACMP#lastStartAt</code></a> | <a href="CB_AudioFile_API.AAPI.html#lastStartAt"><code>CB_AudioFile_API.AAPI#lastStartAt</code></a> | stopAt
9388
9389 </td>
9390
9391
9392 <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 &quot;startAt&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p></td>
9393 </tr>
9394
9395
9396
9397 <tr>
9398
9399 <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>stopAt</code></td>
9400
9401
9402 <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;">
9403
9404
9405<span class="param-type">number</span>
9406
9407
9408
9409
9410 </td>
9411
9412
9413 <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;">
9414
9415 &lt;optional><br>
9416
9417
9418
9419
9420
9421 </td>
9422
9423
9424
9425 <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;">
9426
9427 <a href="CB_AudioFile_API.WAAPI.html#getDuration"><code>CB_AudioFile_API.WAAPI#getDuration</code></a>() | <a href="CB_AudioFile_API.SM2.html#getDuration"><code>CB_AudioFile_API.SM2#getDuration</code></a>() | <a href="CB_AudioFile_API.ACMP.html#getDuration"><code>CB_AudioFile_API.ACMP#getDuration</code></a>() | <a href="CB_AudioFile_API.AAPI.html#getDuration"><code>CB_AudioFile_API.AAPI#getDuration</code></a>()
9428
9429 </td>
9430
9431
9432 <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 &quot;stopAt&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p></td>
9433 </tr>
9434
9435
9436
9437 <tr>
9438
9439 <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>loop</code></td>
9440
9441
9442 <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;">
9443
9444
9445<span class="param-type">boolean</span>
9446
9447
9448
9449
9450 </td>
9451
9452
9453 <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;">
9454
9455 &lt;optional><br>
9456
9457
9458
9459
9460
9461 </td>
9462
9463
9464
9465 <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;">
9466
9467 <a href="CB_AudioFile.html#loop"><code>CB_AudioFile#loop</code></a>
9468
9469 </td>
9470
9471
9472 <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 &quot;loop&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p></td>
9473 </tr>
9474
9475
9476
9477 <tr>
9478
9479 <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>volume</code></td>
9480
9481
9482 <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;">
9483
9484
9485<span class="param-type">number</span>
9486
9487
9488
9489
9490 </td>
9491
9492
9493 <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;">
9494
9495 &lt;optional><br>
9496
9497
9498
9499
9500
9501 </td>
9502
9503
9504
9505 <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;">
9506
9507 CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_DEFAULT ? CB_Speaker.getVolume() : CB_Configuration.CrossBase.CB_Speaker_DEFAULT_VOLUME
9508
9509 </td>
9510
9511
9512 <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 &quot;volume&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p></td>
9513 </tr>
9514
9515
9516
9517 <tr>
9518
9519 <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>avoidDelayedPlay</code></td>
9520
9521
9522 <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;">
9523
9524
9525<span class="param-type">boolean</span>
9526
9527
9528
9529
9530 </td>
9531
9532
9533 <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;">
9534
9535 &lt;optional><br>
9536
9537
9538
9539
9540
9541 </td>
9542
9543
9544
9545 <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;">
9546
9547 false
9548
9549 </td>
9550
9551
9552 <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 &quot;avoidDelayedPlay&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p></td>
9553 </tr>
9554
9555
9556
9557 <tr>
9558
9559 <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>allowedRecursiveDelay</code></td>
9560
9561
9562 <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;">
9563
9564
9565<span class="param-type">boolean</span>
9566
9567
9568
9569
9570 </td>
9571
9572
9573 <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;">
9574
9575 &lt;optional><br>
9576
9577
9578
9579
9580
9581 </td>
9582
9583
9584
9585 <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;">
9586
9587 <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_ALLOWED_RECURSIVE_DELAY_DEFAULT"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_ALLOWED_RECURSIVE_DELAY_DEFAULT</code></a>
9588
9589 </td>
9590
9591
9592 <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 &quot;allowedRecursiveDelay&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p></td>
9593 </tr>
9594
9595
9596
9597 <tr>
9598
9599 <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>onPlayStart</code></td>
9600
9601
9602 <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;">
9603
9604
9605<span class="param-type">function</span>
9606
9607
9608
9609
9610 </td>
9611
9612
9613 <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;">
9614
9615 &lt;optional><br>
9616
9617
9618
9619
9620
9621 </td>
9622
9623
9624
9625 <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;">
9626
9627 </td>
9628
9629
9630 <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 &quot;onPlayStart&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p></td>
9631 </tr>
9632
9633
9634
9635 <tr>
9636
9637 <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>onStop</code></td>
9638
9639
9640 <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;">
9641
9642
9643<span class="param-type">function</span>
9644
9645
9646
9647
9648 </td>
9649
9650
9651 <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;">
9652
9653 &lt;optional><br>
9654
9655
9656
9657
9658
9659 </td>
9660
9661
9662
9663 <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;">
9664
9665 </td>
9666
9667
9668 <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 &quot;onStop&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p></td>
9669 </tr>
9670
9671
9672
9673 <tr>
9674
9675 <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>includingPlaying</code></td>
9676
9677
9678 <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;">
9679
9680
9681<span class="param-type">boolean</span>
9682
9683
9684
9685
9686 </td>
9687
9688
9689 <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;">
9690
9691 &lt;optional><br>
9692
9693
9694
9695
9696
9697 </td>
9698
9699
9700
9701 <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;">
9702
9703 false
9704
9705 </td>
9706
9707
9708 <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 &quot;includingPlaying&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAll"><code>CB_AudioFileSprites#playAll</code></a> method internally.</p></td>
9709 </tr>
9710
9711
9712 </tbody>
9713</table>
9714
9715
9716
9717
9718<dl class="details">
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
9749 <dd class="tag-source">
9750 <ul class="dummy">
9751 <li>
9752 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
9753 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1145">line 1145</a>
9754 </li>
9755 </ul>
9756 </dd>
9757
9758
9759
9760
9761
9762
9763
9764</dl>
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778 <h5>Returns:</h5>
9779
9780
9781<div class="param-desc">
9782 <p>Returns the number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose <a href="CB_AudioFile.html#play"><code>CB_AudioFile#play</code></a> method did not return the value of &quot;-1&quot; (this does not mean necessarily that they could be played successfully).</p>
9783</div>
9784
9785
9786
9787<dl>
9788 <dt>
9789 Type
9790 </dt>
9791 <dd>
9792
9793<span class="param-type">integer</span>
9794
9795
9796
9797 </dd>
9798</dl>
9799
9800
9801
9802
9803
9804</dd>
9805
9806
9807
9808<hr>
9809<dt>
9810 <h4 class="name" id="playAndStopAll"><span class="type-signature"></span>playAndStopAll<span class="signature">( [includingPlaying] [, delayBeforeStop])</span><span class="type-signature"> &rarr; {integer}</span></h4>
9811
9812
9813</dt>
9814<dd>
9815
9816
9817 <div class="description">
9818 <p>Plays silently and stops all <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects after a desired time. It can be useful for some clients which need the <a href="CB_AudioFile.html#play"><code>CB_AudioFile#play</code></a> method to be called through a user-driven event (as onClick, onTouch, etc.). Internally, it calls <a href="CB_AudioFileCache.html#playAll"><code>CB_AudioFileCache#playAll</code></a>(0, null, false, 0, true, null, null, null, includingPlaying) and, after a desired delay, calls the <a href="CB_AudioFileCache.html#stopAll"><code>CB_AudioFileCache#stopAll</code></a> method. Uses the <a href="CB_AudioFileSprites.html#playAndStopAll"><code>CB_AudioFileSprites#playAndStopAll</code></a> method internally.</p>
9819 </div>
9820
9821
9822
9823
9824
9825
9826
9827
9828 <h5>Parameters:</h5>
9829
9830
9831<table class="params table table-striped">
9832 <thead>
9833 <tr>
9834
9835 <th style="width:12%; min-width:110px;">Name</th>
9836
9837
9838 <th style="width:12%; min-width:110px;">Type</th>
9839
9840
9841 <th style="width:12%; min-width:110px;">Argument</th>
9842
9843
9844
9845 <th style="width:12%; min-width:110px;">Default</th>
9846
9847
9848 <th class="last" style="min-width:310px;">Description</th>
9849 </tr>
9850 </thead>
9851
9852 <tbody>
9853
9854
9855 <tr>
9856
9857 <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>includingPlaying</code></td>
9858
9859
9860 <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;">
9861
9862
9863<span class="param-type">boolean</span>
9864
9865
9866
9867
9868 </td>
9869
9870
9871 <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;">
9872
9873 &lt;optional><br>
9874
9875
9876
9877
9878
9879 </td>
9880
9881
9882
9883 <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;">
9884
9885 false
9886
9887 </td>
9888
9889
9890 <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 &quot;includingPlaying&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAndStopAll"><code>CB_AudioFileSprites#playAndStopAll</code></a> method internally.</p></td>
9891 </tr>
9892
9893
9894
9895 <tr>
9896
9897 <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>delayBeforeStop</code></td>
9898
9899
9900 <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;">
9901
9902
9903<span class="param-type">number</span>
9904
9905
9906
9907
9908 </td>
9909
9910
9911 <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;">
9912
9913 &lt;optional><br>
9914
9915
9916
9917
9918
9919 </td>
9920
9921
9922
9923 <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;">
9924
9925 100
9926
9927 </td>
9928
9929
9930 <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 &quot;delayBeforeStop&quot; parameter when calling the <a href="CB_AudioFileSprites.html#playAndStopAll"><code>CB_AudioFileSprites#playAndStopAll</code></a> method internally.</p></td>
9931 </tr>
9932
9933
9934 </tbody>
9935</table>
9936
9937
9938
9939
9940<dl class="details">
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
9971 <dd class="tag-source">
9972 <ul class="dummy">
9973 <li>
9974 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
9975 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1180">line 1180</a>
9976 </li>
9977 </ul>
9978 </dd>
9979
9980
9981
9982
9983
9984
9985
9986</dl>
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000 <h5>Returns:</h5>
10001
10002
10003<div class="param-desc">
10004 <p>Returns the number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects whose <a href="CB_AudioFile.html#play"><code>CB_AudioFile#play</code></a> method did not return the value of &quot;-1&quot; (this does not mean necessarily that they could be played successfully).</p>
10005</div>
10006
10007
10008
10009<dl>
10010 <dt>
10011 Type
10012 </dt>
10013 <dd>
10014
10015<span class="param-type">integer</span>
10016
10017
10018
10019 </dd>
10020</dl>
10021
10022
10023
10024
10025
10026</dd>
10027
10028
10029
10030<hr>
10031<dt>
10032 <h4 class="name" id="purge"><span class="type-signature"></span>purge<span class="signature">(desiredNumber [, setAsMinimumAudioFiles] [, includePlaying] [, stopSounds] [, statuses])</span><span class="type-signature"> &rarr; {integer}</span></h4>
10033
10034
10035</dt>
10036<dd>
10037
10038
10039 <div class="description">
10040 <p>Tries to purge the audio file cache of each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object until it reaches a desired number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects internally (set in the <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a> property), by removing and destroying some of the current <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects. Note that the desired number is for each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object and not a global number. For performance purposes. Uses the <a href="CB_AudioFileSprites.html#purge"><code>CB_AudioFileSprites#purge</code></a> method internally.</p>
10041 </div>
10042
10043
10044
10045
10046
10047
10048
10049
10050 <h5>Parameters:</h5>
10051
10052
10053<table class="params table table-striped">
10054 <thead>
10055 <tr>
10056
10057 <th style="width:12%; min-width:110px;">Name</th>
10058
10059
10060 <th style="width:12%; min-width:110px;">Type</th>
10061
10062
10063 <th style="width:12%; min-width:110px;">Argument</th>
10064
10065
10066
10067 <th style="width:12%; min-width:110px;">Default</th>
10068
10069
10070 <th class="last" style="min-width:310px;">Description</th>
10071 </tr>
10072 </thead>
10073
10074 <tbody>
10075
10076
10077 <tr>
10078
10079 <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>desiredNumber</code></td>
10080
10081
10082 <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;">
10083
10084
10085<span class="param-type">integer</span>
10086
10087
10088
10089
10090 </td>
10091
10092
10093 <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;">
10094
10095
10096
10097
10098
10099 </td>
10100
10101
10102
10103 <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;">
10104
10105 </td>
10106
10107
10108 <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 &quot;desiredNumber&quot; parameter when calling the <a href="CB_AudioFileSprites.html#purge"><code>CB_AudioFileSprites#purge</code></a> method internally. Note that the desired number is for each <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object and not a global number.</p></td>
10109 </tr>
10110
10111
10112
10113 <tr>
10114
10115 <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>setAsMinimumAudioFiles</code></td>
10116
10117
10118 <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;">
10119
10120
10121<span class="param-type">boolean</span>
10122
10123
10124
10125
10126 </td>
10127
10128
10129 <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;">
10130
10131 &lt;optional><br>
10132
10133
10134
10135
10136
10137 </td>
10138
10139
10140
10141 <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;">
10142
10143 false
10144
10145 </td>
10146
10147
10148 <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 &quot;setAsMinimumAudioFiles&quot; parameter when calling the <a href="CB_AudioFileSprites.html#purge"><code>CB_AudioFileSprites#purge</code></a> method internally.</p></td>
10149 </tr>
10150
10151
10152
10153 <tr>
10154
10155 <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>includePlaying</code></td>
10156
10157
10158 <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;">
10159
10160
10161<span class="param-type">boolean</span>
10162
10163
10164
10165
10166 </td>
10167
10168
10169 <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;">
10170
10171 &lt;optional><br>
10172
10173
10174
10175
10176
10177 </td>
10178
10179
10180
10181 <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;">
10182
10183 false
10184
10185 </td>
10186
10187
10188 <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 &quot;includePlaying&quot; parameter when calling the <a href="CB_AudioFileSprites.html#purge"><code>CB_AudioFileSprites#purge</code></a> method internally.</p></td>
10189 </tr>
10190
10191
10192
10193 <tr>
10194
10195 <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>stopSounds</code></td>
10196
10197
10198 <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;">
10199
10200
10201<span class="param-type">boolean</span>
10202
10203
10204
10205
10206 </td>
10207
10208
10209 <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;">
10210
10211 &lt;optional><br>
10212
10213
10214
10215
10216
10217 </td>
10218
10219
10220
10221 <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;">
10222
10223 false
10224
10225 </td>
10226
10227
10228 <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 &quot;stopSounds&quot; parameter when calling the <a href="CB_AudioFileSprites.html#purge"><code>CB_AudioFileSprites#purge</code></a> method internally.</p></td>
10229 </tr>
10230
10231
10232
10233 <tr>
10234
10235 <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>statuses</code></td>
10236
10237
10238 <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;">
10239
10240
10241<span class="param-type">array</span>
10242
10243
10244
10245
10246 </td>
10247
10248
10249 <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;">
10250
10251 &lt;optional><br>
10252
10253
10254
10255
10256
10257 </td>
10258
10259
10260
10261 <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;">
10262
10263 Array(<a href="CB_AudioFile.html#.LOADING"><code>CB_AudioFile.LOADING</code></a>, <a href="CB_AudioFile.html#.UNCHECKED"><code>CB_AudioFile.UNCHECKED</code></a>, <a href="CB_AudioFile.html#.CHECKING"><code>CB_AudioFile.CHECKING</code></a>, <a href="CB_AudioFile.html#.LOADED"><code>CB_AudioFile.LOADED</code></a>)
10264
10265 </td>
10266
10267
10268 <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 &quot;statuses&quot; parameter when calling the <a href="CB_AudioFileSprites.html#purge"><code>CB_AudioFileSprites#purge</code></a> method internally.</p></td>
10269 </tr>
10270
10271
10272 </tbody>
10273</table>
10274
10275
10276
10277
10278<dl class="details">
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
10309 <dd class="tag-source">
10310 <ul class="dummy">
10311 <li>
10312 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
10313 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-831">line 831</a>
10314 </li>
10315 </ul>
10316 </dd>
10317
10318
10319
10320
10321
10322
10323
10324</dl>
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338 <h5>Returns:</h5>
10339
10340
10341<div class="param-desc">
10342 <p>Returns the number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects removed.</p>
10343</div>
10344
10345
10346
10347<dl>
10348 <dt>
10349 Type
10350 </dt>
10351 <dd>
10352
10353<span class="param-type">integer</span>
10354
10355
10356
10357 </dd>
10358</dl>
10359
10360
10361
10362
10363
10364</dd>
10365
10366
10367
10368<hr>
10369<dt>
10370 <h4 class="name" id="removeSpritesGroup"><span class="type-signature"></span>removeSpritesGroup<span class="signature">(spritesGroupId [, destroy] [, stopSounds] [, preventAbortedStatus])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
10371
10372
10373</dt>
10374<dd>
10375
10376
10377 <div class="description">
10378 <p>Removes a sprites group by its ID.</p>
10379 </div>
10380
10381
10382
10383
10384
10385
10386
10387
10388 <h5>Parameters:</h5>
10389
10390
10391<table class="params table table-striped">
10392 <thead>
10393 <tr>
10394
10395 <th style="width:12%; min-width:110px;">Name</th>
10396
10397
10398 <th style="width:12%; min-width:110px;">Type</th>
10399
10400
10401 <th style="width:12%; min-width:110px;">Argument</th>
10402
10403
10404
10405 <th style="width:12%; min-width:110px;">Default</th>
10406
10407
10408 <th class="last" style="min-width:310px;">Description</th>
10409 </tr>
10410 </thead>
10411
10412 <tbody>
10413
10414
10415 <tr>
10416
10417 <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>spritesGroupId</code></td>
10418
10419
10420 <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;">
10421
10422
10423<span class="param-type">string</span>
10424
10425
10426
10427
10428 </td>
10429
10430
10431 <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;">
10432
10433
10434
10435
10436
10437 </td>
10438
10439
10440
10441 <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;">
10442
10443 </td>
10444
10445
10446 <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>The identifier for the sprites group.</p></td>
10447 </tr>
10448
10449
10450
10451 <tr>
10452
10453 <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>destroy</code></td>
10454
10455
10456 <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;">
10457
10458
10459<span class="param-type">boolean</span>
10460
10461
10462
10463
10464 </td>
10465
10466
10467 <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;">
10468
10469 &lt;optional><br>
10470
10471
10472
10473
10474
10475 </td>
10476
10477
10478
10479 <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;">
10480
10481 false
10482
10483 </td>
10484
10485
10486 <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>If set to true, it will call the <a href="CB_AudioFileSprites.html#destructor"><code>CB_AudioFileSprites#destructor</code></a> method of the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object which belongs to the desired sprites group.</p></td>
10487 </tr>
10488
10489
10490
10491 <tr>
10492
10493 <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>stopSounds</code></td>
10494
10495
10496 <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;">
10497
10498
10499<span class="param-type">boolean</span>
10500
10501
10502
10503
10504 </td>
10505
10506
10507 <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;">
10508
10509 &lt;optional><br>
10510
10511
10512
10513
10514
10515 </td>
10516
10517
10518
10519 <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;">
10520
10521 false
10522
10523 </td>
10524
10525
10526 <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>If the &quot;destroy&quot; parameter is set to false, this parameter will be ignored. Used as the &quot;stopSound&quot; parameter when calling internally the <a href="CB_AudioFileSprites.html#destructor"><code>CB_AudioFileSprites#destructor</code></a> method of the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object which belongs to the desired sprites group.</p></td>
10527 </tr>
10528
10529
10530
10531 <tr>
10532
10533 <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>preventAbortedStatus</code></td>
10534
10535
10536 <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;">
10537
10538
10539<span class="param-type">boolean</span>
10540
10541
10542
10543
10544 </td>
10545
10546
10547 <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;">
10548
10549 &lt;optional><br>
10550
10551
10552
10553
10554
10555 </td>
10556
10557
10558
10559 <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;">
10560
10561 false
10562
10563 </td>
10564
10565
10566 <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>If the &quot;destroy&quot; parameter is set to false, this parameter will be ignored. Used as the &quot;preventAbortedStatus&quot; parameter when calling internally the <a href="CB_AudioFileSprites.html#destructor"><code>CB_AudioFileSprites#destructor</code></a> method of the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object which belongs to the desired sprites group.</p></td>
10567 </tr>
10568
10569
10570 </tbody>
10571</table>
10572
10573
10574
10575
10576<dl class="details">
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
10607 <dd class="tag-source">
10608 <ul class="dummy">
10609 <li>
10610 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
10611 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-573">line 573</a>
10612 </li>
10613 </ul>
10614 </dd>
10615
10616
10617
10618
10619
10620
10621
10622</dl>
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636 <h5>Returns:</h5>
10637
10638
10639<div class="param-desc">
10640 <p>Returns true if the sprites group has been deleted or false otherwise.</p>
10641</div>
10642
10643
10644
10645<dl>
10646 <dt>
10647 Type
10648 </dt>
10649 <dd>
10650
10651<span class="param-type">boolean</span>
10652
10653
10654
10655 </dd>
10656</dl>
10657
10658
10659
10660
10661
10662</dd>
10663
10664
10665
10666<hr>
10667<dt>
10668 <h4 class="name" id="removeSpritesGroups"><span class="type-signature"></span>removeSpritesGroups<span class="signature">()</span><span class="type-signature"></span></h4>
10669
10670
10671</dt>
10672<dd>
10673
10674
10675 <div class="description">
10676 <p>Removes all the sprites groups (<a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> objects) by clearing the <a href="CB_AudioFileSpritesPool.html#audioFileSprites"><code>CB_AudioFileSpritesPool#audioFileSprites</code></a> property.</p>
10677 </div>
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688<dl class="details">
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
10719 <dd class="tag-source">
10720 <ul class="dummy">
10721 <li>
10722 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
10723 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-458">line 458</a>
10724 </li>
10725 </ul>
10726 </dd>
10727
10728
10729
10730
10731
10732
10733
10734</dl>
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750</dd>
10751
10752
10753
10754<hr>
10755<dt>
10756 <h4 class="name" id="resumeAll"><span class="type-signature"></span>resumeAll<span class="signature">( [loop] [, allowedRecursiveDelay] [, allowedRecursiveDelaySkipping] [, onPlayStart] [, onStop] [, audioFiles] [, spriteId])</span><span class="type-signature"> &rarr; {Object}</span></h4>
10757
10758
10759</dt>
10760<dd>
10761
10762
10763 <div class="description">
10764 <p>Resumes all the existing <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects or the desired ones (if provided), which are paused (and not stopped). Can be focused on just one sprite ID if desired. Uses the <a href="CB_AudioFileSprites.html#resumeAll"><code>CB_AudioFileSprites#resumeAll</code></a> method internally. Internal usage only recommended. To resume a sprite, better use the <a href="CB_AudioFileSprites.html#resumeSprite"><code>CB_AudioFileSprites#resumeSprite</code></a> method instead.</p>
10765 </div>
10766
10767
10768
10769
10770
10771
10772
10773
10774 <h5>Parameters:</h5>
10775
10776
10777<table class="params table table-striped">
10778 <thead>
10779 <tr>
10780
10781 <th style="width:12%; min-width:110px;">Name</th>
10782
10783
10784 <th style="width:12%; min-width:110px;">Type</th>
10785
10786
10787 <th style="width:12%; min-width:110px;">Argument</th>
10788
10789
10790
10791 <th style="width:12%; min-width:110px;">Default</th>
10792
10793
10794 <th class="last" style="min-width:310px;">Description</th>
10795 </tr>
10796 </thead>
10797
10798 <tbody>
10799
10800
10801 <tr>
10802
10803 <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>loop</code></td>
10804
10805
10806 <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;">
10807
10808
10809<span class="param-type">boolean</span>
10810
10811
10812
10813
10814 </td>
10815
10816
10817 <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;">
10818
10819 &lt;optional><br>
10820
10821
10822
10823
10824
10825 </td>
10826
10827
10828
10829 <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;">
10830
10831 <a href="CB_AudioFile.html#loop"><code>CB_AudioFile#loop</code></a>
10832
10833 </td>
10834
10835
10836 <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 &quot;loop&quot; parameter when calling the <a href="CB_AudioFileSprites.html#resumeAll"><code>CB_AudioFileSprites#resumeAll</code></a> method internally.</p></td>
10837 </tr>
10838
10839
10840
10841 <tr>
10842
10843 <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>allowedRecursiveDelay</code></td>
10844
10845
10846 <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;">
10847
10848
10849<span class="param-type">boolean</span>
10850
10851
10852
10853
10854 </td>
10855
10856
10857 <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;">
10858
10859 &lt;optional><br>
10860
10861
10862
10863
10864
10865 </td>
10866
10867
10868
10869 <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;">
10870
10871 <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_ALLOWED_RECURSIVE_DELAY_DEFAULT"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_ALLOWED_RECURSIVE_DELAY_DEFAULT</code></a>
10872
10873 </td>
10874
10875
10876 <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 &quot;allowedRecursiveDelay&quot; parameter when calling the <a href="CB_AudioFileSprites.html#resumeAll"><code>CB_AudioFileSprites#resumeAll</code></a> method internally.</p></td>
10877 </tr>
10878
10879
10880
10881 <tr>
10882
10883 <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>allowedRecursiveDelaySkipping</code></td>
10884
10885
10886 <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;">
10887
10888
10889<span class="param-type">boolean</span>
10890
10891
10892
10893
10894 </td>
10895
10896
10897 <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;">
10898
10899 &lt;optional><br>
10900
10901
10902
10903
10904
10905 </td>
10906
10907
10908
10909 <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;">
10910
10911 stopAt-startAt
10912
10913 </td>
10914
10915
10916 <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 &quot;allowedRecursiveDelaySkipping&quot; parameter when calling the <a href="CB_AudioFileSprites.html#resumeAll"><code>CB_AudioFileSprites#resumeAll</code></a> method internally.</p></td>
10917 </tr>
10918
10919
10920
10921 <tr>
10922
10923 <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>onPlayStart</code></td>
10924
10925
10926 <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;">
10927
10928
10929<span class="param-type">function</span>
10930
10931
10932
10933
10934 </td>
10935
10936
10937 <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;">
10938
10939 &lt;optional><br>
10940
10941
10942
10943
10944
10945 </td>
10946
10947
10948
10949 <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;">
10950
10951 </td>
10952
10953
10954 <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 &quot;onPlayStart&quot; parameter when calling the <a href="CB_AudioFileSprites.html#resumeAll"><code>CB_AudioFileSprites#resumeAll</code></a> method internally.</p></td>
10955 </tr>
10956
10957
10958
10959 <tr>
10960
10961 <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>onStop</code></td>
10962
10963
10964 <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;">
10965
10966
10967<span class="param-type">function</span>
10968
10969
10970
10971
10972 </td>
10973
10974
10975 <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;">
10976
10977 &lt;optional><br>
10978
10979
10980
10981
10982
10983 </td>
10984
10985
10986
10987 <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;">
10988
10989 </td>
10990
10991
10992 <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 &quot;onStop&quot; parameter when calling the <a href="CB_AudioFileSprites.html#resumeAll"><code>CB_AudioFileSprites#resumeAll</code></a> method internally.</p></td>
10993 </tr>
10994
10995
10996
10997 <tr>
10998
10999 <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>audioFiles</code></td>
11000
11001
11002 <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;">
11003
11004
11005<span class="param-type">array</span>
11006
11007
11008
11009
11010 </td>
11011
11012
11013 <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;">
11014
11015 &lt;optional><br>
11016
11017
11018
11019
11020
11021 </td>
11022
11023
11024
11025 <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;">
11026
11027 <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a>
11028
11029 </td>
11030
11031
11032 <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 &quot;audioFiles&quot; parameter when calling the <a href="CB_AudioFileSprites.html#resumeAll"><code>CB_AudioFileSprites#resumeAll</code></a> method internally.</p></td>
11033 </tr>
11034
11035
11036
11037 <tr>
11038
11039 <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>spriteId</code></td>
11040
11041
11042 <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;">
11043
11044
11045<span class="param-type">string</span>
11046
11047
11048
11049
11050 </td>
11051
11052
11053 <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;">
11054
11055 &lt;optional><br>
11056
11057
11058
11059
11060
11061 </td>
11062
11063
11064
11065 <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;">
11066
11067 '_WITHOUT_SPRITE_ASSOCIATED'
11068
11069 </td>
11070
11071
11072 <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 &quot;spriteId&quot; when calling the <a href="CB_AudioFileSprites.html#resumeAll"><code>CB_AudioFileSprites#resumeAll</code></a> method internally. Internal usage only recommended.</p></td>
11073 </tr>
11074
11075
11076 </tbody>
11077</table>
11078
11079
11080
11081
11082<dl class="details">
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
11113 <dd class="tag-source">
11114 <ul class="dummy">
11115 <li>
11116 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
11117 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1221">line 1221</a>
11118 </li>
11119 </ul>
11120 </dd>
11121
11122
11123
11124
11125
11126
11127
11128</dl>
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142 <h5>Returns:</h5>
11143
11144
11145<div class="param-desc">
11146 <p>Returns an object whose property names will be the ID of each sprites group and their value will be the returning value of the internal call to the <a href="CB_AudioFileSprites.html#resumeAll"><code>CB_AudioFileSprites#resumeAll</code></a> method.</p>
11147</div>
11148
11149
11150
11151<dl>
11152 <dt>
11153 Type
11154 </dt>
11155 <dd>
11156
11157<span class="param-type">Object</span>
11158
11159
11160
11161 </dd>
11162</dl>
11163
11164
11165
11166
11167
11168</dd>
11169
11170
11171
11172<hr>
11173<dt>
11174 <h4 class="name" id="setAudioAPIAll"><span class="type-signature"></span>setAudioAPIAll<span class="signature">(preferredAPIs [, callbackOk] [, callbackError] [, mandatory] [, forceReload] [, audioFiles])</span><span class="type-signature"> &rarr; {integer}</span></h4>
11175
11176
11177</dt>
11178<dd>
11179
11180
11181 <div class="description">
11182 <p>Tries to change the audio API for all the existing <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects or the desired ones (if provided). This method is not allowed to be called if a previous call to it did not finish yet. The function defined in the &quot;callbackError&quot; parameter, if any, will be called immediately if the method was previously called and it is still running currently. Uses the <a href="CB_AudioFileSprites.html#setAudioAPIAll"><code>CB_AudioFileSprites#setAudioAPIAll</code></a> method internally.</p>
11183 </div>
11184
11185
11186
11187
11188
11189
11190
11191
11192 <h5>Parameters:</h5>
11193
11194
11195<table class="params table table-striped">
11196 <thead>
11197 <tr>
11198
11199 <th style="width:12%; min-width:110px;">Name</th>
11200
11201
11202 <th style="width:12%; min-width:110px;">Type</th>
11203
11204
11205 <th style="width:12%; min-width:110px;">Argument</th>
11206
11207
11208
11209 <th style="width:12%; min-width:110px;">Default</th>
11210
11211
11212 <th class="last" style="min-width:310px;">Description</th>
11213 </tr>
11214 </thead>
11215
11216 <tbody>
11217
11218
11219 <tr>
11220
11221 <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>preferredAPIs</code></td>
11222
11223
11224 <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;">
11225
11226
11227<span class="param-type">array</span>
11228|
11229
11230<span class="param-type">string</span>
11231
11232
11233
11234
11235 </td>
11236
11237
11238 <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;">
11239
11240
11241
11242
11243
11244 </td>
11245
11246
11247
11248 <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;">
11249
11250 </td>
11251
11252
11253 <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 &quot;preferredAPIs&quot; parameter when calling the <a href="CB_AudioFileSprites.html#setAudioAPIAll"><code>CB_AudioFileSprites#setAudioAPIAll</code></a> method internally.</p></td>
11254 </tr>
11255
11256
11257
11258 <tr>
11259
11260 <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>
11261
11262
11263 <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;">
11264
11265
11266<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.setAudioAPIAll_CALLBACK_OK">CB_AudioFileSpritesPool.setAudioAPIAll_CALLBACK_OK</a></span>
11267
11268
11269
11270
11271 </td>
11272
11273
11274 <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;">
11275
11276 &lt;optional><br>
11277
11278
11279
11280
11281
11282 </td>
11283
11284
11285
11286 <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;">
11287
11288 </td>
11289
11290
11291 <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>Function that will be called when all the process was performed successfully, being &quot;this&quot; the <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object.</p></td>
11292 </tr>
11293
11294
11295
11296 <tr>
11297
11298 <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>
11299
11300
11301 <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;">
11302
11303
11304<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.setAudioAPIAll_CALLBACK_ERROR">CB_AudioFileSpritesPool.setAudioAPIAll_CALLBACK_ERROR</a></span>
11305
11306
11307
11308
11309 </td>
11310
11311
11312 <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;">
11313
11314 &lt;optional><br>
11315
11316
11317
11318
11319
11320 </td>
11321
11322
11323
11324 <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;">
11325
11326 </td>
11327
11328
11329 <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>Function that will be called when any error happened, being &quot;this&quot; the <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object. This function will be called immediately if the method was previously called and it is still running currently.</p></td>
11330 </tr>
11331
11332
11333
11334 <tr>
11335
11336 <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>mandatory</code></td>
11337
11338
11339 <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;">
11340
11341
11342<span class="param-type">boolean</span>
11343
11344
11345
11346
11347 </td>
11348
11349
11350 <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;">
11351
11352 &lt;optional><br>
11353
11354
11355
11356
11357
11358 </td>
11359
11360
11361
11362 <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;">
11363
11364 false
11365
11366 </td>
11367
11368
11369 <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 &quot;mandatory&quot; parameter when calling the <a href="CB_AudioFileSprites.html#setAudioAPIAll"><code>CB_AudioFileSprites#setAudioAPIAll</code></a> method internally.</p></td>
11370 </tr>
11371
11372
11373
11374 <tr>
11375
11376 <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>forceReload</code></td>
11377
11378
11379 <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;">
11380
11381
11382<span class="param-type">string</span>
11383
11384
11385
11386
11387 </td>
11388
11389
11390 <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;">
11391
11392 &lt;optional><br>
11393
11394
11395
11396
11397
11398 </td>
11399
11400
11401
11402 <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;">
11403
11404 false
11405
11406 </td>
11407
11408
11409 <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 &quot;forceReload&quot; parameter when calling the <a href="CB_AudioFileSprites.html#setAudioAPIAll"><code>CB_AudioFileSprites#setAudioAPIAll</code></a> method internally.</p></td>
11410 </tr>
11411
11412
11413
11414 <tr>
11415
11416 <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>audioFiles</code></td>
11417
11418
11419 <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;">
11420
11421
11422<span class="param-type">array</span>
11423
11424
11425
11426
11427 </td>
11428
11429
11430 <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;">
11431
11432 &lt;optional><br>
11433
11434
11435
11436
11437
11438 </td>
11439
11440
11441
11442 <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;">
11443
11444 <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a>
11445
11446 </td>
11447
11448
11449 <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 &quot;audioFiles&quot; parameter when calling the <a href="CB_AudioFileSprites.html#setAudioAPIAll"><code>CB_AudioFileSprites#setAudioAPIAll</code></a> method internally.</p></td>
11450 </tr>
11451
11452
11453 </tbody>
11454</table>
11455
11456
11457
11458
11459<dl class="details">
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
11490 <dd class="tag-source">
11491 <ul class="dummy">
11492 <li>
11493 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
11494 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1330">line 1330</a>
11495 </li>
11496 </ul>
11497 </dd>
11498
11499
11500
11501
11502
11503
11504
11505</dl>
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519 <h5>Returns:</h5>
11520
11521
11522<div class="param-desc">
11523 <p>Returns the number of calls to the <a href="CB_AudioFile.html#setAudioAPI"><code>CB_AudioFile#setAudioAPI</code></a> method that were performed.</p>
11524</div>
11525
11526
11527
11528<dl>
11529 <dt>
11530 Type
11531 </dt>
11532 <dd>
11533
11534<span class="param-type">integer</span>
11535
11536
11537
11538 </dd>
11539</dl>
11540
11541
11542
11543
11544
11545</dd>
11546
11547
11548
11549<hr>
11550<dt>
11551 <h4 class="name" id="setVolumeAll"><span class="type-signature"></span>setVolumeAll<span class="signature">( [volume] [, forceSetVolumeProperty] [, onSetVolume] [, audioFiles])</span><span class="type-signature"> &rarr; {integer}</span></h4>
11552
11553
11554</dt>
11555<dd>
11556
11557
11558 <div class="description">
11559 <p>Sets the same volume for all the existing <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects or the desired ones (if provided). Uses the <a href="CB_AudioFileSprites.html#setVolumeAll"><code>CB_AudioFileSprites#setVolumeAll</code></a> method internally.</p>
11560 </div>
11561
11562
11563
11564
11565
11566
11567
11568
11569 <h5>Parameters:</h5>
11570
11571
11572<table class="params table table-striped">
11573 <thead>
11574 <tr>
11575
11576 <th style="width:12%; min-width:110px;">Name</th>
11577
11578
11579 <th style="width:12%; min-width:110px;">Type</th>
11580
11581
11582 <th style="width:12%; min-width:110px;">Argument</th>
11583
11584
11585
11586 <th style="width:12%; min-width:110px;">Default</th>
11587
11588
11589 <th class="last" style="min-width:310px;">Description</th>
11590 </tr>
11591 </thead>
11592
11593 <tbody>
11594
11595
11596 <tr>
11597
11598 <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>volume</code></td>
11599
11600
11601 <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;">
11602
11603
11604<span class="param-type">number</span>
11605
11606
11607
11608
11609 </td>
11610
11611
11612 <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;">
11613
11614 &lt;optional><br>
11615
11616
11617
11618
11619
11620 </td>
11621
11622
11623
11624 <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;">
11625
11626 <code>CB_Speaker.getVolume()</code> | <a href="CB_Configuration.CrossBase.html#.CB_Speaker_DEFAULT_VOLUME"><code>CB_Configuration.CrossBase.CB_Speaker_DEFAULT_VOLUME</code></a>
11627
11628 </td>
11629
11630
11631 <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 &quot;volume&quot; parameter when calling the <a href="CB_AudioFileSprites.html#setVolumeAll"><code>CB_AudioFileSprites#setVolumeAll</code></a> method internally.</p></td>
11632 </tr>
11633
11634
11635
11636 <tr>
11637
11638 <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>forceSetVolumeProperty</code></td>
11639
11640
11641 <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;">
11642
11643
11644<span class="param-type">boolean</span>
11645
11646
11647
11648
11649 </td>
11650
11651
11652 <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;">
11653
11654 &lt;optional><br>
11655
11656
11657
11658
11659
11660 </td>
11661
11662
11663
11664 <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;">
11665
11666 false
11667
11668 </td>
11669
11670
11671 <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 &quot;forceSetVolumeProperty&quot; parameter when calling the <a href="CB_AudioFileSprites.html#setVolumeAll"><code>CB_AudioFileSprites#setVolumeAll</code></a> method internally.</p></td>
11672 </tr>
11673
11674
11675
11676 <tr>
11677
11678 <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>onSetVolume</code></td>
11679
11680
11681 <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;">
11682
11683
11684<span class="param-type">function</span>
11685
11686
11687
11688
11689 </td>
11690
11691
11692 <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;">
11693
11694 &lt;optional><br>
11695
11696
11697
11698
11699
11700 </td>
11701
11702
11703
11704 <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;">
11705
11706 </td>
11707
11708
11709 <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 &quot;onSetVolume&quot; parameter when calling the <a href="CB_AudioFileSprites.html#setVolumeAll"><code>CB_AudioFileSprites#setVolumeAll</code></a> method internally.</p></td>
11710 </tr>
11711
11712
11713
11714 <tr>
11715
11716 <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>audioFiles</code></td>
11717
11718
11719 <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;">
11720
11721
11722<span class="param-type">array</span>
11723
11724
11725
11726
11727 </td>
11728
11729
11730 <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;">
11731
11732 &lt;optional><br>
11733
11734
11735
11736
11737
11738 </td>
11739
11740
11741
11742 <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;">
11743
11744 <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a>
11745
11746 </td>
11747
11748
11749 <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 &quot;audioFiles&quot; parameter when calling the <a href="CB_AudioFileSprites.html#setVolumeAll"><code>CB_AudioFileSprites#setVolumeAll</code></a> method internally.</p></td>
11750 </tr>
11751
11752
11753 </tbody>
11754</table>
11755
11756
11757
11758
11759<dl class="details">
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
11790 <dd class="tag-source">
11791 <ul class="dummy">
11792 <li>
11793 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
11794 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1277">line 1277</a>
11795 </li>
11796 </ul>
11797 </dd>
11798
11799
11800
11801
11802
11803
11804
11805</dl>
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819 <h5>Returns:</h5>
11820
11821
11822<div class="param-desc">
11823 <p>Returns the number of calls to the <a href="CB_AudioFile.html#setVolume"><code>CB_AudioFile#setVolume</code></a> method that were performed internally.</p>
11824</div>
11825
11826
11827
11828<dl>
11829 <dt>
11830 Type
11831 </dt>
11832 <dd>
11833
11834<span class="param-type">integer</span>
11835
11836
11837
11838 </dd>
11839</dl>
11840
11841
11842
11843
11844
11845</dd>
11846
11847
11848
11849<hr>
11850<dt>
11851 <h4 class="name" id="stopAll"><span class="type-signature"></span>stopAll<span class="signature">( [audioFiles])</span><span class="type-signature"> &rarr; {integer}</span></h4>
11852
11853
11854</dt>
11855<dd>
11856
11857
11858 <div class="description">
11859 <p>Tries to stops all the existing <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects or the desired ones (if provided), which are being played, by calling their <a href="CB_AudioFile.html#stop"><code>CB_AudioFile#stop</code></a> method internally. Uses the <a href="CB_AudioFileSprites.html#stopAll"><code>CB_AudioFileSprites#stopAll</code></a> method internally.</p>
11860 </div>
11861
11862
11863
11864
11865
11866
11867
11868
11869 <h5>Parameters:</h5>
11870
11871
11872<table class="params table table-striped">
11873 <thead>
11874 <tr>
11875
11876 <th style="width:12%; min-width:110px;">Name</th>
11877
11878
11879 <th style="width:12%; min-width:110px;">Type</th>
11880
11881
11882 <th style="width:12%; min-width:110px;">Argument</th>
11883
11884
11885
11886 <th style="width:12%; min-width:110px;">Default</th>
11887
11888
11889 <th class="last" style="min-width:310px;">Description</th>
11890 </tr>
11891 </thead>
11892
11893 <tbody>
11894
11895
11896 <tr>
11897
11898 <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>audioFiles</code></td>
11899
11900
11901 <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;">
11902
11903
11904<span class="param-type">array</span>
11905
11906
11907
11908
11909 </td>
11910
11911
11912 <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;">
11913
11914 &lt;optional><br>
11915
11916
11917
11918
11919
11920 </td>
11921
11922
11923
11924 <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;">
11925
11926 <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a>
11927
11928 </td>
11929
11930
11931 <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 &quot;audioFiles&quot; parameter when calling the <a href="CB_AudioFileSprites.html#stopAll"><code>CB_AudioFileSprites#stopAll</code></a> method internally.</p></td>
11932 </tr>
11933
11934
11935 </tbody>
11936</table>
11937
11938
11939
11940
11941<dl class="details">
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
11972 <dd class="tag-source">
11973 <ul class="dummy">
11974 <li>
11975 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
11976 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1162">line 1162</a>
11977 </li>
11978 </ul>
11979 </dd>
11980
11981
11982
11983
11984
11985
11986
11987</dl>
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001 <h5>Returns:</h5>
12002
12003
12004<div class="param-desc">
12005 <p>Returns the number of calls to the <a href="CB_AudioFile.html#stop"><code>CB_AudioFile#stop</code></a> method that were performed.</p>
12006</div>
12007
12008
12009
12010<dl>
12011 <dt>
12012 Type
12013 </dt>
12014 <dd>
12015
12016<span class="param-type">integer</span>
12017
12018
12019
12020 </dd>
12021</dl>
12022
12023
12024
12025
12026
12027</dd>
12028
12029
12030
12031<hr>
12032<dt>
12033 <h4 class="name" id="unmuteAll"><span class="type-signature"></span>unmuteAll<span class="signature">( [onUnmute] [, audioFiles])</span><span class="type-signature"> &rarr; {integer}</span></h4>
12034
12035
12036</dt>
12037<dd>
12038
12039
12040 <div class="description">
12041 <p>Unmutes all the existing <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects or the desired ones (if provided). Uses the <a href="CB_AudioFileSprites.html#unmuteAll"><code>CB_AudioFileSprites#unmuteAll</code></a> method internally.</p>
12042 </div>
12043
12044
12045
12046
12047
12048
12049
12050
12051 <h5>Parameters:</h5>
12052
12053
12054<table class="params table table-striped">
12055 <thead>
12056 <tr>
12057
12058 <th style="width:12%; min-width:110px;">Name</th>
12059
12060
12061 <th style="width:12%; min-width:110px;">Type</th>
12062
12063
12064 <th style="width:12%; min-width:110px;">Argument</th>
12065
12066
12067
12068 <th style="width:12%; min-width:110px;">Default</th>
12069
12070
12071 <th class="last" style="min-width:310px;">Description</th>
12072 </tr>
12073 </thead>
12074
12075 <tbody>
12076
12077
12078 <tr>
12079
12080 <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>onUnmute</code></td>
12081
12082
12083 <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;">
12084
12085
12086<span class="param-type">function</span>
12087
12088
12089
12090
12091 </td>
12092
12093
12094 <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;">
12095
12096 &lt;optional><br>
12097
12098
12099
12100
12101
12102 </td>
12103
12104
12105
12106 <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;">
12107
12108 </td>
12109
12110
12111 <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 &quot;onUnmute&quot; parameter when calling the <a href="CB_AudioFileSprites.html#unmuteAll"><code>CB_AudioFileSprites#unmuteAll</code></a> method internally.</p></td>
12112 </tr>
12113
12114
12115
12116 <tr>
12117
12118 <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>audioFiles</code></td>
12119
12120
12121 <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;">
12122
12123
12124<span class="param-type">array</span>
12125
12126
12127
12128
12129 </td>
12130
12131
12132 <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;">
12133
12134 &lt;optional><br>
12135
12136
12137
12138
12139
12140 </td>
12141
12142
12143
12144 <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;">
12145
12146 <a href="CB_AudioFileCache.html#audioFiles"><code>CB_AudioFileCache#audioFiles</code></a>
12147
12148 </td>
12149
12150
12151 <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 &quot;audioFiles&quot; parameter when calling the <a href="CB_AudioFileSprites.html#unmuteAll"><code>CB_AudioFileSprites#unmuteAll</code></a> method internally.</p></td>
12152 </tr>
12153
12154
12155 </tbody>
12156</table>
12157
12158
12159
12160
12161<dl class="details">
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
12192 <dd class="tag-source">
12193 <ul class="dummy">
12194 <li>
12195 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
12196 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1257">line 1257</a>
12197 </li>
12198 </ul>
12199 </dd>
12200
12201
12202
12203
12204
12205
12206
12207</dl>
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221 <h5>Returns:</h5>
12222
12223
12224<div class="param-desc">
12225 <p>Returns the number of calls to the <a href="CB_AudioFile.html#unmute"><code>CB_AudioFile#unmute</code></a> method that were performed.</p>
12226</div>
12227
12228
12229
12230<dl>
12231 <dt>
12232 Type
12233 </dt>
12234 <dd>
12235
12236<span class="param-type">integer</span>
12237
12238
12239
12240 </dd>
12241</dl>
12242
12243
12244
12245
12246
12247</dd>
12248
12249 </dl>
12250
12251
12252
12253 <h3 class="subsection-title">Type Definitions</h3>
12254
12255 <dl>
12256
12257<hr>
12258<dt class="name" id=".DATA_OBJECT">
12259 <h4 id=".DATA_OBJECT">DATA_OBJECT</h4>
12260
12261
12262</dt>
12263<dd>
12264
12265 <div class="description">
12266 <p>Object with the desired data and options for the audio sprites. It is almost identical to the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> but adding a &quot;spritesGroups&quot; property.</p>
12267 </div>
12268
12269
12270
12271 <h5>Type:</h5>
12272 <ul>
12273 <li>
12274
12275<span class="param-type">Object</span>
12276
12277
12278
12279 </li>
12280 </ul>
12281
12282
12283
12284<dl class="details">
12285
12286
12287 <h5 class="subsection-title">Properties:</h5>
12288
12289 <dl>
12290
12291<table class="props table table-striped">
12292 <thead>
12293 <tr>
12294
12295 <th>Name</th>
12296
12297
12298 <th>Type</th>
12299
12300
12301 <th>Argument</th>
12302
12303
12304
12305 <th>Default</th>
12306
12307
12308 <th class="last">Description</th>
12309 </tr>
12310 </thead>
12311
12312 <tbody>
12313
12314
12315 <tr>
12316
12317 <td class="name"><code>spritesGroups</code></td>
12318
12319
12320 <td class="type">
12321
12322
12323<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT">CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</a></span>
12324
12325
12326
12327
12328 </td>
12329
12330
12331 <td class="attributes">
12332
12333 &lt;optional><br>
12334
12335
12336
12337 </td>
12338
12339
12340
12341 <td class="default">
12342
12343 </td>
12344
12345
12346 <td class="description last"><p>Object with the desired sprites groups, containing the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> objects which will be used to create the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> objects internally. Each group will have a <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object. It will be used as the first parameter to call the <a href="CB_AudioFileSpritesPool.html#insertSpritesGroups"><code>CB_AudioFileSpritesPool#insertSpritesGroups</code></a> method internally. Some of the missing properties (&quot;preferredAPIs&quot;, &quot;preferredFormats&quot;, &quot;minimumAudioFiles&quot;, &quot;maximumAudioFiles&quot;, &quot;minimumAudioFilesFree&quot;, &quot;newAudioFilesWhenNeeded&quot;, &quot;retries&quot;, &quot;checkManually&quot;, &quot;checkManuallyOnNeededCreated&quot;, &quot;checkManuallyOnPlayingFailed&quot;, &quot;checkManuallyOnCheckingFailed&quot; and &quot;disableAutoLoad&quot;) of the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> objects given will use the value set on the other properties of this object (if any).</p></td>
12347 </tr>
12348
12349
12350
12351 <tr>
12352
12353 <td class="name"><code>id</code></td>
12354
12355
12356 <td class="type">
12357
12358
12359<span class="param-type">string</span>
12360
12361
12362
12363
12364 </td>
12365
12366
12367 <td class="attributes">
12368
12369 &lt;optional><br>
12370
12371
12372
12373 </td>
12374
12375
12376
12377 <td class="default">
12378
12379 ""
12380
12381 </td>
12382
12383
12384 <td class="description last"><p>Desired identifier for the object. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#id"><code>CB_AudioFileSpritesPool#id</code></a> property.</p></td>
12385 </tr>
12386
12387
12388
12389 <tr>
12390
12391 <td class="name"><code>preferredAPIs</code></td>
12392
12393
12394 <td class="type">
12395
12396
12397<span class="param-type">array</span>
12398
12399
12400
12401
12402 </td>
12403
12404
12405 <td class="attributes">
12406
12407 &lt;optional><br>
12408
12409
12410
12411 </td>
12412
12413
12414
12415 <td class="default">
12416
12417 <a href="CB_Configuration.CrossBase.html#.CB_AudioFileCache_PREFERRED_AUDIO_APIS"><code>CB_Configuration.CrossBase.CB_AudioFileCache_PREFERRED_AUDIO_APIS</code></a>
12418
12419 </td>
12420
12421
12422 <td class="description last"><p>Array of strings with the preferred audio API or audio APIs, in order of preference. Possible audio APIs are &quot;WAAPI&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API">HTML5 Web Audio API</a>), &quot;SM2&quot; (<a href="http://schillmania.com/projects/soundmanager2/">SoundManager 2</a>), &quot;ACMP&quot; (<a href="https://github.com/apache/cordova-plugin-media">Apache Cordova Media Plugin</a>) or &quot;AAPI&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/audio">HTML5 Audio API</a>). It will try to calculate and use the best one for the current client. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#preferredAPIs"><code>CB_AudioFileSpritesPool#preferredAPIs</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;preferredAPIs&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12423 </tr>
12424
12425
12426
12427 <tr>
12428
12429 <td class="name"><code>preferredFormats</code></td>
12430
12431
12432 <td class="type">
12433
12434
12435<span class="param-type">array</span>
12436
12437
12438
12439
12440 </td>
12441
12442
12443 <td class="attributes">
12444
12445 &lt;optional><br>
12446
12447
12448
12449 </td>
12450
12451
12452
12453 <td class="default">
12454
12455 <a href="CB_Configuration.CrossBase.html#.CB_AudioFileCache_PREFERRED_AUDIO_FORMATS"><code>CB_Configuration.CrossBase.CB_AudioFileCache_PREFERRED_AUDIO_FORMATS</code></a>
12456
12457 </td>
12458
12459
12460 <td class="description last"><p>Array of strings with the preferred audio format or audio formats (they can include just the format as 'audio/ogg' or also the codec as for example 'audio/ogg; codecs=&quot;vorbis&quot;'), in order of preference. It will try to calculate and use the best one for the current client. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#preferredFormats"><code>CB_AudioFileSpritesPool#preferredFormats</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;preferredFormats&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12461 </tr>
12462
12463
12464
12465 <tr>
12466
12467 <td class="name"><code>minimumAudioFiles</code></td>
12468
12469
12470 <td class="type">
12471
12472
12473<span class="param-type">integer</span>
12474
12475
12476
12477
12478 </td>
12479
12480
12481 <td class="attributes">
12482
12483 &lt;optional><br>
12484
12485
12486
12487 </td>
12488
12489
12490
12491 <td class="default">
12492
12493 <a href="CB_AudioFileCache.html#.minimumAudioFiles_DEFAULT"><code>CB_AudioFileCache.minimumAudioFiles_DEFAULT</code></a>
12494
12495 </td>
12496
12497
12498 <td class="description last"><p>Minimum <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects to create internally. It must be an integer being 1 the minimum. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#minimumAudioFiles"><code>CB_AudioFileSpritesPool#minimumAudioFiles</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;minimumAudioFiles&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12499 </tr>
12500
12501
12502
12503 <tr>
12504
12505 <td class="name"><code>maximumAudioFiles</code></td>
12506
12507
12508 <td class="type">
12509
12510
12511<span class="param-type">integer</span>
12512
12513
12514
12515
12516 </td>
12517
12518
12519 <td class="attributes">
12520
12521 &lt;optional><br>
12522
12523
12524
12525 </td>
12526
12527
12528
12529 <td class="default">
12530
12531 <a href="CB_AudioFileCache.html#.maximumAudioFiles_DEFAULT"><code>CB_AudioFileCache.maximumAudioFiles_DEFAULT</code></a>
12532
12533 </td>
12534
12535
12536 <td class="description last"><p>Maximum <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that are to be created internally. If it is set to null, there will not be a maximum (it will be unlimited). If an integer is provided, it must be the same number or greater than the value set in the <a href="CB_AudioFileCache.html#minimumAudioFiles"><code>CB_AudioFileCache#minimumAudioFiles</code></a> property (also provided by the &quot;minimumAudioFiles&quot; of this object), allowing 1 minimum. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#maximumAudioFiles"><code>CB_AudioFileSpritesPool#maximumAudioFiles</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;maximumAudioFiles&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12537 </tr>
12538
12539
12540
12541 <tr>
12542
12543 <td class="name"><code>minimumAudioFilesFree</code></td>
12544
12545
12546 <td class="type">
12547
12548
12549<span class="param-type">integer</span>
12550
12551
12552
12553
12554 </td>
12555
12556
12557 <td class="attributes">
12558
12559 &lt;optional><br>
12560
12561
12562
12563 </td>
12564
12565
12566
12567 <td class="default">
12568
12569 parseInt(<a href="CB_AudioFileCache.html#minimumAudioFiles"><code>CB_AudioFileCache#minimumAudioFiles</code></a> * 0.25 + 0.5)
12570
12571 </td>
12572
12573
12574 <td class="description last"><p>New <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects will be created internally when the number of free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects reaches this limit. If provided, it must be an integer being 0 (zero) the minimum. It will end using a 25% of the <a href="CB_AudioFileSpritesPool.html#minimumAudioFiles"><code>CB_AudioFileSpritesPool#minimumAudioFiles</code></a> by default, rounded to ceil, allowing 0 (zero) minimum. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#minimumAudioFilesFree"><code>CB_AudioFileSpritesPool#minimumAudioFilesFree</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;minimumAudioFilesFree&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12575 </tr>
12576
12577
12578
12579 <tr>
12580
12581 <td class="name"><code>newAudioFilesWhenNeeded</code></td>
12582
12583
12584 <td class="type">
12585
12586
12587<span class="param-type">integer</span>
12588
12589
12590
12591
12592 </td>
12593
12594
12595 <td class="attributes">
12596
12597 &lt;optional><br>
12598
12599
12600
12601 </td>
12602
12603
12604
12605 <td class="default">
12606
12607 Math.min(parseInt(<a href="CB_AudioFileCache.html#minimumAudioFiles"><code>CB_AudioFileCache#minimumAudioFiles</code></a> * 0.1 + 0.5), 1)
12608
12609 </td>
12610
12611
12612 <td class="description last"><p>Number of new <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects to create internally when the minimum limit of free <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects (<a href="CB_AudioFileSpritesPool.html#minimumAudioFilesFree"><code>CB_AudioFileSpritesPool#minimumAudioFilesFree</code></a>) is reached. If provided, it must be an integer being 0 (zero) the minimum. It will end using a 10% of the <a href="CB_AudioFileSpritesPool.html#minimumAudioFiles"><code>CB_AudioFileSpritesPool#minimumAudioFiles</code></a> by default, rounded to ceil, allowing 1 minimum. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#newAudioFilesWhenNeeded"><code>CB_AudioFileSpritesPool#newAudioFilesWhenNeeded</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;newAudioFilesWhenNeeded&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12613 </tr>
12614
12615
12616
12617 <tr>
12618
12619 <td class="name"><code>retries</code></td>
12620
12621
12622 <td class="type">
12623
12624
12625<span class="param-type">integer</span>
12626
12627
12628
12629
12630 </td>
12631
12632
12633 <td class="attributes">
12634
12635 &lt;optional><br>
12636
12637
12638
12639 </td>
12640
12641
12642
12643 <td class="default">
12644
12645 <a href="CB_AudioFileCache.html#.retries_DEFAULT"><code>CB_AudioFileCache.retries_DEFAULT</code></a>
12646
12647 </td>
12648
12649
12650 <td class="description last"><p>Number of retries to try to load a <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object internally before trying to load the next possible one internally (if any). It must be an integer being 0 the minimum. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#retries"><code>CB_AudioFileSpritesPool#retries</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;retries&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12651 </tr>
12652
12653
12654
12655 <tr>
12656
12657 <td class="name"><code>checkManually</code></td>
12658
12659
12660 <td class="type">
12661
12662
12663<span class="param-type">boolean</span>
12664
12665
12666
12667
12668 </td>
12669
12670
12671 <td class="attributes">
12672
12673 &lt;optional><br>
12674
12675
12676
12677 </td>
12678
12679
12680
12681 <td class="default">
12682
12683 <a href="CB_AudioFileCache.html#.checkManually_DEFAULT"><code>CB_AudioFileCache.checkManually_DEFAULT</code></a>
12684
12685 </td>
12686
12687
12688 <td class="description last"><p>Tells whether the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects must be checked automatically or not (manually) by default. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#checkManually"><code>CB_AudioFileSpritesPool#checkManually</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;checkManually&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12689 </tr>
12690
12691
12692
12693 <tr>
12694
12695 <td class="name"><code>checkManuallyOnNeededCreated</code></td>
12696
12697
12698 <td class="type">
12699
12700
12701<span class="param-type">boolean</span>
12702
12703
12704
12705
12706 </td>
12707
12708
12709 <td class="attributes">
12710
12711 &lt;optional><br>
12712
12713
12714
12715 </td>
12716
12717
12718
12719 <td class="default">
12720
12721 <a href="CB_AudioFileCache.html#.checkManuallyOnNeededCreated_DEFAULT"><code>CB_AudioFileCache.checkManuallyOnNeededCreated_DEFAULT</code></a>
12722
12723 </td>
12724
12725
12726 <td class="description last"><p>Tells whether the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects must be checked automatically or not (manually) when creates a new <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> object needed. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#checkManuallyOnNeededCreated"><code>CB_AudioFileSpritesPool#checkManuallyOnNeededCreated</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;checkManuallyOnNeededCreated&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12727 </tr>
12728
12729
12730
12731 <tr>
12732
12733 <td class="name"><code>checkManuallyOnPlayingFailed</code></td>
12734
12735
12736 <td class="type">
12737
12738
12739<span class="param-type">boolean</span>
12740
12741
12742
12743
12744 </td>
12745
12746
12747 <td class="attributes">
12748
12749 &lt;optional><br>
12750
12751
12752
12753 </td>
12754
12755
12756
12757 <td class="default">
12758
12759 <a href="CB_AudioFileCache.html#.checkManuallyOnPlayingFailed_DEFAULT"><code>CB_AudioFileCache.checkManuallyOnPlayingFailed_DEFAULT</code></a>
12760
12761 </td>
12762
12763
12764 <td class="description last"><p>Tells whether the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects must be checked automatically or not (manually) when playing one has failed and tries to reload it. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#checkManuallyOnPlayingFailed"><code>CB_AudioFileSpritesPool#checkManuallyOnPlayingFailed</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;checkManuallyOnPlayingFailed&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12765 </tr>
12766
12767
12768
12769 <tr>
12770
12771 <td class="name"><code>checkManuallyOnCheckingFailed</code></td>
12772
12773
12774 <td class="type">
12775
12776
12777<span class="param-type">boolean</span>
12778
12779
12780
12781
12782 </td>
12783
12784
12785 <td class="attributes">
12786
12787 &lt;optional><br>
12788
12789
12790
12791 </td>
12792
12793
12794
12795 <td class="default">
12796
12797 <a href="CB_AudioFileCache.html#.checkManuallyOnCheckingFailed_DEFAULT"><code>CB_AudioFileCache.checkManuallyOnCheckingFailed_DEFAULT</code></a>
12798
12799 </td>
12800
12801
12802 <td class="description last"><p>Tells whether the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects must be checked automatically or not (manually) when checking one has failed and tries to reload it. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#checkManuallyOnCheckingFailed"><code>CB_AudioFileSpritesPool#checkManuallyOnCheckingFailed</code></a> property. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;checkManuallyOnCheckingFailed&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12803 </tr>
12804
12805
12806
12807 <tr>
12808
12809 <td class="name"><code>onLoad</code></td>
12810
12811
12812 <td class="type">
12813
12814
12815<span class="param-type">function</span>
12816
12817
12818
12819
12820 </td>
12821
12822
12823 <td class="attributes">
12824
12825 &lt;optional><br>
12826
12827
12828
12829 </td>
12830
12831
12832
12833 <td class="default">
12834
12835 </td>
12836
12837
12838 <td class="description last"><p>Desired function to be called once the pool has been loaded. The first and unique parameter will be an integer with the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that still need to be checked, if any, being &quot;this&quot; the current <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#onLoad"><code>CB_AudioFileSpritesPool#onLoad</code></a> property.</p></td>
12839 </tr>
12840
12841
12842
12843 <tr>
12844
12845 <td class="name"><code>onError</code></td>
12846
12847
12848 <td class="type">
12849
12850
12851<span class="param-type">function</span>
12852
12853
12854
12855
12856 </td>
12857
12858
12859 <td class="attributes">
12860
12861 &lt;optional><br>
12862
12863
12864
12865 </td>
12866
12867
12868
12869 <td class="default">
12870
12871 </td>
12872
12873
12874 <td class="description last"><p>Desired function to be called when any kind of error happens. The first and unique parameter will be a string with the error description (if it could be determined), being &quot;this&quot; the current <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object. If a valid value is given, this will be added to the <a href="CB_AudioFileSpritesPool.html#onError"><code>CB_AudioFileSpritesPool#onError</code></a> property. If a function is set, it will always be called through the <a href="CB_AudioFileSpritesPool.html#errorFunction"><code>CB_AudioFileSpritesPool#errorFunction</code></a> method whenever the &quot;onError&quot; event of an internally-created <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object is fired.</p></td>
12875 </tr>
12876
12877
12878
12879 <tr>
12880
12881 <td class="name"><code>disableAutoLoad</code></td>
12882
12883
12884 <td class="type">
12885
12886
12887<span class="param-type">boolean</span>
12888
12889
12890
12891
12892 </td>
12893
12894
12895 <td class="attributes">
12896
12897 &lt;optional><br>
12898
12899
12900
12901 </td>
12902
12903
12904
12905 <td class="default">
12906
12907 false
12908
12909 </td>
12910
12911
12912 <td class="description last"><p>If set to true, it will not create automatically the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects by calling the <a href="CB_AudioFileCache.html#createAudioFiles"><code>CB_AudioFileCache#createAudioFiles</code></a> method internally. Internal usage only recommended. If the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object (defined in the <a href="CB_AudioFileSpritesPool.html#.SPRITES_GROUPS_OBJECT"><code>CB_AudioFileSpritesPool.SPRITES_GROUPS_OBJECT</code></a> object set in the &quot;spritesGroups&quot;) of a certain sprites group does not contain the &quot;disableAutoLoad&quot; property, it will use the value of this property instead when creating its <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object internally.</p></td>
12913 </tr>
12914
12915
12916 </tbody>
12917</table>
12918</dl>
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
12950 <dd class="tag-source">
12951 <ul class="dummy">
12952 <li>
12953 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
12954 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-23">line 23</a>
12955 </li>
12956 </ul>
12957 </dd>
12958
12959
12960
12961
12962
12963
12964
12965</dl>
12966
12967
12968
12969</dd>
12970
12971
12972
12973<hr>
12974<dt class="name" id=".SPRITES_GROUPS_OBJECT">
12975 <h4 id=".SPRITES_GROUPS_OBJECT">SPRITES_GROUPS_OBJECT</h4>
12976
12977
12978</dt>
12979<dd>
12980
12981 <div class="description">
12982 <p>Object whose property names the identifiers of each sprite (a case-sensitive string) and their value is a <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> object.</p>
12983 </div>
12984
12985
12986
12987 <h5>Type:</h5>
12988 <ul>
12989 <li>
12990
12991<span class="param-type">Object</span>
12992
12993
12994
12995 </li>
12996 </ul>
12997
12998
12999
13000<dl class="details">
13001
13002
13003 <h5 class="subsection-title">Properties:</h5>
13004
13005 <dl>
13006
13007<table class="props table table-striped">
13008 <thead>
13009 <tr>
13010
13011 <th>Name</th>
13012
13013
13014 <th>Type</th>
13015
13016
13017
13018
13019
13020 <th class="last">Description</th>
13021 </tr>
13022 </thead>
13023
13024 <tbody>
13025
13026
13027 <tr>
13028
13029 <td class="name"><code>spritesGroupId</code></td>
13030
13031
13032 <td class="type">
13033
13034
13035<span class="param-type"><a href="CB_AudioFileSprites.html#.DATA_OBJECT">CB_AudioFileSprites.DATA_OBJECT</a></span>
13036
13037
13038
13039
13040 </td>
13041
13042
13043
13044
13045
13046 <td class="description last"><p>Being the name of each property the unique identifier of a sprites group which will use a future internally-created <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object, the value will always be the <a href="CB_AudioFileSprites.html#.DATA_OBJECT"><code>CB_AudioFileSprites.DATA_OBJECT</code></a> that the <a href="CB_AudioFileSprites.html"><code>CB_AudioFileSprites</code></a> object will use to be created (received by its constructor). Some of the missing properties (&quot;preferredAPIs&quot;, &quot;preferredFormats&quot;, &quot;minimumAudioFiles&quot;, &quot;maximumAudioFiles&quot;, &quot;minimumAudioFilesFree&quot;, &quot;newAudioFilesWhenNeeded&quot;, &quot;retries&quot;, &quot;checkManually&quot;, &quot;checkManuallyOnNeededCreated&quot;, &quot;checkManuallyOnPlayingFailed&quot;, &quot;checkManuallyOnCheckingFailed&quot; and &quot;disableAutoLoad&quot;) will use the value set on the properties of the main <a href="CB_AudioFileSpritesPool.html#.DATA_OBJECT"><code>CB_AudioFileSpritesPool.DATA_OBJECT</code></a> object (if any) used by the <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object. If a function in the &quot;onError&quot; parameter is given, it will always be wrapped so the main error function set on the <a href="CB_AudioFileSpritesPool.html#onError"><code>CB_AudioFileSpritesPool#onError</code></a> parameter will always be called (if any) through the <a href="CB_AudioFileSpritesPool.html#errorFunction"><code>CB_AudioFileSpritesPool#errorFunction</code></a> method.</p></td>
13047 </tr>
13048
13049
13050 </tbody>
13051</table>
13052</dl>
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
13084 <dd class="tag-source">
13085 <ul class="dummy">
13086 <li>
13087 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
13088 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-8">line 8</a>
13089 </li>
13090 </ul>
13091 </dd>
13092
13093
13094
13095
13096
13097
13098
13099</dl>
13100
13101
13102
13103 <h5>Example</h5>
13104
13105 <pre class="sunlight-highlight-javascript">{ &quot;sprites_group_id_1&quot; : CB_AudioFileSprites.DATA_OBJECT, &quot;sprites_group_id_2&quot; : CB_AudioFileSprites.DATA_OBJECT, &quot;sprites_group_id_3&quot; : CB_AudioFileSprites.DATA_OBJECT, ... } </pre>
13106
13107
13108
13109</dd>
13110
13111
13112
13113<hr>
13114<dt>
13115 <h4 class="name" id=".checkPlayingAll_CALLBACK_ERROR"><span class="type-signature"></span>checkPlayingAll_CALLBACK_ERROR<span class="signature">(errorsObject, performedActions, uncheckedObjects)</span><span class="type-signature"></span></h4>
13116
13117
13118</dt>
13119<dd>
13120
13121
13122 <div class="description">
13123 <p>Callback function used by the <a href="CB_AudioFileSpritesPool.html#checkPlayingAll"><code>CB_AudioFileSpritesPool#checkPlayingAll</code></a> method that will be called when not all was performed successfully.</p>
13124 </div>
13125
13126
13127
13128
13129
13130
13131
13132
13133 <h5>Parameters:</h5>
13134
13135
13136<table class="params table table-striped">
13137 <thead>
13138 <tr>
13139
13140 <th style="width:12%; min-width:110px;">Name</th>
13141
13142
13143 <th style="width:12%; min-width:110px;">Type</th>
13144
13145
13146
13147
13148
13149 <th class="last" style="min-width:310px;">Description</th>
13150 </tr>
13151 </thead>
13152
13153 <tbody>
13154
13155
13156 <tr>
13157
13158 <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>errorsObject</code></td>
13159
13160
13161 <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;">
13162
13163
13164<span class="param-type">Object</span>
13165
13166
13167
13168
13169 </td>
13170
13171
13172
13173
13174
13175 <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 whose property names are the ID of each sprites group or &quot;GENERAL_ERROR&quot; if the error is not related to any sprites group and their value will be a <a href="CB_AudioFileSpritesPool.html#.checkPlayingAll_CALLBACK_ERROR_OBJECT"><code>CB_AudioFileSpritesPool.checkPlayingAll_CALLBACK_ERROR_OBJECT</code></a> object.</p></td>
13176 </tr>
13177
13178
13179
13180 <tr>
13181
13182 <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>performedActions</code></td>
13183
13184
13185 <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;">
13186
13187
13188<span class="param-type">integer</span>
13189
13190
13191
13192
13193 </td>
13194
13195
13196
13197
13198
13199 <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>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that can be played).</p></td>
13200 </tr>
13201
13202
13203
13204 <tr>
13205
13206 <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>uncheckedObjects</code></td>
13207
13208
13209 <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;">
13210
13211
13212<span class="param-type">integer</span>
13213|
13214
13215<span class="param-type">undefined</span>
13216
13217
13218
13219
13220 </td>
13221
13222
13223
13224
13225
13226 <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>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that needed to be checked before calling this method (it will be undefined if it could not be determined).</p></td>
13227 </tr>
13228
13229
13230 </tbody>
13231</table>
13232
13233
13234
13235
13236<dl class="details">
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
13267 <dd class="tag-source">
13268 <ul class="dummy">
13269 <li>
13270 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
13271 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1012">line 1012</a>
13272 </li>
13273 </ul>
13274 </dd>
13275
13276
13277
13278
13279
13280
13281
13282</dl>
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298</dd>
13299
13300
13301
13302<hr>
13303<dt class="name" id=".checkPlayingAll_CALLBACK_ERROR_OBJECT">
13304 <h4 id=".checkPlayingAll_CALLBACK_ERROR_OBJECT">checkPlayingAll_CALLBACK_ERROR_OBJECT</h4>
13305
13306
13307</dt>
13308<dd>
13309
13310 <div class="description">
13311 <p>An object with errors, used by the <a href="CB_AudioFileSpritesPool.html#.checkPlayingAll_CALLBACK_ERROR"><code>CB_AudioFileSpritesPool.checkPlayingAll_CALLBACK_ERROR</code></a> callback (used by the <a href="CB_AudioFileSpritesPool.html#checkPlayingAll"><code>CB_AudioFileSpritesPool#checkPlayingAll</code></a> method).</p>
13312 </div>
13313
13314
13315
13316 <h5>Type:</h5>
13317 <ul>
13318 <li>
13319
13320<span class="param-type">Object</span>
13321
13322
13323
13324 </li>
13325 </ul>
13326
13327
13328
13329<dl class="details">
13330
13331
13332 <h5 class="subsection-title">Properties:</h5>
13333
13334 <dl>
13335
13336<table class="props table table-striped">
13337 <thead>
13338 <tr>
13339
13340 <th>Name</th>
13341
13342
13343 <th>Type</th>
13344
13345
13346
13347
13348
13349 <th class="last">Description</th>
13350 </tr>
13351 </thead>
13352
13353 <tbody>
13354
13355
13356 <tr>
13357
13358 <td class="name"><code>error</code></td>
13359
13360
13361 <td class="type">
13362
13363
13364<span class="param-type">string</span>
13365
13366
13367
13368
13369 </td>
13370
13371
13372
13373
13374
13375 <td class="description last"><p>A string describing the error (if it was possible to be determined).</p></td>
13376 </tr>
13377
13378
13379
13380 <tr>
13381
13382 <td class="name"><code>checked</code></td>
13383
13384
13385 <td class="type">
13386
13387
13388<span class="param-type">integer</span>
13389
13390
13391
13392
13393 </td>
13394
13395
13396
13397
13398
13399 <td class="description last"><p>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that can be played.</p></td>
13400 </tr>
13401
13402
13403
13404 <tr>
13405
13406 <td class="name"><code>needed</code></td>
13407
13408
13409 <td class="type">
13410
13411
13412<span class="param-type">integer</span>
13413|
13414
13415<span class="param-type">undefined</span>
13416
13417
13418
13419
13420 </td>
13421
13422
13423
13424
13425
13426 <td class="description last"><p>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that needed to be checked before calling this method (it will be undefined if it could not be determined).</p></td>
13427 </tr>
13428
13429
13430 </tbody>
13431</table>
13432</dl>
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
13464 <dd class="tag-source">
13465 <ul class="dummy">
13466 <li>
13467 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
13468 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1021">line 1021</a>
13469 </li>
13470 </ul>
13471 </dd>
13472
13473
13474
13475
13476
13477
13478
13479</dl>
13480
13481
13482
13483</dd>
13484
13485
13486
13487<hr>
13488<dt>
13489 <h4 class="name" id=".checkPlayingAll_CALLBACK_OK"><span class="type-signature"></span>checkPlayingAll_CALLBACK_OK<span class="signature">(performedActions, uncheckedObjects)</span><span class="type-signature"></span></h4>
13490
13491
13492</dt>
13493<dd>
13494
13495
13496 <div class="description">
13497 <p>Callback function used by the <a href="CB_AudioFileSpritesPool.html#checkPlayingAll"><code>CB_AudioFileSpritesPool#checkPlayingAll</code></a> method that will be called when all the process was performed successfully.</p>
13498 </div>
13499
13500
13501
13502
13503
13504
13505
13506
13507 <h5>Parameters:</h5>
13508
13509
13510<table class="params table table-striped">
13511 <thead>
13512 <tr>
13513
13514 <th style="width:12%; min-width:110px;">Name</th>
13515
13516
13517 <th style="width:12%; min-width:110px;">Type</th>
13518
13519
13520
13521
13522
13523 <th class="last" style="min-width:310px;">Description</th>
13524 </tr>
13525 </thead>
13526
13527 <tbody>
13528
13529
13530 <tr>
13531
13532 <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>performedActions</code></td>
13533
13534
13535 <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;">
13536
13537
13538<span class="param-type">integer</span>
13539
13540
13541
13542
13543 </td>
13544
13545
13546
13547
13548
13549 <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>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that can be played.</p></td>
13550 </tr>
13551
13552
13553
13554 <tr>
13555
13556 <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>uncheckedObjects</code></td>
13557
13558
13559 <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;">
13560
13561
13562<span class="param-type">integer</span>
13563
13564
13565
13566
13567 </td>
13568
13569
13570
13571
13572
13573 <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>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that needed to be checked before calling this method.</p></td>
13574 </tr>
13575
13576
13577 </tbody>
13578</table>
13579
13580
13581
13582
13583<dl class="details">
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
13614 <dd class="tag-source">
13615 <ul class="dummy">
13616 <li>
13617 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
13618 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1004">line 1004</a>
13619 </li>
13620 </ul>
13621 </dd>
13622
13623
13624
13625
13626
13627
13628
13629</dl>
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645</dd>
13646
13647
13648
13649<hr>
13650<dt>
13651 <h4 class="name" id=".executeFunctionAll_ON_FINISH_CALLBACK"><span class="type-signature"></span>executeFunctionAll_ON_FINISH_CALLBACK<span class="signature">(array, itemsAffected, delayMaximum)</span><span class="type-signature"></span></h4>
13652
13653
13654</dt>
13655<dd>
13656
13657
13658 <div class="description">
13659 <p>Callback that is used when finishes all iterations after looping through the items. Being &quot;this&quot; an array with all the items.</p>
13660 </div>
13661
13662
13663
13664
13665
13666
13667
13668
13669 <h5>Parameters:</h5>
13670
13671
13672<table class="params table table-striped">
13673 <thead>
13674 <tr>
13675
13676 <th style="width:12%; min-width:110px;">Name</th>
13677
13678
13679 <th style="width:12%; min-width:110px;">Type</th>
13680
13681
13682
13683
13684
13685 <th class="last" style="min-width:310px;">Description</th>
13686 </tr>
13687 </thead>
13688
13689 <tbody>
13690
13691
13692 <tr>
13693
13694 <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>array</code></td>
13695
13696
13697 <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;">
13698
13699
13700<span class="param-type">array</span>
13701
13702
13703
13704
13705 </td>
13706
13707
13708
13709
13710
13711 <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>An array with all the items which were being looped.</p></td>
13712 </tr>
13713
13714
13715
13716 <tr>
13717
13718 <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>itemsAffected</code></td>
13719
13720
13721 <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;">
13722
13723
13724<span class="param-type">integer</span>
13725
13726
13727
13728
13729 </td>
13730
13731
13732
13733
13734
13735 <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>The number of times that the &quot;functionEach&quot; callback was called (the most likely, matches the number of elements unless they are undefined or null).</p></td>
13736 </tr>
13737
13738
13739
13740 <tr>
13741
13742 <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>delayMaximum</code></td>
13743
13744
13745 <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;">
13746
13747
13748<span class="param-type">integer</span>
13749
13750
13751
13752
13753 </td>
13754
13755
13756
13757
13758
13759 <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>The maximum &quot;delay&quot; used.</p></td>
13760 </tr>
13761
13762
13763 </tbody>
13764</table>
13765
13766
13767
13768
13769<dl class="details">
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
13800 <dd class="tag-source">
13801 <ul class="dummy">
13802 <li>
13803 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
13804 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-750">line 750</a>
13805 </li>
13806 </ul>
13807 </dd>
13808
13809
13810
13811
13812
13813
13814
13815</dl>
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831</dd>
13832
13833
13834
13835<hr>
13836<dt class="name" id=".getAudioFilesUsed_OBJECT">
13837 <h4 id=".getAudioFilesUsed_OBJECT">getAudioFilesUsed_OBJECT</h4>
13838
13839
13840</dt>
13841<dd>
13842
13843 <div class="description">
13844 <p>Object returned by the <a href="CB_AudioFileSpritesPool.html#getAudioFilesUsed"><code>CB_AudioFileSpritesPool#getAudioFilesUsed</code></a> method. Each property names will be the the ID of each sprites group and their value will be a <a href="CB_AudioFileSprites.html#.getAudioFilesUsed_OBJECT"><code>CB_AudioFileSprites.getAudioFilesUsed_OBJECT</code></a> object.</p>
13845 </div>
13846
13847
13848
13849 <h5>Type:</h5>
13850 <ul>
13851 <li>
13852
13853<span class="param-type">Object</span>
13854
13855
13856
13857 </li>
13858 </ul>
13859
13860
13861
13862<dl class="details">
13863
13864
13865 <h5 class="subsection-title">Properties:</h5>
13866
13867 <dl>
13868
13869<table class="props table table-striped">
13870 <thead>
13871 <tr>
13872
13873 <th>Name</th>
13874
13875
13876 <th>Type</th>
13877
13878
13879
13880
13881
13882 <th class="last">Description</th>
13883 </tr>
13884 </thead>
13885
13886 <tbody>
13887
13888
13889 <tr>
13890
13891 <td class="name"><code>spriteId</code></td>
13892
13893
13894 <td class="type">
13895
13896
13897<span class="param-type"><a href="CB_AudioFileSpritesPool.html#.getAudioFilesUsed_OBJECT">CB_AudioFileSpritesPool.getAudioFilesUsed_OBJECT</a></span>
13898
13899
13900
13901
13902 </td>
13903
13904
13905
13906
13907
13908 <td class="description last"><p>Each property names will be the the ID of each sprites group and their value will be a <a href="CB_AudioFileSprites.html#.getAudioFilesUsed_OBJECT"><code>CB_AudioFileSprites.getAudioFilesUsed_OBJECT</code></a> object.</p></td>
13909 </tr>
13910
13911
13912 </tbody>
13913</table>
13914</dl>
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
13946 <dd class="tag-source">
13947 <ul class="dummy">
13948 <li>
13949 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
13950 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-703">line 703</a>
13951 </li>
13952 </ul>
13953 </dd>
13954
13955
13956
13957
13958
13959
13960
13961</dl>
13962
13963
13964
13965</dd>
13966
13967
13968
13969<hr>
13970<dt>
13971 <h4 class="name" id=".setAudioAPIAll_CALLBACK_ERROR"><span class="type-signature"></span>setAudioAPIAll_CALLBACK_ERROR<span class="signature">(errorsObject, errorsHappened, objectsChangedAPI, performedActions, actionsNeeded)</span><span class="type-signature"></span></h4>
13972
13973
13974</dt>
13975<dd>
13976
13977
13978 <div class="description">
13979 <p>Callback function used by the <a href="CB_AudioFileCache.html#setAudioAPIAll"><code>CB_AudioFileCache#setAudioAPIAll</code></a> method that will be called when any error happened.</p>
13980 </div>
13981
13982
13983
13984
13985
13986
13987
13988
13989 <h5>Parameters:</h5>
13990
13991
13992<table class="params table table-striped">
13993 <thead>
13994 <tr>
13995
13996 <th style="width:12%; min-width:110px;">Name</th>
13997
13998
13999 <th style="width:12%; min-width:110px;">Type</th>
14000
14001
14002
14003
14004
14005 <th class="last" style="min-width:310px;">Description</th>
14006 </tr>
14007 </thead>
14008
14009 <tbody>
14010
14011
14012 <tr>
14013
14014 <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>errorsObject</code></td>
14015
14016
14017 <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;">
14018
14019
14020<span class="param-type">Object</span>
14021
14022
14023
14024
14025 </td>
14026
14027
14028
14029
14030
14031 <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 whose property names are the ID of each sprites group or &quot;GENERAL_ERROR&quot; if the error is not related to any sprites group and their value will be a <a href="CB_AudioFileSpritesPool.html#.setAudioAPIAll_CALLBACK_ERROR_OBJECT"><code>CB_AudioFileSpritesPool.setAudioAPIAll_CALLBACK_ERROR_OBJECT</code></a> object each.</p></td>
14032 </tr>
14033
14034
14035
14036 <tr>
14037
14038 <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>errorsHappened</code></td>
14039
14040
14041 <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;">
14042
14043
14044<span class="param-type">integer</span>
14045
14046
14047
14048
14049 </td>
14050
14051
14052
14053
14054
14055 <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>The number of errors that happened, which could be greater than 1 if more than one internal call to the <a href="CB_AudioFile.html#setAudioAPI"><code>CB_AudioFile#setAudioAPI</code></a> method failed.</p></td>
14056 </tr>
14057
14058
14059
14060 <tr>
14061
14062 <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>objectsChangedAPI</code></td>
14063
14064
14065 <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;">
14066
14067
14068<span class="param-type">integer</span>
14069
14070
14071
14072
14073 </td>
14074
14075
14076
14077
14078
14079 <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>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that actually changed its audio API.</p></td>
14080 </tr>
14081
14082
14083
14084 <tr>
14085
14086 <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>performedActions</code></td>
14087
14088
14089 <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;">
14090
14091
14092<span class="param-type">integer</span>
14093
14094
14095
14096
14097 </td>
14098
14099
14100
14101
14102
14103 <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>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that ended with a desired audio API, including those ones which were already using it.</p></td>
14104 </tr>
14105
14106
14107
14108 <tr>
14109
14110 <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>actionsNeeded</code></td>
14111
14112
14113 <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;">
14114
14115
14116<span class="param-type">integer</span>
14117|
14118
14119<span class="param-type">undefined</span>
14120
14121
14122
14123
14124 </td>
14125
14126
14127
14128
14129
14130 <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>The total number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that were considered to perform the action (it will be undefined if it could not be determined).</p></td>
14131 </tr>
14132
14133
14134 </tbody>
14135</table>
14136
14137
14138
14139
14140<dl class="details">
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
14171 <dd class="tag-source">
14172 <ul class="dummy">
14173 <li>
14174 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
14175 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1297">line 1297</a>
14176 </li>
14177 </ul>
14178 </dd>
14179
14180
14181
14182
14183
14184
14185
14186</dl>
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202</dd>
14203
14204
14205
14206<hr>
14207<dt class="name" id=".setAudioAPIAll_CALLBACK_ERROR_OBJECT">
14208 <h4 id=".setAudioAPIAll_CALLBACK_ERROR_OBJECT">setAudioAPIAll_CALLBACK_ERROR_OBJECT</h4>
14209
14210
14211</dt>
14212<dd>
14213
14214 <div class="description">
14215 <p>Object used by the <a href="CB_AudioFileSpritesPool.html#.setAudioAPIAll_CALLBACK_ERROR"><code>CB_AudioFileSpritesPool.setAudioAPIAll_CALLBACK_ERROR</code></a> callback. Unless it belongs to a general error, its information will only be regarding a certain sprites group.</p>
14216 </div>
14217
14218
14219
14220 <h5>Type:</h5>
14221 <ul>
14222 <li>
14223
14224<span class="param-type">Object</span>
14225
14226
14227
14228 </li>
14229 </ul>
14230
14231
14232
14233<dl class="details">
14234
14235
14236 <h5 class="subsection-title">Properties:</h5>
14237
14238 <dl>
14239
14240<table class="props table table-striped">
14241 <thead>
14242 <tr>
14243
14244 <th>Name</th>
14245
14246
14247 <th>Type</th>
14248
14249
14250
14251
14252
14253 <th class="last">Description</th>
14254 </tr>
14255 </thead>
14256
14257 <tbody>
14258
14259
14260 <tr>
14261
14262 <td class="name"><code>error</code></td>
14263
14264
14265 <td class="type">
14266
14267
14268<span class="param-type">string</span>
14269
14270
14271
14272
14273 </td>
14274
14275
14276
14277
14278
14279 <td class="description last"><p>A string describing the error, if it was possible to be determined.</p></td>
14280 </tr>
14281
14282
14283
14284 <tr>
14285
14286 <td class="name"><code>errors</code></td>
14287
14288
14289 <td class="type">
14290
14291
14292<span class="param-type">integer</span>
14293
14294
14295
14296
14297 </td>
14298
14299
14300
14301
14302
14303 <td class="description last"><p>The number of errors that happened, which could be greater than 1 if more than one internal call to the <a href="CB_AudioFile.html#setAudioAPI"><code>CB_AudioFile#setAudioAPI</code></a> method failed.</p></td>
14304 </tr>
14305
14306
14307
14308 <tr>
14309
14310 <td class="name"><code>changed</code></td>
14311
14312
14313 <td class="type">
14314
14315
14316<span class="param-type">integer</span>
14317
14318
14319
14320
14321 </td>
14322
14323
14324
14325
14326
14327 <td class="description last"><p>The number of objects that actually changed its audio API.</p></td>
14328 </tr>
14329
14330
14331
14332 <tr>
14333
14334 <td class="name"><code>performed</code></td>
14335
14336
14337 <td class="type">
14338
14339
14340<span class="param-type">integer</span>
14341
14342
14343
14344
14345 </td>
14346
14347
14348
14349
14350
14351 <td class="description last"><p>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that ended with a desired audio API, including those ones which were already using it.</p></td>
14352 </tr>
14353
14354
14355
14356 <tr>
14357
14358 <td class="name"><code>needed</code></td>
14359
14360
14361 <td class="type">
14362
14363
14364<span class="param-type">integer</span>
14365|
14366
14367<span class="param-type">undefined</span>
14368
14369
14370
14371
14372 </td>
14373
14374
14375
14376
14377
14378 <td class="description last"><p>The total number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that were considered to perform the action (it will be undefined if it could not be determined).</p></td>
14379 </tr>
14380
14381
14382 </tbody>
14383</table>
14384</dl>
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
14416 <dd class="tag-source">
14417 <ul class="dummy">
14418 <li>
14419 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
14420 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1308">line 1308</a>
14421 </li>
14422 </ul>
14423 </dd>
14424
14425
14426
14427
14428
14429
14430
14431</dl>
14432
14433
14434
14435</dd>
14436
14437
14438
14439<hr>
14440<dt>
14441 <h4 class="name" id=".setAudioAPIAll_CALLBACK_OK"><span class="type-signature"></span>setAudioAPIAll_CALLBACK_OK<span class="signature">(objectsChangedAPI, performedActions, actionsNeeded)</span><span class="type-signature"></span></h4>
14442
14443
14444</dt>
14445<dd>
14446
14447
14448 <div class="description">
14449 <p>Callback function used by the <a href="CB_AudioFileSpritesPool.html#setAudioAPIAll"><code>CB_AudioFileSpritesPool#setAudioAPIAll</code></a> method that will be called when all the process was performed successfully.</p>
14450 </div>
14451
14452
14453
14454
14455
14456
14457
14458
14459 <h5>Parameters:</h5>
14460
14461
14462<table class="params table table-striped">
14463 <thead>
14464 <tr>
14465
14466 <th style="width:12%; min-width:110px;">Name</th>
14467
14468
14469 <th style="width:12%; min-width:110px;">Type</th>
14470
14471
14472
14473
14474
14475 <th class="last" style="min-width:310px;">Description</th>
14476 </tr>
14477 </thead>
14478
14479 <tbody>
14480
14481
14482 <tr>
14483
14484 <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>objectsChangedAPI</code></td>
14485
14486
14487 <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;">
14488
14489
14490<span class="param-type">integer</span>
14491
14492
14493
14494
14495 </td>
14496
14497
14498
14499
14500
14501 <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>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that actually changed its audio API.</p></td>
14502 </tr>
14503
14504
14505
14506 <tr>
14507
14508 <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>performedActions</code></td>
14509
14510
14511 <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;">
14512
14513
14514<span class="param-type">integer</span>
14515
14516
14517
14518
14519 </td>
14520
14521
14522
14523
14524
14525 <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>The number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that ended with a desired audio API, including those ones which were already using it.</p></td>
14526 </tr>
14527
14528
14529
14530 <tr>
14531
14532 <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>actionsNeeded</code></td>
14533
14534
14535 <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;">
14536
14537
14538<span class="param-type">integer</span>
14539
14540
14541
14542
14543 </td>
14544
14545
14546
14547
14548
14549 <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>The total number of <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> objects that were considered to perform the action (it will be undefined if it could not be determined).</p></td>
14550 </tr>
14551
14552
14553 </tbody>
14554</table>
14555
14556
14557
14558
14559<dl class="details">
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
14590 <dd class="tag-source">
14591 <ul class="dummy">
14592 <li>
14593 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html">CrossBase/audiovisual/audio/CB_AudioFileSpritesPool.js</a>,
14594 <a href="CrossBase_audiovisual_audio_CB_AudioFileSpritesPool.js.html#sunlight-1-line-1288">line 1288</a>
14595 </li>
14596 </ul>
14597 </dd>
14598
14599
14600
14601
14602
14603
14604
14605</dl>
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621</dd>
14622
14623 </dl>
14624
14625
14626
14627</article>
14628
14629</section>
14630
14631
14632
14633
14634 </div>
14635 </div>
14636
14637 <div class="clearfix"></div>
14638
14639
14640 <div class="col-md-3">
14641 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
14642 </div>
14643
14644
14645</div>
14646</div>
14647
14648
14649 <div class="modal fade" id="searchResults">
14650 <div class="modal-dialog">
14651 <div class="modal-content">
14652 <div class="modal-header">
14653 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
14654 <h4 class="modal-title">Search results</h4>
14655 </div>
14656 <div class="modal-body"></div>
14657 <div class="modal-footer">
14658 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
14659 </div>
14660 </div><!-- /.modal-content -->
14661 </div><!-- /.modal-dialog -->
14662 </div>
14663
14664
14665<footer>
14666
14667
14668 <span class="copyright">
14669 <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
14670 </span>
14671
14672<span class="jsdoc-message">
14673 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
14674
14675 on Wed Mar 22nd 2023
14676
14677 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
14678</span>
14679</footer>
14680
14681<script src="scripts/docstrap.lib.js"></script>
14682<script src="scripts/toc.js"></script>
14683
14684 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
14685
14686
14687<script>
14688$( function () {
14689 $( "[id*='$']" ).each( function () {
14690 var $this = $( this );
14691
14692 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
14693 } );
14694
14695 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
14696 var $this = $( this );
14697
14698 var example = $this.find( "code" );
14699 exampleText = example.html();
14700 var lang = /{@lang (.*?)}/.exec( exampleText );
14701 if ( lang && lang[1] ) {
14702 exampleText = exampleText.replace( lang[0], "" );
14703 example.html( exampleText );
14704 lang = lang[1];
14705 } else {
14706 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
14707 lang = langClassMatch ? langClassMatch[1] : "javascript";
14708 }
14709
14710 if ( lang ) {
14711
14712 $this
14713 .addClass( "sunlight-highlight-" + lang )
14714 .addClass( "linenums" )
14715 .html( example.html() );
14716
14717 }
14718 } );
14719
14720 Sunlight.highlightAll( {
14721 lineNumbers : true,
14722 showMenu : true,
14723 enableDoclinks : true
14724 } );
14725
14726 $.catchAnchorLinks( {
14727 navbarOffset: 10
14728 } );
14729 $( "#toc" ).toc( {
14730 anchorName : function ( i, heading, prefix ) {
14731 return $( heading ).attr( "id" ) || ( prefix + i );
14732 },
14733 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
14734 showAndHide : false,
14735 smoothScrolling: true
14736 } );
14737
14738 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
14739 $( '.dropdown-toggle' ).dropdown();
14740
14741 $( "table" ).each( function () {
14742 var $this = $( this );
14743 $this.addClass('table');
14744 } );
14745
14746} );
14747</script>
14748
14749
14750
14751<!--Navigation and Symbol Display-->
14752
14753<script>
14754 $( function () {
14755 $( '#main' ).localScroll( {
14756 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
14757 } );
14758 $( "dt.name" ).each( function () {
14759 var $this = $( this ).find("h4");
14760 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
14761 var dt = $(this);
14762 var children = dt.next( "dd" );
14763
14764 dt.prepend( icon ).css( {cursor : "pointer"} );
14765 dt.addClass( "member-collapsed" ).addClass( "member" );
14766
14767
14768 children.hide();
14769
14770 dt.children().on( "click", function () {
14771 children = dt.next( "dd" );
14772 children.slideToggle( "fast", function () {
14773
14774 if ( children.is( ":visible" ) ) {
14775 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
14776 dt.addClass( "member-open" ).animate( "member-collapsed" );
14777 } else {
14778 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
14779 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
14780 }
14781 } );
14782 } );
14783
14784 } );
14785 } );
14786</script>
14787
14788
14789<!--Google Analytics-->
14790
14791
14792
14793 <script type="text/javascript">
14794 $(document).ready(function() {
14795 SearcherDisplay.init();
14796 });
14797 </script>
14798
14799
14800</body>
14801</html>
\No newline at end of file