UNPKG

68.9 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 Namespace: CB_Speaker</title>
8
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
13
14 <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
15
16</head>
17
18<body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
19
20<div class="navbar navbar-default navbar-fixed-top ">
21<div class="container">
22 <div class="navbar-header">
23 <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
24 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
25 <span class="icon-bar"></span>
26 <span class="icon-bar"></span>
27 <span class="icon-bar"></span>
28 </button>
29 </div>
30 <div class="navbar-collapse collapse" id="topNavigation">
31 <ul class="nav navbar-nav">
32
33 <li class="dropdown">
34 <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
35 <ul class="dropdown-menu inline">
36 <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li>
37 </ul>
38 </li>
39
40 <li class="dropdown">
41 <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
42 <ul class="dropdown-menu inline">
43 <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
44 </ul>
45 </li>
46
47 <li class="dropdown">
48 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
49 <ul class="dropdown-menu inline">
50 <li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li>
51 </ul>
52 </li>
53
54 </ul>
55
56 <div class="col-sm-3 col-md-3">
57 <form class="navbar-form" role="search">
58 <div class="input-group">
59 <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
60 <div class="input-group-btn">
61 <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
62 </div>
63 </div>
64 </form>
65 </div>
66
67 </div>
68
69</div>
70</div>
71
72
73<div class="container" id="toc-content" style="width:100%;">
74<div class="row" style="width:100%;">
75
76
77 <div class="col-md-8" style="width:85%;">
78
79 <div id="main">
80
81
82
83 <h1 class="page-title">Namespace: CB_Speaker</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_Speaker
91 </h2>
92
93
94</header>
95
96
97<article>
98 <div class="container-overview">
99
100
101 <div class="description"><p>Static class to manage the speaker or speakers. It will return itself if it is tried to be instantiated. It can also use <a href="https://mohayonao.github.io/timbre.js/">timbre.js</a>, <a href="https://github.com/meenie/band.js/">Band.js</a> and <a href="https://github.com/loov/jsfx">jsfx</a>.</p></div>
102
103
104
105<dl class="details">
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
136 <dd class="tag-source">
137 <ul class="dummy">
138 <li>
139 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
140 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-14">line 14</a>
141 </li>
142 </ul>
143 </dd>
144
145
146
147
148
149
150
151 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
152 <dd class="tag-todo">
153 <ul>
154 <li>Check whether the path used to play silent sounds as a workaround (through the internal "_playBlankFilesSilently" method) is right or not (now it uses the <a href="global.html#CB_scriptPath"><code>CB_scriptPath</code></a> variable).</li>
155
156 <li>getCopy and filterProperties methods (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>
157 </ul>
158 </dd>
159
160</dl>
161
162
163
164
165 </div>
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180 <h3 class="subsection-title">Methods</h3>
181
182 <dl>
183
184<hr>
185<dt>
186 <h4 class="name" id=".getAudioFileSpritesPool"><span class="type-signature">&lt;static> </span>getAudioFileSpritesPool<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a>|null}</span></h4>
187
188
189</dt>
190<dd>
191
192
193 <div class="description">
194 <p>Returns the current <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object (if any).</p>
195 </div>
196
197
198
199
200
201
202
203
204
205
206<dl class="details">
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
237 <dd class="tag-source">
238 <ul class="dummy">
239 <li>
240 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
241 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-349">line 349</a>
242 </li>
243 </ul>
244 </dd>
245
246
247
248
249
250
251
252</dl>
253
254
255
256
257
258
259
260
261
262
263
264
265
266 <h5>Returns:</h5>
267
268
269<div class="param-desc">
270 <p>Returns the current <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object (if any) or null otherwise.</p>
271</div>
272
273
274
275<dl>
276 <dt>
277 Type
278 </dt>
279 <dd>
280
281<span class="param-type"><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></span>
282|
283
284<span class="param-type">null</span>
285
286
287
288 </dd>
289</dl>
290
291
292
293
294
295</dd>
296
297
298
299<hr>
300<dt>
301 <h4 class="name" id=".getBandJSObject"><span class="type-signature">&lt;static> </span>getBandJSObject<span class="signature">()</span><span class="type-signature"> &rarr; {Object|null}</span></h4>
302
303
304</dt>
305<dd>
306
307
308 <div class="description">
309 <p>Returns a new <a href="https://github.com/meenie/band.js/">Band.js</a> object (if possible). Useful for managing music composition.</p>
310 </div>
311
312
313
314
315
316
317
318
319
320
321<dl class="details">
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
352 <dd class="tag-source">
353 <ul class="dummy">
354 <li>
355 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
356 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-373">line 373</a>
357 </li>
358 </ul>
359 </dd>
360
361
362
363
364
365
366
367 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
368 <dd class="tag-todo">
369 <ul>
370 <li>Band.js should have into account the CB_Speaker._volume</li>
371 </ul>
372 </dd>
373
374</dl>
375
376
377
378
379
380
381
382
383
384
385
386
387
388 <h5>Returns:</h5>
389
390
391<div class="param-desc">
392 <p>Returns a new <a href="https://github.com/meenie/band.js/">Band.js</a> object (if possible) or null otherwise.</p>
393</div>
394
395
396
397<dl>
398 <dt>
399 Type
400 </dt>
401 <dd>
402
403<span class="param-type">Object</span>
404|
405
406<span class="param-type">null</span>
407
408
409
410 </dd>
411</dl>
412
413
414
415
416
417</dd>
418
419
420
421<hr>
422<dt>
423 <h4 class="name" id=".getJsfxObject"><span class="type-signature">&lt;static> </span>getJsfxObject<span class="signature">()</span><span class="type-signature"> &rarr; {Object|null}</span></h4>
424
425
426</dt>
427<dd>
428
429
430 <div class="description">
431 <p>Returns the <a href="https://github.com/loov/jsfx">jsfx</a> object (if any). Useful for managing sound effects generation.</p>
432 </div>
433
434
435
436
437
438
439
440
441
442
443<dl class="details">
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
474 <dd class="tag-source">
475 <ul class="dummy">
476 <li>
477 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
478 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-385">line 385</a>
479 </li>
480 </ul>
481 </dd>
482
483
484
485
486
487
488
489 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
490 <dd class="tag-todo">
491 <ul>
492 <li>jsfx should have into account the CB_Speaker._volume</li>
493 </ul>
494 </dd>
495
496</dl>
497
498
499
500
501
502
503
504
505
506
507
508
509
510 <h5>Returns:</h5>
511
512
513<div class="param-desc">
514 <p>Returns the current <a href="https://github.com/loov/jsfx">jsfx</a> object (if any) or null otherwise.</p>
515</div>
516
517
518
519<dl>
520 <dt>
521 Type
522 </dt>
523 <dd>
524
525<span class="param-type">Object</span>
526|
527
528<span class="param-type">null</span>
529
530
531
532 </dd>
533</dl>
534
535
536
537
538
539</dd>
540
541
542
543<hr>
544<dt>
545 <h4 class="name" id=".getTimbreJSObject"><span class="type-signature">&lt;static> </span>getTimbreJSObject<span class="signature">()</span><span class="type-signature"> &rarr; {Object|null}</span></h4>
546
547
548</dt>
549<dd>
550
551
552 <div class="description">
553 <p>Returns the <a href="https://mohayonao.github.io/timbre.js/">timbre.js</a> object (if any). Useful for functional processing and synthesizing audio.</p>
554 </div>
555
556
557
558
559
560
561
562
563
564
565<dl class="details">
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
596 <dd class="tag-source">
597 <ul class="dummy">
598 <li>
599 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
600 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-361">line 361</a>
601 </li>
602 </ul>
603 </dd>
604
605
606
607
608
609
610
611 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
612 <dd class="tag-todo">
613 <ul>
614 <li>timbre.js should have into account the CB_Speaker._volume</li>
615 </ul>
616 </dd>
617
618</dl>
619
620
621
622
623
624
625
626
627
628
629
630
631
632 <h5>Returns:</h5>
633
634
635<div class="param-desc">
636 <p>Returns the current <a href="https://mohayonao.github.io/timbre.js/">timbre.js</a> object (if any) or null otherwise.</p>
637</div>
638
639
640
641<dl>
642 <dt>
643 Type
644 </dt>
645 <dd>
646
647<span class="param-type">Object</span>
648|
649
650<span class="param-type">null</span>
651
652
653
654 </dd>
655</dl>
656
657
658
659
660
661</dd>
662
663
664
665<hr>
666<dt>
667 <h4 class="name" id=".getVolume"><span class="type-signature">&lt;static> </span>getVolume<span class="signature">( [avoidSanitize])</span><span class="type-signature"> &rarr; {number}</span></h4>
668
669
670</dt>
671<dd>
672
673
674 <div class="description">
675 <p>Tells the current volume.</p>
676 </div>
677
678
679
680
681
682
683
684
685 <h5>Parameters:</h5>
686
687
688<table class="params table table-striped">
689 <thead>
690 <tr>
691
692 <th style="width:12%; min-width:110px;">Name</th>
693
694
695 <th style="width:12%; min-width:110px;">Type</th>
696
697
698 <th style="width:12%; min-width:110px;">Argument</th>
699
700
701
702 <th style="width:12%; min-width:110px;">Default</th>
703
704
705 <th class="last" style="min-width:310px;">Description</th>
706 </tr>
707 </thead>
708
709 <tbody>
710
711
712 <tr>
713
714 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidSanitize</code></td>
715
716
717 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
718
719
720<span class="param-type">boolean</span>
721
722
723
724
725 </td>
726
727
728 <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;">
729
730 &lt;optional><br>
731
732
733
734
735
736 </td>
737
738
739
740 <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;">
741
742 false
743
744 </td>
745
746
747 <td class="description last" style="min-width:310px; 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 call the <a href="CB_Speaker.html#.sanitizeVolume"><code>CB_Speaker.sanitizeVolume</code></a> function internally before returning the volume.</p></td>
748 </tr>
749
750
751 </tbody>
752</table>
753
754
755
756
757<dl class="details">
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
788 <dd class="tag-source">
789 <ul class="dummy">
790 <li>
791 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
792 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-320">line 320</a>
793 </li>
794 </ul>
795 </dd>
796
797
798
799
800
801
802
803</dl>
804
805
806
807
808
809
810
811
812
813
814
815
816
817 <h5>Returns:</h5>
818
819
820<div class="param-desc">
821 <p>Returns the current volume.</p>
822</div>
823
824
825
826<dl>
827 <dt>
828 Type
829 </dt>
830 <dd>
831
832<span class="param-type">number</span>
833
834
835
836 </dd>
837</dl>
838
839
840
841
842
843</dd>
844
845
846
847<hr>
848<dt>
849 <h4 class="name" id=".mute"><span class="type-signature">&lt;static> </span>mute<span class="signature">( [avoidApplyingVolume] [, onMute] [, audioFiles])</span><span class="type-signature"> &rarr; {number}</span></h4>
850
851
852</dt>
853<dd>
854
855
856 <div class="description">
857 <p>Mutes the speaker. Calls the <a href="CB_Speaker.html#.setVolume"><code>CB_Speaker.setVolume</code></a> function internally, with 0 (zero) as the &quot;volume&quot; parmeter, null as the &quot;forceSetVolumeProperty&quot; parameter and true for both &quot;saveForUnmute&quot; and &quot;isMuteOrUnmute&quot; parameters.</p>
858 </div>
859
860
861
862
863
864
865
866
867 <h5>Parameters:</h5>
868
869
870<table class="params table table-striped">
871 <thead>
872 <tr>
873
874 <th style="width:12%; min-width:110px;">Name</th>
875
876
877 <th style="width:12%; min-width:110px;">Type</th>
878
879
880 <th style="width:12%; min-width:110px;">Argument</th>
881
882
883
884 <th style="width:12%; min-width:110px;">Default</th>
885
886
887 <th class="last" style="min-width:310px;">Description</th>
888 </tr>
889 </thead>
890
891 <tbody>
892
893
894 <tr>
895
896 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidApplyingVolume</code></td>
897
898
899 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
900
901
902<span class="param-type">boolean</span>
903
904
905
906
907 </td>
908
909
910 <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;">
911
912 &lt;optional><br>
913
914
915
916
917
918 </td>
919
920
921
922 <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;">
923
924 false
925
926 </td>
927
928
929 <td class="description last" style="min-width:310px; 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 a parameter to call the <a href="CB_Speaker.html#.setVolume"><code>CB_Speaker.setVolume</code></a> function internally.</p></td>
930 </tr>
931
932
933
934 <tr>
935
936 <td class="name" style="width:12%; min-width:110px; 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>
937
938
939 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
940
941
942<span class="param-type">function</span>
943
944
945
946
947 </td>
948
949
950 <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;">
951
952 &lt;optional><br>
953
954
955
956
957
958 </td>
959
960
961
962 <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;">
963
964 </td>
965
966
967 <td class="description last" style="min-width:310px; 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 as the &quot;functionToExecute&quot; parameter to call the <a href="CB_Speaker.html#.setVolume"><code>CB_Speaker.setVolume</code></a> function internally.</p></td>
968 </tr>
969
970
971
972 <tr>
973
974 <td class="name" style="width:12%; min-width:110px; 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>
975
976
977 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
978
979
980<span class="param-type">array</span>
981
982
983
984
985 </td>
986
987
988 <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;">
989
990 &lt;optional><br>
991
992
993
994
995
996 </td>
997
998
999
1000 <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;">
1001
1002 </td>
1003
1004
1005 <td class="description last" style="min-width:310px; 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 a parameter to call the <a href="CB_Speaker.html#.setVolume"><code>CB_Speaker.setVolume</code></a> function internally.</p></td>
1006 </tr>
1007
1008
1009 </tbody>
1010</table>
1011
1012
1013
1014
1015<dl class="details">
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1046 <dd class="tag-source">
1047 <ul class="dummy">
1048 <li>
1049 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
1050 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-288">line 288</a>
1051 </li>
1052 </ul>
1053 </dd>
1054
1055
1056
1057
1058
1059
1060
1061 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
1062 <dd class="tag-todo">
1063 <ul>
1064 <li>Also affect BandJS, jsfx and timbre.js.</li>
1065 </ul>
1066 </dd>
1067
1068</dl>
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082 <h5>Returns:</h5>
1083
1084
1085<div class="param-desc">
1086 <p>Returns the result of the internal call to the <a href="CB_Speaker.html#.setVolume"><code>CB_Speaker.setVolume</code></a> function.</p>
1087</div>
1088
1089
1090
1091<dl>
1092 <dt>
1093 Type
1094 </dt>
1095 <dd>
1096
1097<span class="param-type">number</span>
1098
1099
1100
1101 </dd>
1102</dl>
1103
1104
1105
1106
1107
1108</dd>
1109
1110
1111
1112<hr>
1113<dt>
1114 <h4 class="name" id=".sanitizeVolume"><span class="type-signature">&lt;static> </span>sanitizeVolume<span class="signature">( [volume] [, useSpeakerVolumeIfNaN])</span><span class="type-signature"> &rarr; {number}</span></h4>
1115
1116
1117</dt>
1118<dd>
1119
1120
1121 <div class="description">
1122 <p>Sanitizes the volume (it does not allow values greater than 100 or lower than 0).</p>
1123 </div>
1124
1125
1126
1127
1128
1129
1130
1131
1132 <h5>Parameters:</h5>
1133
1134
1135<table class="params table table-striped">
1136 <thead>
1137 <tr>
1138
1139 <th style="width:12%; min-width:110px;">Name</th>
1140
1141
1142 <th style="width:12%; min-width:110px;">Type</th>
1143
1144
1145 <th style="width:12%; min-width:110px;">Argument</th>
1146
1147
1148
1149 <th style="width:12%; min-width:110px;">Default</th>
1150
1151
1152 <th class="last" style="min-width:310px;">Description</th>
1153 </tr>
1154 </thead>
1155
1156 <tbody>
1157
1158
1159 <tr>
1160
1161 <td class="name" style="width:12%; min-width:110px; 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>
1162
1163
1164 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1165
1166
1167<span class="param-type">number</span>
1168
1169
1170
1171
1172 </td>
1173
1174
1175 <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;">
1176
1177 &lt;optional><br>
1178
1179
1180
1181
1182
1183 </td>
1184
1185
1186
1187 <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;">
1188
1189 CB_Configuration.CrossBase.CB_Speaker_DEFAULT_VOLUME|CB_Speaker._volume
1190
1191 </td>
1192
1193
1194 <td class="description last" style="min-width:310px; 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 desired volume to be sanitized. If not given, it will use the current volume if the &quot;useSpeakerVolumeIfNaN&quot; parameter is set to true or the default volume otherwise.</p></td>
1195 </tr>
1196
1197
1198
1199 <tr>
1200
1201 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useSpeakerVolumeIfNaN</code></td>
1202
1203
1204 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1205
1206
1207<span class="param-type">boolean</span>
1208
1209
1210
1211
1212 </td>
1213
1214
1215 <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;">
1216
1217 &lt;optional><br>
1218
1219
1220
1221
1222
1223 </td>
1224
1225
1226
1227 <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;">
1228
1229 false
1230
1231 </td>
1232
1233
1234 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true and no valid volume is received in the &quot;volume&quot; parameter, it will use the current volume (<code>CB_Speaker._volume</code>). Otherwise, if it is set to false and no valid volume is received in the &quot;volume&quot; parameter, it will use the default volume which is set in the <a href="CB_Configuration.CrossBase.html#.CB_Speaker_DEFAULT_VOLUME"><code>CB_Configuration.CrossBase.CB_Speaker_DEFAULT_VOLUME</code></a> constant.</p></td>
1235 </tr>
1236
1237
1238 </tbody>
1239</table>
1240
1241
1242
1243
1244<dl class="details">
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1275 <dd class="tag-source">
1276 <ul class="dummy">
1277 <li>
1278 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
1279 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-243">line 243</a>
1280 </li>
1281 </ul>
1282 </dd>
1283
1284
1285
1286
1287
1288
1289
1290</dl>
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304 <h5>Returns:</h5>
1305
1306
1307<div class="param-desc">
1308 <p>Returns the volume sanitized (it does not allow values greater than 100 or lower than 0).</p>
1309</div>
1310
1311
1312
1313<dl>
1314 <dt>
1315 Type
1316 </dt>
1317 <dd>
1318
1319<span class="param-type">number</span>
1320
1321
1322
1323 </dd>
1324</dl>
1325
1326
1327
1328
1329
1330</dd>
1331
1332
1333
1334<hr>
1335<dt>
1336 <h4 class="name" id=".setAudioFileSpritesPool"><span class="type-signature">&lt;static> </span>setAudioFileSpritesPool<span class="signature">(audioFileSpritesPool)</span><span class="type-signature"> &rarr; {<a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a>|null}</span></h4>
1337
1338
1339</dt>
1340<dd>
1341
1342
1343 <div class="description">
1344 <p>Sets the desired <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object.</p>
1345 </div>
1346
1347
1348
1349
1350
1351
1352
1353
1354 <h5>Parameters:</h5>
1355
1356
1357<table class="params table table-striped">
1358 <thead>
1359 <tr>
1360
1361 <th style="width:12%; min-width:110px;">Name</th>
1362
1363
1364 <th style="width:12%; min-width:110px;">Type</th>
1365
1366
1367
1368
1369
1370 <th class="last" style="min-width:310px;">Description</th>
1371 </tr>
1372 </thead>
1373
1374 <tbody>
1375
1376
1377 <tr>
1378
1379 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>audioFileSpritesPool</code></td>
1380
1381
1382 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1383
1384
1385<span class="param-type"><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></span>
1386
1387
1388
1389
1390 </td>
1391
1392
1393
1394
1395
1396 <td class="description last" style="min-width:310px; 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 desired <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object to manage all audio files.</p></td>
1397 </tr>
1398
1399
1400 </tbody>
1401</table>
1402
1403
1404
1405
1406<dl class="details">
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1437 <dd class="tag-source">
1438 <ul class="dummy">
1439 <li>
1440 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
1441 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-333">line 333</a>
1442 </li>
1443 </ul>
1444 </dd>
1445
1446
1447
1448
1449
1450
1451
1452</dl>
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466 <h5>Returns:</h5>
1467
1468
1469<div class="param-desc">
1470 <p>Returns the current <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object after setting it (if any) or null otherwise.</p>
1471</div>
1472
1473
1474
1475<dl>
1476 <dt>
1477 Type
1478 </dt>
1479 <dd>
1480
1481<span class="param-type"><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></span>
1482|
1483
1484<span class="param-type">null</span>
1485
1486
1487
1488 </dd>
1489</dl>
1490
1491
1492
1493
1494
1495</dd>
1496
1497
1498
1499<hr>
1500<dt>
1501 <h4 class="name" id=".setVolume"><span class="type-signature">&lt;static> </span>setVolume<span class="signature">( [volume] [, avoidApplyingVolume] [, forceSetVolumeProperty] [, functionToExecute] [, audioFiles] [, saveForUnmute] [, isMuteOrUnmute])</span><span class="type-signature"> &rarr; {number}</span></h4>
1502
1503
1504</dt>
1505<dd>
1506
1507
1508 <div class="description">
1509 <p>Sets the given volume.</p>
1510 </div>
1511
1512
1513
1514
1515
1516
1517
1518
1519 <h5>Parameters:</h5>
1520
1521
1522<table class="params table table-striped">
1523 <thead>
1524 <tr>
1525
1526 <th style="width:12%; min-width:110px;">Name</th>
1527
1528
1529 <th style="width:12%; min-width:110px;">Type</th>
1530
1531
1532 <th style="width:12%; min-width:110px;">Argument</th>
1533
1534
1535
1536 <th style="width:12%; min-width:110px;">Default</th>
1537
1538
1539 <th class="last" style="min-width:310px;">Description</th>
1540 </tr>
1541 </thead>
1542
1543 <tbody>
1544
1545
1546 <tr>
1547
1548 <td class="name" style="width:12%; min-width:110px; 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>
1549
1550
1551 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1552
1553
1554<span class="param-type">number</span>
1555
1556
1557
1558
1559 </td>
1560
1561
1562 <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;">
1563
1564 &lt;optional><br>
1565
1566
1567
1568
1569
1570 </td>
1571
1572
1573
1574 <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;">
1575
1576 CB_Speaker._volume
1577
1578 </td>
1579
1580
1581 <td class="description last" style="min-width:310px; 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 desired volume to be used (it will be sanitized internally by calling the <a href="CB_Speaker.html#.sanitizeVolume"><code>CB_Speaker.sanitizeVolume</code></a> function with the volume as the unique parameter). If not given, it will use the current volume. If the &quot;avoidApplyingVolume&quot; is set to false and the &quot;isMuteOrUnmute&quot; parameter is false, it will also be used as a parameter to call the <a href="CB_AudioFileSpritesPool.html#setVolumeAll"><code>CB_AudioFileSpritesPool#setVolumeAll</code></a> method of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code> (if any).</p></td>
1582 </tr>
1583
1584
1585
1586 <tr>
1587
1588 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidApplyingVolume</code></td>
1589
1590
1591 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1592
1593
1594<span class="param-type">boolean</span>
1595
1596
1597
1598
1599 </td>
1600
1601
1602 <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;">
1603
1604 &lt;optional><br>
1605
1606
1607
1608
1609
1610 </td>
1611
1612
1613
1614 <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;">
1615
1616 false
1617
1618 </td>
1619
1620
1621 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, the volume will not be applied (by calling the <code>CB_Speaker._applyVolume</code> internal function, which will also use the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code>, if any) and just the <code>CB_Speaker._volume</code> internal property will be set.</p></td>
1622 </tr>
1623
1624
1625
1626 <tr>
1627
1628 <td class="name" style="width:12%; min-width:110px; 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>
1629
1630
1631 <td class="type" style="width:12%; min-width: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
1634<span class="param-type">boolean</span>
1635
1636
1637
1638
1639 </td>
1640
1641
1642 <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;">
1643
1644 &lt;optional><br>
1645
1646
1647
1648
1649
1650 </td>
1651
1652
1653
1654 <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;">
1655
1656 false
1657
1658 </td>
1659
1660
1661 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If the &quot;avoidApplyingVolume&quot; is set to false and the &quot;isMuteOrUnmute&quot; parameter is false, it will be used as a parameter to call the <a href="CB_AudioFileSpritesPool.html#setVolumeAll"><code>CB_AudioFileSpritesPool#setVolumeAll</code></a> method of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code> (if any).</p></td>
1662 </tr>
1663
1664
1665
1666 <tr>
1667
1668 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>functionToExecute</code></td>
1669
1670
1671 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1672
1673
1674<span class="param-type">function</span>
1675
1676
1677
1678
1679 </td>
1680
1681
1682 <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;">
1683
1684 &lt;optional><br>
1685
1686
1687
1688
1689
1690 </td>
1691
1692
1693
1694 <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;">
1695
1696 </td>
1697
1698
1699 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>A callback function. If the &quot;avoidApplyingVolume&quot; is set to false and the &quot;isMuteOrUnmute&quot; parameter is false, it will be used as the &quot;onSetVolume&quot; parameter to call the <a href="CB_AudioFileSpritesPool.html#setVolumeAll"><code>CB_AudioFileSpritesPool#setVolumeAll</code></a> method of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code> (if any). If the &quot;avoidApplyingVolume&quot; is set to false and the &quot;isMuteOrUnmute&quot; parameter is true, it will be used as the &quot;onMute&quot; parameter to call the <a href="CB_AudioFileSpritesPool.html#muteAll"><code>CB_AudioFileSpritesPool#muteAll</code></a> method or as the &quot;onUnmute&quot; parameter to call the <a href="CB_AudioFileSpritesPool.html#unmuteAll"><code>CB_AudioFileSpritesPool#unmuteAll</code></a> method of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code> (if any).</p></td>
1700 </tr>
1701
1702
1703
1704 <tr>
1705
1706 <td class="name" style="width:12%; min-width:110px; 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>
1707
1708
1709 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1710
1711
1712<span class="param-type">array</span>
1713
1714
1715
1716
1717 </td>
1718
1719
1720 <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;">
1721
1722 &lt;optional><br>
1723
1724
1725
1726
1727
1728 </td>
1729
1730
1731
1732 <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;">
1733
1734 </td>
1735
1736
1737 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>An array containing the CB_AudioFile objects that we want to affect (if not set and the &quot;avoidApplyingVolume&quot; is set to false, it will affect all the CB_AudioFile objects of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code>, if any). If the &quot;avoidApplyingVolume&quot; is set to false and the &quot;isMuteOrUnmute&quot; parameter is false, it will be used as the &quot;audioFiles&quot; parameter to call the <a href="CB_AudioFileSpritesPool.html#setVolumeAll"><code>CB_AudioFileSpritesPool#setVolumeAll</code></a> method of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code> (if any). If the &quot;avoidApplyingVolume&quot; is set to false and the &quot;isMuteOrUnmute&quot; parameter is true, it will be used as the &quot;audioFiles&quot; parameter to call the <a href="CB_AudioFileSpritesPool.html#muteAll"><code>CB_AudioFileSpritesPool#muteAll</code></a> method or as the &quot;audioFiles&quot; parameter to call the <a href="CB_AudioFileSpritesPool.html#unmuteAll"><code>CB_AudioFileSpritesPool#unmuteAll</code></a> method of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code> (if any).</p></td>
1738 </tr>
1739
1740
1741
1742 <tr>
1743
1744 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>saveForUnmute</code></td>
1745
1746
1747 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1748
1749
1750<span class="param-type">boolean</span>
1751
1752
1753
1754
1755 </td>
1756
1757
1758 <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;">
1759
1760 &lt;optional><br>
1761
1762
1763
1764
1765
1766 </td>
1767
1768
1769
1770 <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;">
1771
1772 false
1773
1774 </td>
1775
1776
1777 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true, the given volume will be saved to be restored later when the <a href="CB_Speaker.html#.unmute"><code>CB_Speaker.unmute</code></a> method is called.</p></td>
1778 </tr>
1779
1780
1781
1782 <tr>
1783
1784 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>isMuteOrUnmute</code></td>
1785
1786
1787 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1788
1789
1790<span class="param-type">boolean</span>
1791
1792
1793
1794
1795 </td>
1796
1797
1798 <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;">
1799
1800 &lt;optional><br>
1801
1802
1803
1804
1805
1806 </td>
1807
1808
1809
1810 <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;">
1811
1812 false
1813
1814 </td>
1815
1816
1817 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true and the volume given is zero, the action performed internally will be muting (by calling the <a href="CB_AudioFileSpritesPool.html#muteAll"><code>CB_AudioFileSpritesPool#muteAll</code></a> method of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code>, if any). Otherwise, if it is set to true and the volume given is not zero, the action performed internally will be unmuting (by calling the <a href="CB_AudioFileSpritesPool.html#unmuteAll"><code>CB_AudioFileSpritesPool#unmuteAll</code></a> method of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code>, if any). If it is set to false, the action performed will be set the volume given (by calling the <a href="CB_AudioFileSpritesPool.html#setVolumeAll"><code>CB_AudioFileSpritesPool#setVolumeAll</code></a> method of the internal <a href="CB_AudioFileSpritesPool.html"><code>CB_AudioFileSpritesPool</code></a> object defined in <code>CB_Speaker._audioFileSpritesPool</code>, if any).</p></td>
1818 </tr>
1819
1820
1821 </tbody>
1822</table>
1823
1824
1825
1826
1827<dl class="details">
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1858 <dd class="tag-source">
1859 <ul class="dummy">
1860 <li>
1861 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
1862 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-269">line 269</a>
1863 </li>
1864 </ul>
1865 </dd>
1866
1867
1868
1869
1870
1871
1872
1873 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
1874 <dd class="tag-todo">
1875 <ul>
1876 <li>Also affect BandJS, jsfx and timbre.js.</li>
1877 </ul>
1878 </dd>
1879
1880</dl>
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894 <h5>Returns:</h5>
1895
1896
1897<div class="param-desc">
1898 <p>Returns the current volume being used after setting it.</p>
1899</div>
1900
1901
1902
1903<dl>
1904 <dt>
1905 Type
1906 </dt>
1907 <dd>
1908
1909<span class="param-type">number</span>
1910
1911
1912
1913 </dd>
1914</dl>
1915
1916
1917
1918
1919
1920</dd>
1921
1922
1923
1924<hr>
1925<dt>
1926 <h4 class="name" id=".unmute"><span class="type-signature">&lt;static> </span>unmute<span class="signature">( [avoidApplyingVolume] [, onUnmute] [, audioFiles] [, ignoreVolume])</span><span class="type-signature"> &rarr; {number}</span></h4>
1927
1928
1929</dt>
1930<dd>
1931
1932
1933 <div class="description">
1934 <p>Restores the audio volume after muting it. If the current volume is 0 (zero, muted) or the &quot;ignoreVolume&quot; parameter is set to true, calls the <a href="CB_Speaker.html#.setVolume"><code>CB_Speaker.setVolume</code></a> function internally, with the previously-saved volume before muting it as the &quot;volume&quot; parmeter, null as the &quot;forceSetVolumeProperty&quot; parameter, false for the &quot;saveForUnmute&quot; parameter and true for the &quot;isMuteOrUnmute&quot; parameter.</p>
1935 </div>
1936
1937
1938
1939
1940
1941
1942
1943
1944 <h5>Parameters:</h5>
1945
1946
1947<table class="params table table-striped">
1948 <thead>
1949 <tr>
1950
1951 <th style="width:12%; min-width:110px;">Name</th>
1952
1953
1954 <th style="width:12%; min-width:110px;">Type</th>
1955
1956
1957 <th style="width:12%; min-width:110px;">Argument</th>
1958
1959
1960
1961 <th style="width:12%; min-width:110px;">Default</th>
1962
1963
1964 <th class="last" style="min-width:310px;">Description</th>
1965 </tr>
1966 </thead>
1967
1968 <tbody>
1969
1970
1971 <tr>
1972
1973 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidApplyingVolume</code></td>
1974
1975
1976 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1977
1978
1979<span class="param-type">boolean</span>
1980
1981
1982
1983
1984 </td>
1985
1986
1987 <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;">
1988
1989 &lt;optional><br>
1990
1991
1992
1993
1994
1995 </td>
1996
1997
1998
1999 <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;">
2000
2001 false
2002
2003 </td>
2004
2005
2006 <td class="description last" style="min-width:310px; 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 a parameter to call the <a href="CB_Speaker.html#.setVolume"><code>CB_Speaker.setVolume</code></a> function internally, if the &quot;ignoreVolume&quot; parameter is set to true.</p></td>
2007 </tr>
2008
2009
2010
2011 <tr>
2012
2013 <td class="name" style="width:12%; min-width:110px; 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>
2014
2015
2016 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2017
2018
2019<span class="param-type">function</span>
2020
2021
2022
2023
2024 </td>
2025
2026
2027 <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;">
2028
2029 &lt;optional><br>
2030
2031
2032
2033
2034
2035 </td>
2036
2037
2038
2039 <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;">
2040
2041 </td>
2042
2043
2044 <td class="description last" style="min-width:310px; 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 as the &quot;functionToExecute&quot; parameter to call the <a href="CB_Speaker.html#.setVolume"><code>CB_Speaker.setVolume</code></a> function internally, if the &quot;ignoreVolume&quot; parameter is set to true.</p></td>
2045 </tr>
2046
2047
2048
2049 <tr>
2050
2051 <td class="name" style="width:12%; min-width:110px; 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>
2052
2053
2054 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2055
2056
2057<span class="param-type">array</span>
2058
2059
2060
2061
2062 </td>
2063
2064
2065 <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;">
2066
2067 &lt;optional><br>
2068
2069
2070
2071
2072
2073 </td>
2074
2075
2076
2077 <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;">
2078
2079 </td>
2080
2081
2082 <td class="description last" style="min-width:310px; 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 a parameter to call the <a href="CB_Speaker.html#.setVolume"><code>CB_Speaker.setVolume</code></a> function internally, if the &quot;ignoreVolume&quot; parameter is set to true.</p></td>
2083 </tr>
2084
2085
2086
2087 <tr>
2088
2089 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>ignoreVolume</code></td>
2090
2091
2092 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2093
2094
2095<span class="param-type">boolean</span>
2096
2097
2098
2099
2100 </td>
2101
2102
2103 <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;">
2104
2105 &lt;optional><br>
2106
2107
2108
2109
2110
2111 </td>
2112
2113
2114
2115 <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;">
2116
2117 false
2118
2119 </td>
2120
2121
2122 <td class="description last" style="min-width:310px; 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 try to perform the muting action even when the current volume is not 0 (zero, muted).</p></td>
2123 </tr>
2124
2125
2126 </tbody>
2127</table>
2128
2129
2130
2131
2132<dl class="details">
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2163 <dd class="tag-source">
2164 <ul class="dummy">
2165 <li>
2166 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html">CrossBase/audiovisual/audio/CB_Speaker.js</a>,
2167 <a href="CrossBase_audiovisual_audio_CB_Speaker.js.html#sunlight-1-line-304">line 304</a>
2168 </li>
2169 </ul>
2170 </dd>
2171
2172
2173
2174
2175
2176
2177
2178 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
2179 <dd class="tag-todo">
2180 <ul>
2181 <li>Also affect BandJS, jsfx and timbre.js.</li>
2182 </ul>
2183 </dd>
2184
2185</dl>
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199 <h5>Returns:</h5>
2200
2201
2202<div class="param-desc">
2203 <p>Returns the current volume.</p>
2204</div>
2205
2206
2207
2208<dl>
2209 <dt>
2210 Type
2211 </dt>
2212 <dd>
2213
2214<span class="param-type">number</span>
2215
2216
2217
2218 </dd>
2219</dl>
2220
2221
2222
2223
2224
2225</dd>
2226
2227 </dl>
2228
2229
2230
2231
2232
2233</article>
2234
2235</section>
2236
2237
2238
2239
2240 </div>
2241 </div>
2242
2243 <div class="clearfix"></div>
2244
2245
2246 <div class="col-md-3">
2247 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
2248 </div>
2249
2250
2251</div>
2252</div>
2253
2254
2255 <div class="modal fade" id="searchResults">
2256 <div class="modal-dialog">
2257 <div class="modal-content">
2258 <div class="modal-header">
2259 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
2260 <h4 class="modal-title">Search results</h4>
2261 </div>
2262 <div class="modal-body"></div>
2263 <div class="modal-footer">
2264 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
2265 </div>
2266 </div><!-- /.modal-content -->
2267 </div><!-- /.modal-dialog -->
2268 </div>
2269
2270
2271<footer>
2272
2273
2274 <span class="copyright">
2275 <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>
2276 </span>
2277
2278<span class="jsdoc-message">
2279 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
2280
2281 on Wed Mar 22nd 2023
2282
2283 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
2284</span>
2285</footer>
2286
2287<script src="scripts/docstrap.lib.js"></script>
2288<script src="scripts/toc.js"></script>
2289
2290 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
2291
2292
2293<script>
2294$( function () {
2295 $( "[id*='$']" ).each( function () {
2296 var $this = $( this );
2297
2298 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
2299 } );
2300
2301 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
2302 var $this = $( this );
2303
2304 var example = $this.find( "code" );
2305 exampleText = example.html();
2306 var lang = /{@lang (.*?)}/.exec( exampleText );
2307 if ( lang && lang[1] ) {
2308 exampleText = exampleText.replace( lang[0], "" );
2309 example.html( exampleText );
2310 lang = lang[1];
2311 } else {
2312 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
2313 lang = langClassMatch ? langClassMatch[1] : "javascript";
2314 }
2315
2316 if ( lang ) {
2317
2318 $this
2319 .addClass( "sunlight-highlight-" + lang )
2320 .addClass( "linenums" )
2321 .html( example.html() );
2322
2323 }
2324 } );
2325
2326 Sunlight.highlightAll( {
2327 lineNumbers : true,
2328 showMenu : true,
2329 enableDoclinks : true
2330 } );
2331
2332 $.catchAnchorLinks( {
2333 navbarOffset: 10
2334 } );
2335 $( "#toc" ).toc( {
2336 anchorName : function ( i, heading, prefix ) {
2337 return $( heading ).attr( "id" ) || ( prefix + i );
2338 },
2339 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
2340 showAndHide : false,
2341 smoothScrolling: true
2342 } );
2343
2344 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
2345 $( '.dropdown-toggle' ).dropdown();
2346
2347 $( "table" ).each( function () {
2348 var $this = $( this );
2349 $this.addClass('table');
2350 } );
2351
2352} );
2353</script>
2354
2355
2356
2357<!--Navigation and Symbol Display-->
2358
2359<script>
2360 $( function () {
2361 $( '#main' ).localScroll( {
2362 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
2363 } );
2364 $( "dt.name" ).each( function () {
2365 var $this = $( this ).find("h4");
2366 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
2367 var dt = $(this);
2368 var children = dt.next( "dd" );
2369
2370 dt.prepend( icon ).css( {cursor : "pointer"} );
2371 dt.addClass( "member-collapsed" ).addClass( "member" );
2372
2373
2374 children.hide();
2375
2376 dt.children().on( "click", function () {
2377 children = dt.next( "dd" );
2378 children.slideToggle( "fast", function () {
2379
2380 if ( children.is( ":visible" ) ) {
2381 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
2382 dt.addClass( "member-open" ).animate( "member-collapsed" );
2383 } else {
2384 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
2385 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
2386 }
2387 } );
2388 } );
2389
2390 } );
2391 } );
2392</script>
2393
2394
2395<!--Google Analytics-->
2396
2397
2398
2399 <script type="text/javascript">
2400 $(document).ready(function() {
2401 SearcherDisplay.init();
2402 });
2403 </script>
2404
2405
2406</body>
2407</html>
\No newline at end of file