UNPKG

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