UNPKG

176 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_AudioFile_API.WAAPI</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_AudioFile_API.WAAPI</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_AudioFile_API.WAAPI
91 </h2>
92
93 <div class="class-description"><p>Class to manage an audio file using &quot;WAAPI&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API">HTML5 Web Audio API</a>). Used by the <a href="CB_AudioFile.html"><code>CB_AudioFile</code></a> class internally and it shares most of its properties and methods. Recommended for internal usage only. Uses <a href="https://gist.github.com/htchaan/108b7aa6b71eb03e38019e64450ea095">Base64Binary</a> internally. Some old clients can use this audio API thanks to <a href="https://github.com/cwilso/AudioContext-MonkeyPatch">AudioContext-MonkeyPatch</a> and <a href="https://github.com/g200kg/WAAPISim">WAAPISim</a>.</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_AudioFile_API.WAAPI"><span class="type-signature"></span>new CB_AudioFile_API.WAAPI<span class="signature">(filePath [, audioId] [, options] [, callbackOk] [, callbackError])</span><span class="type-signature"> &rarr; {<a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</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.) if the &quot;autoPlay&quot; option is set to true, as some web 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 <th style="width:12%; min-width:110px;">Default</th>
141
142
143 <th class="last" style="min-width:310px;">Description</th>
144 </tr>
145 </thead>
146
147 <tbody>
148
149
150 <tr>
151
152 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>filePath</code></td>
153
154
155 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
156
157
158<span class="param-type">string</span>
159
160
161
162
163 </td>
164
165
166 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
167
168
169
170
171
172 </td>
173
174
175
176 <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;">
177
178 </td>
179
180
181 <td class="description last" style="min-width:310px; 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 path of the audio file or a data URI. NOTE: Only some clients with some audio APIs will support data URIs.</p></td>
182 </tr>
183
184
185
186 <tr>
187
188 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>audioId</code></td>
189
190
191 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
192
193
194<span class="param-type">string</span>
195
196
197
198
199 </td>
200
201
202 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
203
204 &lt;optional><br>
205
206
207
208
209
210 </td>
211
212
213
214 <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;">
215
216 'CB_AUDIOFILE_WAAPI_' + CB_AudioFile_API.WAAPI._idUnique++
217
218 </td>
219
220
221 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired identifier for the audio object. If not provided, an automatic unique ID will be calculated. Note that it is not case sensitive and it should be unique for each object.</p></td>
222 </tr>
223
224
225
226 <tr>
227
228 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>options</code></td>
229
230
231 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
232
233
234<span class="param-type"><a href="CB_AudioFile_API.WAAPI.html#.OPTIONS">CB_AudioFile_API.WAAPI.OPTIONS</a></span>
235
236
237
238
239 </td>
240
241
242 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
243
244 &lt;optional><br>
245
246
247
248
249
250 </td>
251
252
253
254 <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;">
255
256 CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS
257
258 </td>
259
260
261 <td class="description last" style="min-width:310px; 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 options.</p></td>
262 </tr>
263
264
265
266 <tr>
267
268 <td class="name" style="width:12%; min-width:110px; 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>
269
270
271 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
272
273
274<span class="param-type">function</span>
275
276
277
278
279 </td>
280
281
282 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
283
284 &lt;optional><br>
285
286
287
288
289
290 </td>
291
292
293
294 <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;">
295
296 </td>
297
298
299 <td class="description last" style="min-width:310px; 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 with no parameters to be called when the audio has been loaded successfully, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object itself.</p></td>
300 </tr>
301
302
303
304 <tr>
305
306 <td class="name" style="width:12%; min-width:110px; 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>
307
308
309 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
310
311
312<span class="param-type">function</span>
313
314
315
316
317 </td>
318
319
320 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
321
322 &lt;optional><br>
323
324
325
326
327
328 </td>
329
330
331
332 <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;">
333
334 </td>
335
336
337 <td class="description last" style="min-width:310px; 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 to be called if the audio has not been loaded successfully. The first and unique parameter will be a string describing the error found (if could be determined), being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object itself.</p></td>
338 </tr>
339
340
341 </tbody>
342</table>
343
344
345
346
347<dl class="details">
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
378 <dd class="tag-source">
379 <ul class="dummy">
380 <li>
381 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
382 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-22">line 22</a>
383 </li>
384 </ul>
385 </dd>
386
387
388
389
390
391
392
393 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
394 <dd class="tag-todo">
395 <ul>
396 <li>Do not allow to create one object with an "id" which has already been used (unless the value is undefined, null...). Note that the "id" is not case sensitive and it should be unique for each object.</li>
397
398 <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>
399 </ul>
400 </dd>
401
402</dl>
403
404
405
406
407
408
409
410
411
412
413
414
415
416 <h5>Returns:</h5>
417
418
419<div class="param-desc">
420 <p>Returns a new <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object.</p>
421</div>
422
423
424
425<dl>
426 <dt>
427 Type
428 </dt>
429 <dd>
430
431<span class="param-type"><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></span>
432
433
434
435 </dd>
436</dl>
437
438
439
440
441
442</dd>
443
444
445 </div>
446
447
448
449
450
451
452
453
454
455
456
457
458 <h3 class="subsection-title">Members</h3>
459
460 <dl>
461
462<hr>
463<dt class="name" id="buffer">
464 <h4 id="buffer"><span class="type-signature">&lt;readonly> </span>buffer<span class="type-signature"> :AudioBuffer</span></h4>
465
466
467</dt>
468<dd>
469
470 <div class="description">
471 <p>Stores the &quot;buffer&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/buffer">AudioBuffer</a> object) of the audio, used by the &quot;WAAPI&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API">HTML5 Web Audio API</a>).</p>
472 </div>
473
474
475
476 <h5>Type:</h5>
477 <ul>
478 <li>
479
480<span class="param-type">AudioBuffer</span>
481
482
483
484 </li>
485 </ul>
486
487
488
489<dl class="details">
490
491
492
493
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-source method-doc-label method-doc-details-label">Source:</dt>
520 <dd class="tag-source">
521 <ul class="dummy">
522 <li>
523 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
524 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-176">line 176</a>
525 </li>
526 </ul>
527 </dd>
528
529
530
531
532
533
534
535</dl>
536
537
538
539</dd>
540
541
542
543<hr>
544<dt class="name" id="DEFAULT_OPTIONS">
545 <h4 id="DEFAULT_OPTIONS"><span class="type-signature">&lt;constant> </span>DEFAULT_OPTIONS<span class="type-signature"> :<a href="CB_AudioFile_API.WAAPI.html#.OPTIONS">CB_AudioFile_API.WAAPI.OPTIONS</a></span></h4>
546
547
548</dt>
549<dd>
550
551 <div class="description">
552 <p>Keeps the default options when an object is created. Format: { autoLoad: boolean, autoPlay: boolean, loop: boolean, volume: number }.</p>
553 </div>
554
555
556
557 <h5>Type:</h5>
558 <ul>
559 <li>
560
561<span class="param-type"><a href="CB_AudioFile_API.WAAPI.html#.OPTIONS">CB_AudioFile_API.WAAPI.OPTIONS</a></span>
562
563
564
565 </li>
566 </ul>
567
568
569
570<dl class="details">
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
596 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
597 <dd class="tag-default">
598 <ul class="dummy">
599 <li>{ autoLoad: true, autoPlay: false, loop: false, volume: <a href="CB_AudioFile_API.WAAPI.html#DEFAULT_VOLUME"><code>CB_AudioFile_API.WAAPI.prototype.DEFAULT_VOLUME</code></a> }</li>
600 </ul>
601 </dd>
602
603
604
605
606
607 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
608 <dd class="tag-source">
609 <ul class="dummy">
610 <li>
611 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
612 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-50">line 50</a>
613 </li>
614 </ul>
615 </dd>
616
617
618
619
620
621
622
623</dl>
624
625
626
627</dd>
628
629
630
631<hr>
632<dt class="name" id="DEFAULT_VOLUME">
633 <h4 id="DEFAULT_VOLUME"><span class="type-signature">&lt;constant> </span>DEFAULT_VOLUME<span class="type-signature"> :number</span></h4>
634
635
636</dt>
637<dd>
638
639 <div class="description">
640 <p>Keeps the default volume. If the <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_DEFAULT"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_DEFAULT</code></a> property is true, this will keep the result of calling the <a href="CB_Speaker.html#.getVolume"><code>CB_Speaker.getVolume</code></a> function. Otherwise, it will use the value of the <a href="CB_Configuration.CrossBase.html#.CB_Speaker_DEFAULT_VOLUME"><code>CB_Configuration.CrossBase.CB_Speaker_DEFAULT_VOLUME</code></a> variable.</p>
641 </div>
642
643
644
645 <h5>Type:</h5>
646 <ul>
647 <li>
648
649<span class="param-type">number</span>
650
651
652
653 </li>
654 </ul>
655
656
657
658<dl class="details">
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
685 <dd class="tag-default">
686 <ul class="dummy">
687 <li>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_DEFAULT ? CB_Speaker.getVolume() : CB_Configuration.CrossBase.CB_Speaker_DEFAULT_VOLUME</li>
688 </ul>
689 </dd>
690
691
692
693
694
695 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
696 <dd class="tag-source">
697 <ul class="dummy">
698 <li>
699 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
700 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-42">line 42</a>
701 </li>
702 </ul>
703 </dd>
704
705
706
707
708
709
710
711</dl>
712
713
714
715</dd>
716
717
718
719<hr>
720<dt class="name" id="filePath">
721 <h4 id="filePath"><span class="type-signature">&lt;readonly> </span>filePath<span class="type-signature"> :string</span></h4>
722
723
724</dt>
725<dd>
726
727 <div class="description">
728 <p>Stores the path of the audio file or the data URI. NOTE: Only some clients with some audio APIs will support data URIs.</p>
729 </div>
730
731
732
733 <h5>Type:</h5>
734 <ul>
735 <li>
736
737<span class="param-type">string</span>
738
739
740
741 </li>
742 </ul>
743
744
745
746<dl class="details">
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
777 <dd class="tag-source">
778 <ul class="dummy">
779 <li>
780 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
781 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-104">line 104</a>
782 </li>
783 </ul>
784 </dd>
785
786
787
788
789
790
791
792</dl>
793
794
795
796</dd>
797
798
799
800<hr>
801<dt class="name" id="gainNode">
802 <h4 id="gainNode"><span class="type-signature">&lt;readonly> </span>gainNode<span class="type-signature"> :GainNode</span></h4>
803
804
805</dt>
806<dd>
807
808 <div class="description">
809 <p>Stores the &quot;gain node&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/GainNode">GainNode</a> object created with the <a href="https://developer.mozilla.org/en-US/docs/Web/API/BaseAudioContext/createGain">createGain</a> method) of the audio, used by the &quot;WAAPI&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API">HTML5 Web Audio API</a>).</p>
810 </div>
811
812
813
814 <h5>Type:</h5>
815 <ul>
816 <li>
817
818<span class="param-type">GainNode</span>
819
820
821
822 </li>
823 </ul>
824
825
826
827<dl class="details">
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
858 <dd class="tag-source">
859 <ul class="dummy">
860 <li>
861 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
862 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-186">line 186</a>
863 </li>
864 </ul>
865 </dd>
866
867
868
869
870
871
872
873</dl>
874
875
876
877</dd>
878
879
880
881<hr>
882<dt class="name" id="id">
883 <h4 id="id"><span class="type-signature">&lt;readonly> </span>id<span class="type-signature"> :string</span></h4>
884
885
886</dt>
887<dd>
888
889 <div class="description">
890 <p>Stores the identifier for the audio file.</p>
891 </div>
892
893
894
895 <h5>Type:</h5>
896 <ul>
897 <li>
898
899<span class="param-type">string</span>
900
901
902
903 </li>
904 </ul>
905
906
907
908<dl class="details">
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
935 <dd class="tag-default">
936 <ul class="dummy">
937 <li>'CB_AUDIOFILE_WAAPI_' + CB_AudioFile_API.WAAPI._idUnique++</li>
938 </ul>
939 </dd>
940
941
942
943
944
945 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
946 <dd class="tag-source">
947 <ul class="dummy">
948 <li>
949 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
950 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-95">line 95</a>
951 </li>
952 </ul>
953 </dd>
954
955
956
957
958
959
960
961</dl>
962
963
964
965</dd>
966
967
968
969<hr>
970<dt class="name" id="lastStartAt">
971 <h4 id="lastStartAt"><span class="type-signature">&lt;readonly> </span>lastStartAt<span class="type-signature"> :number</span></h4>
972
973
974</dt>
975<dd>
976
977 <div class="description">
978 <p>Stores the last &quot;startAt&quot; parameter value used by the <a href="CB_AudioFile_API.WAAPI.html#play"><code>CB_AudioFile_API.WAAPI#play</code></a> or the <a href="CB_AudioFile_API.WAAPI.html#resume"><code>CB_AudioFile_API.WAAPI#resume</code></a> method.</p>
979 </div>
980
981
982
983 <h5>Type:</h5>
984 <ul>
985 <li>
986
987<span class="param-type">number</span>
988
989
990
991 </li>
992 </ul>
993
994
995
996<dl class="details">
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1027 <dd class="tag-source">
1028 <ul class="dummy">
1029 <li>
1030 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1031 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-149">line 149</a>
1032 </li>
1033 </ul>
1034 </dd>
1035
1036
1037
1038
1039
1040
1041
1042</dl>
1043
1044
1045
1046</dd>
1047
1048
1049
1050<hr>
1051<dt class="name" id="lastStopAt">
1052 <h4 id="lastStopAt"><span class="type-signature">&lt;readonly> </span>lastStopAt<span class="type-signature"> :number</span></h4>
1053
1054
1055</dt>
1056<dd>
1057
1058 <div class="description">
1059 <p>Stores the last &quot;stopAt&quot; parameter value used by the <a href="CB_AudioFile_API.WAAPI.html#play"><code>CB_AudioFile_API.WAAPI#play</code></a> or the <a href="CB_AudioFile_API.WAAPI.html#resume"><code>CB_AudioFile_API.WAAPI#resume</code></a> method.</p>
1060 </div>
1061
1062
1063
1064 <h5>Type:</h5>
1065 <ul>
1066 <li>
1067
1068<span class="param-type">number</span>
1069
1070
1071
1072 </li>
1073 </ul>
1074
1075
1076
1077<dl class="details">
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1108 <dd class="tag-source">
1109 <ul class="dummy">
1110 <li>
1111 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1112 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-158">line 158</a>
1113 </li>
1114 </ul>
1115 </dd>
1116
1117
1118
1119
1120
1121
1122
1123</dl>
1124
1125
1126
1127</dd>
1128
1129
1130
1131<hr>
1132<dt class="name" id="loop">
1133 <h4 id="loop"><span class="type-signature">&lt;readonly> </span>loop<span class="type-signature"> :boolean</span></h4>
1134
1135
1136</dt>
1137<dd>
1138
1139 <div class="description">
1140 <p>Defines whether the file loops by default when the audio is played or not. Its value will be modified automatically whenever the <a href="CB_AudioFile_API.WAAPI.html#play"><code>CB_AudioFile_API.WAAPI#play</code></a> method is called, getting the value from the &quot;loop&quot; parameter (but only if contains a boolean).</p>
1141 </div>
1142
1143
1144
1145 <h5>Type:</h5>
1146 <ul>
1147 <li>
1148
1149<span class="param-type">boolean</span>
1150
1151
1152
1153 </li>
1154 </ul>
1155
1156
1157
1158<dl class="details">
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1185 <dd class="tag-default">
1186 <ul class="dummy">
1187 <li><a href="CB_AudioFile_API.WAAPI.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.WAAPI.prototype.DEFAULT_OPTIONS</code></a>.loop</li>
1188 </ul>
1189 </dd>
1190
1191
1192
1193
1194
1195 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1196 <dd class="tag-source">
1197 <ul class="dummy">
1198 <li>
1199 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1200 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-68">line 68</a>
1201 </li>
1202 </ul>
1203 </dd>
1204
1205
1206
1207
1208
1209
1210
1211</dl>
1212
1213
1214
1215</dd>
1216
1217
1218
1219<hr>
1220<dt class="name" id="onStopFunction">
1221 <h4 id="onStopFunction"><span class="type-signature">&lt;readonly> </span>onStopFunction<span class="type-signature"> :function</span></h4>
1222
1223
1224</dt>
1225<dd>
1226
1227 <div class="description">
1228 <p>Function to call when the audio stops.</p>
1229 </div>
1230
1231
1232
1233 <h5>Type:</h5>
1234 <ul>
1235 <li>
1236
1237<span class="param-type">function</span>
1238
1239
1240
1241 </li>
1242 </ul>
1243
1244
1245
1246<dl class="details">
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
1275
1276 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1277 <dd class="tag-source">
1278 <ul class="dummy">
1279 <li>
1280 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1281 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-140">line 140</a>
1282 </li>
1283 </ul>
1284 </dd>
1285
1286
1287
1288
1289
1290
1291
1292</dl>
1293
1294
1295
1296</dd>
1297
1298
1299
1300<hr>
1301<dt class="name" id="paused">
1302 <h4 id="paused"><span class="type-signature">&lt;readonly> </span>paused<span class="type-signature"> :boolean</span></h4>
1303
1304
1305</dt>
1306<dd>
1307
1308 <div class="description">
1309 <p>Tells whether the audio is paused or not.</p>
1310 </div>
1311
1312
1313
1314 <h5>Type:</h5>
1315 <ul>
1316 <li>
1317
1318<span class="param-type">boolean</span>
1319
1320
1321
1322 </li>
1323 </ul>
1324
1325
1326
1327<dl class="details">
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1354 <dd class="tag-default">
1355 <ul class="dummy">
1356 <li>false</li>
1357 </ul>
1358 </dd>
1359
1360
1361
1362
1363
1364 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1365 <dd class="tag-source">
1366 <ul class="dummy">
1367 <li>
1368 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1369 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-113">line 113</a>
1370 </li>
1371 </ul>
1372 </dd>
1373
1374
1375
1376
1377
1378
1379
1380</dl>
1381
1382
1383
1384</dd>
1385
1386
1387
1388<hr>
1389<dt class="name" id="pauseTime">
1390 <h4 id="pauseTime"><span class="type-signature">&lt;readonly> </span>pauseTime<span class="type-signature"> :number</span></h4>
1391
1392
1393</dt>
1394<dd>
1395
1396 <div class="description">
1397 <p>Stores the time (in milliseconds) when the audio has been paused.</p>
1398 </div>
1399
1400
1401
1402 <h5>Type:</h5>
1403 <ul>
1404 <li>
1405
1406<span class="param-type">number</span>
1407
1408
1409
1410 </li>
1411 </ul>
1412
1413
1414
1415<dl class="details">
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1446 <dd class="tag-source">
1447 <ul class="dummy">
1448 <li>
1449 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1450 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-122">line 122</a>
1451 </li>
1452 </ul>
1453 </dd>
1454
1455
1456
1457
1458
1459
1460
1461</dl>
1462
1463
1464
1465</dd>
1466
1467
1468
1469<hr>
1470<dt class="name" id="progressDownloading">
1471 <h4 id="progressDownloading"><span class="type-signature">&lt;readonly> </span>progressDownloading<span class="type-signature"> :number</span></h4>
1472
1473
1474</dt>
1475<dd>
1476
1477 <div class="description">
1478 <p>Progress of the loading process (or downloading through <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR</a>) the audio data, used by the &quot;WAAPI&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API">HTML5 Web Audio API</a>). Internal usage only recommended (use the <a href="CB_AudioFile_API.WAAPI.html#getProgress"><code>CB_AudioFile_API.WAAPI#getProgress</code></a> method instead to know the progress).</p>
1479 </div>
1480
1481
1482
1483 <h5>Type:</h5>
1484 <ul>
1485 <li>
1486
1487<span class="param-type">number</span>
1488
1489
1490
1491 </li>
1492 </ul>
1493
1494
1495
1496<dl class="details">
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1523 <dd class="tag-default">
1524 <ul class="dummy">
1525 <li>0</li>
1526 </ul>
1527 </dd>
1528
1529
1530
1531
1532
1533 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1534 <dd class="tag-source">
1535 <ul class="dummy">
1536 <li>
1537 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1538 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-195">line 195</a>
1539 </li>
1540 </ul>
1541 </dd>
1542
1543
1544
1545
1546
1547
1548
1549</dl>
1550
1551
1552
1553</dd>
1554
1555
1556
1557<hr>
1558<dt class="name" id="source">
1559 <h4 id="source"><span class="type-signature">&lt;readonly> </span>source<span class="type-signature"> :AudioBufferSourceNode</span></h4>
1560
1561
1562</dt>
1563<dd>
1564
1565 <div class="description">
1566 <p>Stores the &quot;source&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode">AudioBufferSourceNode</a> object) of the audio, used by the &quot;WAAPI&quot; (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API">HTML5 Web Audio API</a>).</p>
1567 </div>
1568
1569
1570
1571 <h5>Type:</h5>
1572 <ul>
1573 <li>
1574
1575<span class="param-type">AudioBufferSourceNode</span>
1576
1577
1578
1579 </li>
1580 </ul>
1581
1582
1583
1584<dl class="details">
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1615 <dd class="tag-source">
1616 <ul class="dummy">
1617 <li>
1618 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1619 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-167">line 167</a>
1620 </li>
1621 </ul>
1622 </dd>
1623
1624
1625
1626
1627
1628
1629
1630</dl>
1631
1632
1633
1634</dd>
1635
1636
1637
1638<hr>
1639<dt class="name" id="status">
1640 <h4 id="status"><span class="type-signature">&lt;readonly> </span>status<span class="type-signature"> :integer</span></h4>
1641
1642
1643</dt>
1644<dd>
1645
1646 <div class="description">
1647 <p>Tells whether the file is unloaded (<a href="CB_AudioFile.html#.UNLOADED"><code>CB_AudioFile.UNLOADED</code></a>), loading (<a href="CB_AudioFile.html#.LOADING"><code>CB_AudioFile.LOADING</code></a>), unchecked (<a href="CB_AudioFile.html#.UNCHECKED"><code>CB_AudioFile.UNCHECKED</code></a>), checking (<a href="CB_AudioFile.html#.CHECKING"><code>CB_AudioFile.CHECKING</code></a>), loaded (<a href="CB_AudioFile.html#.LOADED"><code>CB_AudioFile.LOADED</code></a>), failed (<a href="CB_AudioFile.html#.FAILED"><code>CB_AudioFile.FAILED</code></a>) or aborted (<a href="CB_AudioFile.html#.ABORTED"><code>CB_AudioFile.ABORTED</code></a>).</p>
1648 </div>
1649
1650
1651
1652 <h5>Type:</h5>
1653 <ul>
1654 <li>
1655
1656<span class="param-type">integer</span>
1657
1658
1659
1660 </li>
1661 </ul>
1662
1663
1664
1665<dl class="details">
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
1691 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1692 <dd class="tag-default">
1693 <ul class="dummy">
1694 <li><a href="CB_AudioFile.html#.UNLOADED"><code>CB_AudioFile.UNLOADED</code></a></li>
1695 </ul>
1696 </dd>
1697
1698
1699
1700
1701
1702 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1703 <dd class="tag-source">
1704 <ul class="dummy">
1705 <li>
1706 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1707 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-59">line 59</a>
1708 </li>
1709 </ul>
1710 </dd>
1711
1712
1713
1714
1715
1716
1717
1718</dl>
1719
1720
1721
1722</dd>
1723
1724
1725
1726<hr>
1727<dt class="name" id="stopped">
1728 <h4 id="stopped"><span class="type-signature">&lt;readonly> </span>stopped<span class="type-signature"> :boolean</span></h4>
1729
1730
1731</dt>
1732<dd>
1733
1734 <div class="description">
1735 <p>Tells whether the audio is stopped or not.</p>
1736 </div>
1737
1738
1739
1740 <h5>Type:</h5>
1741 <ul>
1742 <li>
1743
1744<span class="param-type">boolean</span>
1745
1746
1747
1748 </li>
1749 </ul>
1750
1751
1752
1753<dl class="details">
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1780 <dd class="tag-default">
1781 <ul class="dummy">
1782 <li>true</li>
1783 </ul>
1784 </dd>
1785
1786
1787
1788
1789
1790 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1791 <dd class="tag-source">
1792 <ul class="dummy">
1793 <li>
1794 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1795 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-131">line 131</a>
1796 </li>
1797 </ul>
1798 </dd>
1799
1800
1801
1802
1803
1804
1805
1806</dl>
1807
1808
1809
1810</dd>
1811
1812
1813
1814<hr>
1815<dt class="name" id="volume">
1816 <h4 id="volume"><span class="type-signature">&lt;readonly> </span>volume<span class="type-signature"> :number</span></h4>
1817
1818
1819</dt>
1820<dd>
1821
1822 <div class="description">
1823 <p>Stores the volume of this audio. Accepted values go from 0 to MAX_VOLUME, where MAX_VOLUME is 100 if the <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM</code></a> property is false or otherwise MAX_VOLUME is the returning value of the <a href="CB_Speaker.html#.getVolume"><code>CB_Speaker.getVolume</code></a> function.</p>
1824 </div>
1825
1826
1827
1828 <h5>Type:</h5>
1829 <ul>
1830 <li>
1831
1832<span class="param-type">number</span>
1833
1834
1835
1836 </li>
1837 </ul>
1838
1839
1840
1841<dl class="details">
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1868 <dd class="tag-default">
1869 <ul class="dummy">
1870 <li><a href="CB_AudioFile_API.WAAPI.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.WAAPI.prototype.DEFAULT_OPTIONS</code></a>.volume</li>
1871 </ul>
1872 </dd>
1873
1874
1875
1876
1877
1878 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1879 <dd class="tag-source">
1880 <ul class="dummy">
1881 <li>
1882 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1883 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-77">line 77</a>
1884 </li>
1885 </ul>
1886 </dd>
1887
1888
1889
1890
1891
1892
1893
1894</dl>
1895
1896
1897
1898</dd>
1899
1900
1901
1902<hr>
1903<dt class="name" id="volumeBeforeMute">
1904 <h4 id="volumeBeforeMute"><span class="type-signature">&lt;readonly> </span>volumeBeforeMute<span class="type-signature"> :number</span></h4>
1905
1906
1907</dt>
1908<dd>
1909
1910 <div class="description">
1911 <p>Stores the volume of this audio before it was muted (to restore it later). Valid values go from 0 to MAX_VOLUME, where MAX_VOLUME is 100 if the <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM</code></a> property is false or otherwise MAX_VOLUME is the returning value of the <a href="CB_Speaker.html#.getVolume"><code>CB_Speaker.getVolume</code></a> function.</p>
1912 </div>
1913
1914
1915
1916 <h5>Type:</h5>
1917 <ul>
1918 <li>
1919
1920<span class="param-type">number</span>
1921
1922
1923
1924 </li>
1925 </ul>
1926
1927
1928
1929<dl class="details">
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
1956 <dd class="tag-default">
1957 <ul class="dummy">
1958 <li><a href="CB_AudioFile_API.WAAPI.html#volume"><code>CB_AudioFile_API.WAAPI#volume</code></a></li>
1959 </ul>
1960 </dd>
1961
1962
1963
1964
1965
1966 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1967 <dd class="tag-source">
1968 <ul class="dummy">
1969 <li>
1970 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
1971 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-86">line 86</a>
1972 </li>
1973 </ul>
1974 </dd>
1975
1976
1977
1978
1979
1980
1981
1982</dl>
1983
1984
1985
1986</dd>
1987
1988 </dl>
1989
1990
1991
1992 <h3 class="subsection-title">Methods</h3>
1993
1994 <dl>
1995
1996<hr>
1997<dt>
1998 <h4 class="name" id="checkPlaying"><span class="type-signature"></span>checkPlaying<span class="signature">( [callbackOk] [, callbackError] [, ignoreStatus] [, ignoreQueue] [, useCache])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1999
2000
2001</dt>
2002<dd>
2003
2004
2005 <div class="description">
2006 <p>Checks whether the audio can be played or not. Recommended to be called through a user-driven event (as onClick, onTouch, etc.), as some web clients may need this at least the first time in order to be able to play the audio. Also recommended to use before calling the <a href="CB_AudioFile_API.WAAPI.html#play"><code>CB_AudioFile_API.WAAPI#play</code></a> method the first time. The checking action will only be performed if the value of the <a href="CB_AudioFile_API.WAAPI.html#status"><code>CB_AudioFile_API.WAAPI#status</code></a> property belongs to the <a href="CB_AudioFile.html#.UNCHECKED"><code>CB_AudioFile.UNCHECKED</code></a> or to the <a href="CB_AudioFile.html#.CHECKING"><code>CB_AudioFile.CHECKING</code></a> value. After checking, if the audio can be played, the <a href="CB_AudioFile_API.WAAPI.html#status"><code>CB_AudioFile_API.WAAPI#status</code></a> of the 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 <a href="CB_AudioFile_API.WAAPI.html#status"><code>CB_AudioFile_API.WAAPI#status</code></a> property will get the value of {CB_AudioFile.FAILED}.</p>
2007 </div>
2008
2009
2010
2011
2012
2013
2014
2015
2016 <h5>Parameters:</h5>
2017
2018
2019<table class="params table table-striped">
2020 <thead>
2021 <tr>
2022
2023 <th style="width:12%; min-width:110px;">Name</th>
2024
2025
2026 <th style="width:12%; min-width:110px;">Type</th>
2027
2028
2029 <th style="width:12%; min-width:110px;">Argument</th>
2030
2031
2032
2033 <th style="width:12%; min-width:110px;">Default</th>
2034
2035
2036 <th class="last" style="min-width:310px;">Description</th>
2037 </tr>
2038 </thead>
2039
2040 <tbody>
2041
2042
2043 <tr>
2044
2045 <td class="name" style="width:12%; min-width:110px; 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>
2046
2047
2048 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2049
2050
2051<span class="param-type">function</span>
2052
2053
2054
2055
2056 </td>
2057
2058
2059 <td class="attributes" style="width:12%; min-width: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 &lt;optional><br>
2062
2063
2064
2065
2066
2067 </td>
2068
2069
2070
2071 <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;">
2072
2073 </td>
2074
2075
2076 <td class="description last" style="min-width:310px; 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 with no parameters to be called when the audio has been checked successfully, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object itself.</p></td>
2077 </tr>
2078
2079
2080
2081 <tr>
2082
2083 <td class="name" style="width:12%; min-width:110px; 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>
2084
2085
2086 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2087
2088
2089<span class="param-type">function</span>
2090
2091
2092
2093
2094 </td>
2095
2096
2097 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2098
2099 &lt;optional><br>
2100
2101
2102
2103
2104
2105 </td>
2106
2107
2108
2109 <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;">
2110
2111 </td>
2112
2113
2114 <td class="description last" style="min-width:310px; 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 to be called if the audio has not been checked successfully. The first and unique parameter will be a string describing the error found (if it could be determined), being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object itself.</p></td>
2115 </tr>
2116
2117
2118
2119 <tr>
2120
2121 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>ignoreStatus</code></td>
2122
2123
2124 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2125
2126
2127<span class="param-type">boolean</span>
2128
2129
2130
2131
2132 </td>
2133
2134
2135 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2136
2137 &lt;optional><br>
2138
2139
2140
2141
2142
2143 </td>
2144
2145
2146
2147 <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;">
2148
2149 false
2150
2151 </td>
2152
2153
2154 <td class="description last" style="min-width:310px; 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 and the <a href="CB_AudioFile_API.WAAPI.html#status"><code>CB_AudioFile_API.WAAPI#status</code></a> property does not belong neither to the &quot;UNCHECKED&quot; status (defined in the <a href="CB_AudioFile.html#.UNCHECKED"><code>CB_AudioFile.UNCHECKED</code></a> constant) nor to the &quot;CHECKING&quot; status (defined in the <a href="CB_AudioFile.html#.CHECKING"><code>CB_AudioFile.CHECKING</code></a> constant), it will fail calling the &quot;callbackError&quot; function (if any). If set to true, it will try to perform the checking action regardless the status of the audio.</p></td>
2155 </tr>
2156
2157
2158
2159 <tr>
2160
2161 <td class="name" style="width:12%; min-width:110px; 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>
2162
2163
2164 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2165
2166
2167<span class="param-type">boolean</span>
2168
2169
2170
2171
2172 </td>
2173
2174
2175 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2176
2177 &lt;optional><br>
2178
2179
2180
2181
2182
2183 </td>
2184
2185
2186
2187 <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;">
2188
2189 false
2190
2191 </td>
2192
2193
2194 <td class="description last" style="min-width:310px; 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 and there is already the maximum number of audio files being checked (defined internally), the function will exit and it will call itself automatically again and again until the checking process can be performed (when its queue turn has been reached). This is done for performance purposes.</p></td>
2195 </tr>
2196
2197
2198
2199 <tr>
2200
2201 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useCache</code></td>
2202
2203
2204 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2205
2206
2207<span class="param-type">boolean</span>
2208
2209
2210
2211
2212 </td>
2213
2214
2215 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2216
2217 &lt;optional><br>
2218
2219
2220
2221
2222
2223 </td>
2224
2225
2226
2227 <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;">
2228
2229 false
2230
2231 </td>
2232
2233
2234 <td class="description last" style="min-width:310px; 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) and the same audio file was checked previously, it will not perform the checking process again and it will do the same as the previous call.</p></td>
2235 </tr>
2236
2237
2238 </tbody>
2239</table>
2240
2241
2242
2243
2244<dl class="details">
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2275 <dd class="tag-source">
2276 <ul class="dummy">
2277 <li>
2278 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
2279 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-721">line 721</a>
2280 </li>
2281 </ul>
2282 </dd>
2283
2284
2285
2286
2287
2288
2289
2290</dl>
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304 <h5>Returns:</h5>
2305
2306
2307<div class="param-desc">
2308 <p>Returns false if the checking could not be performed and failed. If it returns true, it can mean either the checking has been processed successfully or it will fail in the future, so it is recommended to ignore the returning value and use the callback functions instead.</p>
2309</div>
2310
2311
2312
2313<dl>
2314 <dt>
2315 Type
2316 </dt>
2317 <dd>
2318
2319<span class="param-type">boolean</span>
2320
2321
2322
2323 </dd>
2324</dl>
2325
2326
2327
2328
2329
2330</dd>
2331
2332
2333
2334<hr>
2335<dt>
2336 <h4 class="name" id="decodeAudioData"><span class="type-signature"></span>decodeAudioData<span class="signature">(binaryData [, callbackOk] [, callbackError])</span><span class="type-signature"> &rarr; {undefined|Promise}</span></h4>
2337
2338
2339</dt>
2340<dd>
2341
2342
2343 <div class="description">
2344 <p>Decodes binary audio data given. Internal usage only recommended.</p>
2345 </div>
2346
2347
2348
2349
2350
2351
2352
2353
2354 <h5>Parameters:</h5>
2355
2356
2357<table class="params table table-striped">
2358 <thead>
2359 <tr>
2360
2361 <th style="width:12%; min-width:110px;">Name</th>
2362
2363
2364 <th style="width:12%; min-width:110px;">Type</th>
2365
2366
2367 <th style="width:12%; min-width:110px;">Argument</th>
2368
2369
2370
2371
2372 <th class="last" style="min-width:310px;">Description</th>
2373 </tr>
2374 </thead>
2375
2376 <tbody>
2377
2378
2379 <tr>
2380
2381 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>binaryData</code></td>
2382
2383
2384 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2385
2386
2387<span class="param-type">ArrayBuffer</span>
2388
2389
2390
2391
2392 </td>
2393
2394
2395 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2396
2397
2398
2399
2400
2401 </td>
2402
2403
2404
2405
2406 <td class="description last" style="min-width:310px; 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 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer">ArrayBuffer</a> with the audio data to be decoded.</p></td>
2407 </tr>
2408
2409
2410
2411 <tr>
2412
2413 <td class="name" style="width:12%; min-width:110px; 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>
2414
2415
2416 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2417
2418
2419<span class="param-type">function</span>
2420
2421
2422
2423
2424 </td>
2425
2426
2427 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2428
2429 &lt;optional><br>
2430
2431
2432
2433
2434
2435 </td>
2436
2437
2438
2439
2440 <td class="description last" style="min-width:310px; 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 with no parameters to be called when the audio data has been decoded successfully, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object itself.</p></td>
2441 </tr>
2442
2443
2444
2445 <tr>
2446
2447 <td class="name" style="width:12%; min-width:110px; 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>
2448
2449
2450 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2451
2452
2453<span class="param-type">function</span>
2454
2455
2456
2457
2458 </td>
2459
2460
2461 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2462
2463 &lt;optional><br>
2464
2465
2466
2467
2468
2469 </td>
2470
2471
2472
2473
2474 <td class="description last" style="min-width:310px; 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 to be called if the audio data has not been decoded successfully. The first and unique parameter will be a string describing the error found (if it could be determined), being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object itself.</p></td>
2475 </tr>
2476
2477
2478 </tbody>
2479</table>
2480
2481
2482
2483
2484<dl class="details">
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2515 <dd class="tag-source">
2516 <ul class="dummy">
2517 <li>
2518 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
2519 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-666">line 666</a>
2520 </li>
2521 </ul>
2522 </dd>
2523
2524
2525
2526
2527
2528
2529
2530</dl>
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544 <h5>Returns:</h5>
2545
2546
2547<div class="param-desc">
2548 <p>Returns the returning value of calling the <a href="https://developer.mozilla.org/en-US/docs/Web/API/BaseAudioContext/decodeAudioData">BaseAudioContext.decodeAudioData</a> function, which returns void (undefined) or a <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a> (whose methods &quot;then&quot; and &quot;catch&quot; will have already been used internally by this function).</p>
2549</div>
2550
2551
2552
2553<dl>
2554 <dt>
2555 Type
2556 </dt>
2557 <dd>
2558
2559<span class="param-type">undefined</span>
2560|
2561
2562<span class="param-type">Promise</span>
2563
2564
2565
2566 </dd>
2567</dl>
2568
2569
2570
2571
2572
2573</dd>
2574
2575
2576
2577<hr>
2578<dt>
2579 <h4 class="name" id="destructor"><span class="type-signature"></span>destructor<span class="signature">( [stopSound] [, keepStoppedUnaltered] [, avoidOnStop] [, forceOnStop])</span><span class="type-signature"></span></h4>
2580
2581
2582</dt>
2583<dd>
2584
2585
2586 <div class="description">
2587 <p>Destroys the audio file object and frees memory. Sets its current <a href="CB_AudioFile_API.WAAPI.html#status"><code>CB_AudioFile_API.WAAPI#status</code></a> property to ABORTED (<a href="CB_AudioFile.html#.ABORTED"><code>CB_AudioFile.ABORTED</code></a> value).</p>
2588 </div>
2589
2590
2591
2592
2593
2594
2595
2596
2597 <h5>Parameters:</h5>
2598
2599
2600<table class="params table table-striped">
2601 <thead>
2602 <tr>
2603
2604 <th style="width:12%; min-width:110px;">Name</th>
2605
2606
2607 <th style="width:12%; min-width:110px;">Type</th>
2608
2609
2610 <th style="width:12%; min-width:110px;">Argument</th>
2611
2612
2613
2614 <th style="width:12%; min-width:110px;">Default</th>
2615
2616
2617 <th class="last" style="min-width:310px;">Description</th>
2618 </tr>
2619 </thead>
2620
2621 <tbody>
2622
2623
2624 <tr>
2625
2626 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>stopSound</code></td>
2627
2628
2629 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2630
2631
2632<span class="param-type">boolean</span>
2633
2634
2635
2636
2637 </td>
2638
2639
2640 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2641
2642 &lt;optional><br>
2643
2644
2645
2646
2647
2648 </td>
2649
2650
2651
2652 <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;">
2653
2654 false
2655
2656 </td>
2657
2658
2659 <td class="description last" style="min-width:310px; 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 call the <a href="CB_AudioFile_API.WAAPI.html#stop"><code>CB_AudioFile_API.WAAPI#stop</code></a> method.</p></td>
2660 </tr>
2661
2662
2663
2664 <tr>
2665
2666 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepStoppedUnaltered</code></td>
2667
2668
2669 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2670
2671
2672<span class="param-type">boolean</span>
2673
2674
2675
2676
2677 </td>
2678
2679
2680 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2681
2682 &lt;optional><br>
2683
2684
2685
2686
2687
2688 </td>
2689
2690
2691
2692 <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;">
2693
2694 false
2695
2696 </td>
2697
2698
2699 <td class="description last" style="min-width:310px; 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;keepStoppedUnaltered&quot; parameter to call the <a href="CB_AudioFile_API.WAAPI.html#stop"><code>CB_AudioFile_API.WAAPI#stop</code></a> method. If the &quot;stopSound&quot; parameter is not set to true, this parameter will be ignored as the &quot;stop&quot; method will not be called.</p></td>
2700 </tr>
2701
2702
2703
2704 <tr>
2705
2706 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidOnStop</code></td>
2707
2708
2709 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2710
2711
2712<span class="param-type">boolean</span>
2713
2714
2715
2716
2717 </td>
2718
2719
2720 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2721
2722 &lt;optional><br>
2723
2724
2725
2726
2727
2728 </td>
2729
2730
2731
2732 <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;">
2733
2734 false
2735
2736 </td>
2737
2738
2739 <td class="description last" style="min-width:310px; 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;avoidOnStop&quot; parameter to call the <a href="CB_AudioFile_API.WAAPI.html#stop"><code>CB_AudioFile_API.WAAPI#stop</code></a> method. If the &quot;stopSound&quot; parameter is not set to true, this parameter will be ignored as the &quot;stop&quot; method will not be called.</p></td>
2740 </tr>
2741
2742
2743
2744 <tr>
2745
2746 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>forceOnStop</code></td>
2747
2748
2749 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2750
2751
2752<span class="param-type">boolean</span>
2753
2754
2755
2756
2757 </td>
2758
2759
2760 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2761
2762 &lt;optional><br>
2763
2764
2765
2766
2767
2768 </td>
2769
2770
2771
2772 <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;">
2773
2774 false
2775
2776 </td>
2777
2778
2779 <td class="description last" style="min-width:310px; 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;forceOnStop&quot; parameter to call the <a href="CB_AudioFile_API.WAAPI.html#stop"><code>CB_AudioFile_API.WAAPI#stop</code></a> method. If the &quot;stopSound&quot; parameter is not set to true, this parameter will be ignored as the &quot;stop&quot; method will not be called.</p></td>
2780 </tr>
2781
2782
2783 </tbody>
2784</table>
2785
2786
2787
2788
2789<dl class="details">
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2820 <dd class="tag-source">
2821 <ul class="dummy">
2822 <li>
2823 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
2824 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-289">line 289</a>
2825 </li>
2826 </ul>
2827 </dd>
2828
2829
2830
2831
2832
2833
2834
2835</dl>
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851</dd>
2852
2853
2854
2855<hr>
2856<dt>
2857 <h4 class="name" id="getCurrentTime"><span class="type-signature"></span>getCurrentTime<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
2858
2859
2860</dt>
2861<dd>
2862
2863
2864 <div class="description">
2865 <p>Gets the current time (in milliseconds) which belongs to the position where the audio is currently playing or where it has been paused. Note that some audio APIs and clients could give wrong values.</p>
2866 </div>
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877<dl class="details">
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2908 <dd class="tag-source">
2909 <ul class="dummy">
2910 <li>
2911 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
2912 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-1277">line 1277</a>
2913 </li>
2914 </ul>
2915 </dd>
2916
2917
2918
2919
2920
2921
2922
2923</dl>
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937 <h5>Returns:</h5>
2938
2939
2940<div class="param-desc">
2941 <p>Returns the current time (in milliseconds). Note that some audio APIs and clients could give wrong values.</p>
2942</div>
2943
2944
2945
2946<dl>
2947 <dt>
2948 Type
2949 </dt>
2950 <dd>
2951
2952<span class="param-type">number</span>
2953
2954
2955
2956 </dd>
2957</dl>
2958
2959
2960
2961
2962
2963</dd>
2964
2965
2966
2967<hr>
2968<dt>
2969 <h4 class="name" id="getDuration"><span class="type-signature"></span>getDuration<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
2970
2971
2972</dt>
2973<dd>
2974
2975
2976 <div class="description">
2977 <p>Tells the duration of the audio (in milliseconds). Note that some clients might not calculate the duration correctly and, in this case, a zero (0) value would be returned.</p>
2978 </div>
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989<dl class="details">
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3020 <dd class="tag-source">
3021 <ul class="dummy">
3022 <li>
3023 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
3024 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-890">line 890</a>
3025 </li>
3026 </ul>
3027 </dd>
3028
3029
3030
3031
3032
3033
3034
3035</dl>
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049 <h5>Returns:</h5>
3050
3051
3052<div class="param-desc">
3053 <p>Returns the duration of the audio (in milliseconds). Note that some clients might not calculate the duration correctly and, in this case, a zero (0) value would be returned.</p>
3054</div>
3055
3056
3057
3058<dl>
3059 <dt>
3060 Type
3061 </dt>
3062 <dd>
3063
3064<span class="param-type">number</span>
3065
3066
3067
3068 </dd>
3069</dl>
3070
3071
3072
3073
3074
3075</dd>
3076
3077
3078
3079<hr>
3080<dt>
3081 <h4 class="name" id="getProgress"><span class="type-signature"></span>getProgress<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
3082
3083
3084</dt>
3085<dd>
3086
3087
3088 <div class="description">
3089 <p>Returns a number representing the percentage of the loading progress for the audio file (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>
3090 </div>
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101<dl class="details">
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3132 <dd class="tag-source">
3133 <ul class="dummy">
3134 <li>
3135 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
3136 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-1353">line 1353</a>
3137 </li>
3138 </ul>
3139 </dd>
3140
3141
3142
3143
3144
3145
3146
3147</dl>
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161 <h5>Returns:</h5>
3162
3163
3164<div class="param-desc">
3165 <p>Returns a number representing the percentage of the loading progress for the audio file (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>
3166</div>
3167
3168
3169
3170<dl>
3171 <dt>
3172 Type
3173 </dt>
3174 <dd>
3175
3176<span class="param-type">number</span>
3177
3178
3179
3180 </dd>
3181</dl>
3182
3183
3184
3185
3186
3187</dd>
3188
3189
3190
3191<hr>
3192<dt>
3193 <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">( [filePath] [, autoPlay] [, callbackOk] [, callbackError] [, forceReload] [, useXHR] [, useCache])</span><span class="type-signature"> &rarr; {<a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a>|null}</span></h4>
3194
3195
3196</dt>
3197<dd>
3198
3199
3200 <div class="description">
3201 <p>Loads the desired audio file with the desired options. Recommended to be called through a user-driven event (as onClick, onTouch, etc.), as some web clients may need this at least the first time in order to be able to play the audio. Uses <a href="https://gist.github.com/htchaan/108b7aa6b71eb03e38019e64450ea095">Base64Binary</a> internally. This method will be called automatically by the constructor if the &quot;autoLoad&quot; option was set to true in its given &quot;options&quot; parameter.<br>When this method is called, if the <a href="CB_AudioFile_API.WAAPI.html#status"><code>CB_AudioFile_API.WAAPI#status</code></a> property already has the &quot;LOADED&quot; status (defined in the <a href="CB_AudioFile.html#.LOADED"><code>CB_AudioFile.LOADED</code></a> constant) and the &quot;forceReload&quot; parameter is not set to true, it will exit calling the given &quot;callbackOk&quot; function (if any) immediately. Otherwise, regardless the status, the status will be set to &quot;LOADING&quot; (defined in the <a href="CB_AudioFile.html#.LOADING"><code>CB_AudioFile.LOADING</code></a> constant). After it, it will reach the &quot;UNCHECKED&quot; (defined in the <a href="CB_AudioFile.html#.UNCHECKED"><code>CB_AudioFile.UNCHECKED</code></a> constant). If the &quot;autoPlay&quot; parameter is not set to true, this will be the final status (and it will be necessary to call the <a href="CB_AudioFile_API.WAAPI.html#checkPlaying"><code>CB_AudioFile_API.WAAPI#checkPlaying</code></a> method after it). After it and only if the &quot;autoPlay&quot; is set to true, as the <a href="CB_AudioFile_API.WAAPI.html#checkPlaying"><code>CB_AudioFile_API.WAAPI#checkPlaying</code></a> method will be called internally, it will have the &quot;CHECKING&quot; status (defined in the <a href="CB_AudioFile.html#.CHECKING"><code>CB_AudioFile.CHECKING</code></a> constant) and finally the &quot;LOADED&quot; status (defined in the <a href="CB_AudioFile.html#.LOADED"><code>CB_AudioFile.LOADED</code></a> constant) if all goes well.</p>
3202 </div>
3203
3204
3205
3206
3207
3208
3209
3210
3211 <h5>Parameters:</h5>
3212
3213
3214<table class="params table table-striped">
3215 <thead>
3216 <tr>
3217
3218 <th style="width:12%; min-width:110px;">Name</th>
3219
3220
3221 <th style="width:12%; min-width:110px;">Type</th>
3222
3223
3224 <th style="width:12%; min-width:110px;">Argument</th>
3225
3226
3227
3228 <th style="width:12%; min-width:110px;">Default</th>
3229
3230
3231 <th class="last" style="min-width:310px;">Description</th>
3232 </tr>
3233 </thead>
3234
3235 <tbody>
3236
3237
3238 <tr>
3239
3240 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>filePath</code></td>
3241
3242
3243 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3244
3245
3246<span class="param-type">string</span>
3247
3248
3249
3250
3251 </td>
3252
3253
3254 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3255
3256 &lt;optional><br>
3257
3258
3259
3260
3261
3262 </td>
3263
3264
3265
3266 <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;">
3267
3268 <a href="CB_AudioFile_API.WAAPI.html#filePath"><code>CB_AudioFile_API.WAAPI#filePath</code></a>
3269
3270 </td>
3271
3272
3273 <td class="description last" style="min-width:310px; 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 path of the audio file or a data URI. NOTE: Only some clients with some audio APIs will support data URIs.</p></td>
3274 </tr>
3275
3276
3277
3278 <tr>
3279
3280 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>autoPlay</code></td>
3281
3282
3283 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3284
3285
3286<span class="param-type">string</span>
3287
3288
3289
3290
3291 </td>
3292
3293
3294 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3295
3296 &lt;optional><br>
3297
3298
3299
3300
3301
3302 </td>
3303
3304
3305
3306 <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;">
3307
3308 false
3309
3310 </td>
3311
3312
3313 <td class="description last" style="min-width:310px; 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 start playing the audio automatically (by calling the <a href="CB_AudioFile_API.WAAPI.html#play"><code>CB_AudioFile_API.WAAPI#play</code></a> method internally). If set to true and the <a href="CB_AudioFile_API.WAAPI.html#status"><code>CB_AudioFile_API.WAAPI#status</code></a> property reaches the &quot;UNCHECKED&quot; status (defined in the <a href="CB_AudioFile.html#.UNCHECKED"><code>CB_AudioFile.UNCHECKED</code></a> constant), it will also call internally the <a href="CB_AudioFile_API.WAAPI.html#checkPlaying"><code>CB_AudioFile_API.WAAPI#checkPlaying</code></a> method.</p></td>
3314 </tr>
3315
3316
3317
3318 <tr>
3319
3320 <td class="name" style="width:12%; min-width:110px; 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>
3321
3322
3323 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3324
3325
3326<span class="param-type">function</span>
3327
3328
3329
3330
3331 </td>
3332
3333
3334 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3335
3336 &lt;optional><br>
3337
3338
3339
3340
3341
3342 </td>
3343
3344
3345
3346 <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;">
3347
3348 </td>
3349
3350
3351 <td class="description last" style="min-width:310px; 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 with no parameters to be called when the audio has been loaded successfully, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object itself.</p></td>
3352 </tr>
3353
3354
3355
3356 <tr>
3357
3358 <td class="name" style="width:12%; min-width:110px; 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>
3359
3360
3361 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3362
3363
3364<span class="param-type">function</span>
3365
3366
3367
3368
3369 </td>
3370
3371
3372 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3373
3374 &lt;optional><br>
3375
3376
3377
3378
3379
3380 </td>
3381
3382
3383
3384 <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;">
3385
3386 </td>
3387
3388
3389 <td class="description last" style="min-width:310px; 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 to be called if the audio has not been loaded successfully. The first and unique parameter will be a string describing the error found (if it could be determined), being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object itself.</p></td>
3390 </tr>
3391
3392
3393
3394 <tr>
3395
3396 <td class="name" style="width:12%; min-width:110px; 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>
3397
3398
3399 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3400
3401
3402<span class="param-type">boolean</span>
3403
3404
3405
3406
3407 </td>
3408
3409
3410 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3411
3412 &lt;optional><br>
3413
3414
3415
3416
3417
3418 </td>
3419
3420
3421
3422 <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;">
3423
3424 false
3425
3426 </td>
3427
3428
3429 <td class="description last" style="min-width:310px; 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, the &quot;filePath&quot; has not been changed from the previously used and the <a href="CB_AudioFile_API.WAAPI.html#status"><code>CB_AudioFile_API.WAAPI#status</code></a> property belongs to the &quot;LOADED&quot; status (defined in the <a href="CB_AudioFile.html#.LOADED"><code>CB_AudioFile.LOADED</code></a> constant), it will exit the method without loading the audio file again (calling the &quot;callbackOk&quot; function, if any).</p></td>
3430 </tr>
3431
3432
3433
3434 <tr>
3435
3436 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useXHR</code></td>
3437
3438
3439 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3440
3441
3442<span class="param-type">boolean</span>
3443
3444
3445
3446
3447 </td>
3448
3449
3450 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3451
3452 &lt;optional><br>
3453
3454
3455
3456
3457
3458 </td>
3459
3460
3461
3462 <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;">
3463
3464 <a href="CB_AudioFile_API.WAAPI.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS</code></a>.useXHR
3465
3466 </td>
3467
3468
3469 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether to use or not <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest">XHR</a> (<a href="https://en.wikipedia.org/wiki/Ajax_(programming)">AJAX</a>) to load the audio file.</p></td>
3470 </tr>
3471
3472
3473
3474 <tr>
3475
3476 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useCache</code></td>
3477
3478
3479 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3480
3481
3482<span class="param-type">boolean</span>
3483
3484
3485
3486
3487 </td>
3488
3489
3490 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3491
3492 &lt;optional><br>
3493
3494
3495
3496
3497
3498 </td>
3499
3500
3501
3502 <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;">
3503
3504 <a href="CB_AudioFile_API.WAAPI.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS</code></a>.useCache
3505
3506 </td>
3507
3508
3509 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether to try to use or not a cache for performance purposes. If set to true and the audio file was loaded before, it will try to use the cache (if possible) to accelerate the loading process.</p></td>
3510 </tr>
3511
3512
3513 </tbody>
3514</table>
3515
3516
3517
3518
3519<dl class="details">
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3550 <dd class="tag-source">
3551 <ul class="dummy">
3552 <li>
3553 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
3554 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-356">line 356</a>
3555 </li>
3556 </ul>
3557 </dd>
3558
3559
3560
3561
3562
3563
3564
3565</dl>
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579 <h5>Returns:</h5>
3580
3581
3582<div class="param-desc">
3583 <p>Returns the audio API object (if it was possible to create) or null otherwise.</p>
3584</div>
3585
3586
3587
3588<dl>
3589 <dt>
3590 Type
3591 </dt>
3592 <dd>
3593
3594<span class="param-type"><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></span>
3595|
3596
3597<span class="param-type">null</span>
3598
3599
3600
3601 </dd>
3602</dl>
3603
3604
3605
3606
3607
3608</dd>
3609
3610
3611
3612<hr>
3613<dt>
3614 <h4 class="name" id="mute"><span class="type-signature"></span>mute<span class="signature">( [onMute])</span><span class="type-signature"> &rarr; {number}</span></h4>
3615
3616
3617</dt>
3618<dd>
3619
3620
3621 <div class="description">
3622 <p>Mutes the audio file.</p>
3623 </div>
3624
3625
3626
3627
3628
3629
3630
3631
3632 <h5>Parameters:</h5>
3633
3634
3635<table class="params table table-striped">
3636 <thead>
3637 <tr>
3638
3639 <th style="width:12%; min-width:110px;">Name</th>
3640
3641
3642 <th style="width:12%; min-width:110px;">Type</th>
3643
3644
3645 <th style="width:12%; min-width:110px;">Argument</th>
3646
3647
3648
3649
3650 <th class="last" style="min-width:310px;">Description</th>
3651 </tr>
3652 </thead>
3653
3654 <tbody>
3655
3656
3657 <tr>
3658
3659 <td class="name" style="width:12%; min-width:110px; 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>
3660
3661
3662 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3663
3664
3665<span class="param-type">function</span>
3666
3667
3668
3669
3670 </td>
3671
3672
3673 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3674
3675 &lt;optional><br>
3676
3677
3678
3679
3680
3681 </td>
3682
3683
3684
3685
3686 <td class="description last" style="min-width:310px; 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 if it has been possible to mute the audio file (or at least it was possible to try it). It will not receive any parameters, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object.</p></td>
3687 </tr>
3688
3689
3690 </tbody>
3691</table>
3692
3693
3694
3695
3696<dl class="details">
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3727 <dd class="tag-source">
3728 <ul class="dummy">
3729 <li>
3730 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
3731 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-1241">line 1241</a>
3732 </li>
3733 </ul>
3734 </dd>
3735
3736
3737
3738
3739
3740
3741
3742</dl>
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756 <h5>Returns:</h5>
3757
3758
3759<div class="param-desc">
3760 <p>Returns the current volume (from 0 to the maximum value, where the maximum value will be the returning value of calling the <a href="CB_Speaker.html#.getVolume"><code>CB_Speaker.getVolume</code></a> function if the <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM</code></a> property is set to true or it will be 100 otherwise). If all goes well, the returning value should be zero (0). Note that, even when it returns a zero (0) value, this does not always mean that the mute has been applied successfully.</p>
3761</div>
3762
3763
3764
3765<dl>
3766 <dt>
3767 Type
3768 </dt>
3769 <dd>
3770
3771<span class="param-type">number</span>
3772
3773
3774
3775 </dd>
3776</dl>
3777
3778
3779
3780
3781
3782</dd>
3783
3784
3785
3786<hr>
3787<dt>
3788 <h4 class="name" id="onStop"><span class="type-signature"></span>onStop<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3789
3790
3791</dt>
3792<dd>
3793
3794
3795 <div class="description">
3796 <p>Sets a function to execute when the audio file stops playing or removes it.</p>
3797 </div>
3798
3799
3800
3801
3802
3803
3804
3805
3806 <h5>Parameters:</h5>
3807
3808
3809<table class="params table table-striped">
3810 <thead>
3811 <tr>
3812
3813 <th style="width:12%; min-width:110px;">Name</th>
3814
3815
3816 <th style="width:12%; min-width:110px;">Type</th>
3817
3818
3819 <th style="width:12%; min-width:110px;">Argument</th>
3820
3821
3822
3823 <th style="width:12%; min-width:110px;">Default</th>
3824
3825
3826 <th class="last" style="min-width:310px;">Description</th>
3827 </tr>
3828 </thead>
3829
3830 <tbody>
3831
3832
3833 <tr>
3834
3835 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
3836
3837
3838 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3839
3840
3841<span class="param-type">function</span>
3842|
3843
3844<span class="param-type">null</span>
3845
3846
3847
3848
3849 </td>
3850
3851
3852 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3853
3854
3855
3856
3857
3858 </td>
3859
3860
3861
3862 <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;">
3863
3864 </td>
3865
3866
3867 <td class="description last" style="min-width:310px; 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 function (event listener) that we want to execute when the event is fired. No parameters will be received, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object. If a null value is used, the event will be removed.</p></td>
3868 </tr>
3869
3870
3871
3872 <tr>
3873
3874 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
3875
3876
3877 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3878
3879
3880<span class="param-type">boolean</span>
3881
3882
3883
3884
3885 </td>
3886
3887
3888 <td class="attributes" style="width:12%; min-width: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 &lt;optional><br>
3891
3892
3893
3894
3895
3896 </td>
3897
3898
3899
3900 <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;">
3901
3902 true
3903
3904 </td>
3905
3906
3907 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener or not.</p></td>
3908 </tr>
3909
3910
3911 </tbody>
3912</table>
3913
3914
3915
3916
3917<dl class="details">
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3948 <dd class="tag-source">
3949 <ul class="dummy">
3950 <li>
3951 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
3952 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-1316">line 1316</a>
3953 </li>
3954 </ul>
3955 </dd>
3956
3957
3958
3959
3960
3961
3962
3963</dl>
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977 <h5>Returns:</h5>
3978
3979
3980<div class="param-desc">
3981 <p>Returns whether the event has been set or not (removed).</p>
3982</div>
3983
3984
3985
3986<dl>
3987 <dt>
3988 Type
3989 </dt>
3990 <dd>
3991
3992<span class="param-type">boolean</span>
3993
3994
3995
3996 </dd>
3997</dl>
3998
3999
4000
4001
4002
4003</dd>
4004
4005
4006
4007<hr>
4008<dt>
4009 <h4 class="name" id="pause"><span class="type-signature"></span>pause<span class="signature">( [onPause] [, keepPausedUnaltered])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
4010
4011
4012</dt>
4013<dd>
4014
4015
4016 <div class="description">
4017 <p>Pauses the audio when it is being played.</p>
4018 </div>
4019
4020
4021
4022
4023
4024
4025
4026
4027 <h5>Parameters:</h5>
4028
4029
4030<table class="params table table-striped">
4031 <thead>
4032 <tr>
4033
4034 <th style="width:12%; min-width:110px;">Name</th>
4035
4036
4037 <th style="width:12%; min-width:110px;">Type</th>
4038
4039
4040 <th style="width:12%; min-width:110px;">Argument</th>
4041
4042
4043
4044 <th style="width:12%; min-width:110px;">Default</th>
4045
4046
4047 <th class="last" style="min-width:310px;">Description</th>
4048 </tr>
4049 </thead>
4050
4051 <tbody>
4052
4053
4054 <tr>
4055
4056 <td class="name" style="width:12%; min-width:110px; 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>
4057
4058
4059 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4060
4061
4062<span class="param-type">function</span>
4063
4064
4065
4066
4067 </td>
4068
4069
4070 <td class="attributes" style="width:12%; min-width: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 &lt;optional><br>
4073
4074
4075
4076
4077
4078 </td>
4079
4080
4081
4082 <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;">
4083
4084 </td>
4085
4086
4087 <td class="description last" style="min-width:310px; 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_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object.</p></td>
4088 </tr>
4089
4090
4091
4092 <tr>
4093
4094 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepPausedUnaltered</code></td>
4095
4096
4097 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4098
4099
4100<span class="param-type">boolean</span>
4101
4102
4103
4104
4105 </td>
4106
4107
4108 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4109
4110 &lt;optional><br>
4111
4112
4113
4114
4115
4116 </td>
4117
4118
4119
4120 <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;">
4121
4122 false
4123
4124 </td>
4125
4126
4127 <td class="description last" style="min-width:310px; 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), the <a href="CB_AudioFile_API.WAAPI.html#paused"><code>CB_AudioFile_API.WAAPI#paused</code></a> property will not be set to true and it will remain with its current value.</p></td>
4128 </tr>
4129
4130
4131 </tbody>
4132</table>
4133
4134
4135
4136
4137<dl class="details">
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4168 <dd class="tag-source">
4169 <ul class="dummy">
4170 <li>
4171 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
4172 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-1140">line 1140</a>
4173 </li>
4174 </ul>
4175 </dd>
4176
4177
4178
4179
4180
4181
4182
4183</dl>
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197 <h5>Returns:</h5>
4198
4199
4200<div class="param-desc">
4201 <p>It returns false if the audio is already paused or it is stopped or if it cannot be paused. Returns true otherwise.</p>
4202</div>
4203
4204
4205
4206<dl>
4207 <dt>
4208 Type
4209 </dt>
4210 <dd>
4211
4212<span class="param-type">boolean</span>
4213
4214
4215
4216 </dd>
4217</dl>
4218
4219
4220
4221
4222
4223</dd>
4224
4225
4226
4227<hr>
4228<dt>
4229 <h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">( [startAt] [, stopAt] [, loop] [, avoidDelayedPlay] [, allowedRecursiveDelay] [, onPlayStart] [, onLoadError] [, isResume] [, isLooping] [, startPlayingTime])</span><span class="type-signature"> &rarr; {boolean|integer}</span></h4>
4230
4231
4232</dt>
4233<dd>
4234
4235
4236 <div class="description">
4237 <p>Plays the audio.</p>
4238 </div>
4239
4240
4241
4242
4243
4244
4245
4246
4247 <h5>Parameters:</h5>
4248
4249
4250<table class="params table table-striped">
4251 <thead>
4252 <tr>
4253
4254 <th style="width:12%; min-width:110px;">Name</th>
4255
4256
4257 <th style="width:12%; min-width:110px;">Type</th>
4258
4259
4260 <th style="width:12%; min-width:110px;">Argument</th>
4261
4262
4263
4264 <th style="width:12%; min-width:110px;">Default</th>
4265
4266
4267 <th class="last" style="min-width:310px;">Description</th>
4268 </tr>
4269 </thead>
4270
4271 <tbody>
4272
4273
4274 <tr>
4275
4276 <td class="name" style="width:12%; min-width:110px; 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>
4277
4278
4279 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4280
4281
4282<span class="param-type">number</span>
4283
4284
4285
4286
4287 </td>
4288
4289
4290 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4291
4292 &lt;optional><br>
4293
4294
4295
4296
4297
4298 </td>
4299
4300
4301
4302 <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;">
4303
4304 0 | <a href="CB_AudioFile_API.WAAPI.html#lastStartAt"><code>CB_AudioFile_API.WAAPI#lastStartAt</code></a> | stopAt
4305
4306 </td>
4307
4308
4309 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Time in milliseconds where we want the audio to start at. If not provided or it is not a valid number, it will use zero (0) as default which belongs to the beginning of the audio. If the value provided is greater than the &quot;stopAt&quot; provided, it will use the value set in the <a href="CB_AudioFile_API.WAAPI.html#lastStartAt"><code>CB_AudioFile_API.WAAPI#lastStartAt</code></a> property (which belongs to the &quot;startAt&quot; value the last time that this method was called). If, even using the <a href="CB_AudioFile_API.WAAPI.html#lastStartAt"><code>CB_AudioFile_API.WAAPI#lastStartAt</code></a> value is still greather than the &quot;stopAt&quot; provided, it will use the same value as the &quot;stopAt&quot; which means it will not play and will stop immediately.</p></td>
4310 </tr>
4311
4312
4313
4314 <tr>
4315
4316 <td class="name" style="width:12%; min-width:110px; 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>
4317
4318
4319 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4320
4321
4322<span class="param-type">number</span>
4323
4324
4325
4326
4327 </td>
4328
4329
4330 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4331
4332 &lt;optional><br>
4333
4334
4335
4336
4337
4338 </td>
4339
4340
4341
4342 <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;">
4343
4344 <a href="CB_AudioFile_API.WAAPI.html#getDuration"><code>CB_AudioFile_API.WAAPI#getDuration</code></a>()
4345
4346 </td>
4347
4348
4349 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Time in milliseconds where we want the audio to stop at. If not provided or it is not a valid number, it will use the returning value of the <a href="CB_AudioFile_API.WAAPI.html#getDuration"><code>CB_AudioFile_API.WAAPI#getDuration</code></a> method (which should belong to the total duration of the audio, if it was calculated correctly).</p></td>
4350 </tr>
4351
4352
4353
4354 <tr>
4355
4356 <td class="name" style="width:12%; min-width:110px; 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>
4357
4358
4359 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4360
4361
4362<span class="param-type">boolean</span>
4363
4364
4365
4366
4367 </td>
4368
4369
4370 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4371
4372 &lt;optional><br>
4373
4374
4375
4376
4377
4378 </td>
4379
4380
4381
4382 <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;">
4383
4384 <a href="CB_AudioFile_API.WAAPI.html#loop"><code>CB_AudioFile_API.WAAPI#loop</code></a>
4385
4386 </td>
4387
4388
4389 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Sets whether we want to play the audio looping (starting again and again) or just play it once. Note that at the end of each loop the &quot;onStop&quot; function defined (through the <a href="CB_AudioFile_API.WAAPI.html#onStop"><code>CB_AudioFile_API.WAAPI#onStop</code></a> method) will not be called.</p></td>
4390 </tr>
4391
4392
4393
4394 <tr>
4395
4396 <td class="name" style="width:12%; min-width:110px; 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>
4397
4398
4399 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4400
4401
4402<span class="param-type">boolean</span>
4403
4404
4405
4406
4407 </td>
4408
4409
4410 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4411
4412 &lt;optional><br>
4413
4414
4415
4416
4417
4418 </td>
4419
4420
4421
4422 <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;">
4423
4424 false
4425
4426 </td>
4427
4428
4429 <td class="description last" style="min-width:310px; 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 (recommended) and the audio failed previously or was aborted (destroyed), it will try to load it correctly again automatically and play it after that if possible (this can take some time so the audio could start playing after a delay). Otherwise, if set to true and the audio failed or was aborted (destroyed), the audio will not play at all and the &quot;stop&quot; method will be called immediately.</p></td>
4430 </tr>
4431
4432
4433
4434 <tr>
4435
4436 <td class="name" style="width:12%; min-width:110px; 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>
4437
4438
4439 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4440
4441
4442<span class="param-type">boolean</span>
4443
4444
4445
4446
4447 </td>
4448
4449
4450 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4451
4452 &lt;optional><br>
4453
4454
4455
4456
4457
4458 </td>
4459
4460
4461
4462 <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;">
4463
4464 <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>
4465
4466 </td>
4467
4468
4469 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The maximum amount of time (in milliseconds) of delay that we accept before start playing the audio. If the amount of time is overcome, the audio will not play at all and the <a href="CB_AudioFile_API.WAAPI.html#stop"><code>CB_AudioFile_API.WAAPI#stop</code></a> method will be called immediately. Used only when the &quot;avoidDelayedPlay&quot; parameter is set to false and the audio needs to be loaded because it failed previously or was aborted (destroyed).</p></td>
4470 </tr>
4471
4472
4473
4474 <tr>
4475
4476 <td class="name" style="width:12%; min-width:110px; 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>
4477
4478
4479 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4480
4481
4482<span class="param-type">function</span>
4483
4484
4485
4486
4487 </td>
4488
4489
4490 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4491
4492 &lt;optional><br>
4493
4494
4495
4496
4497
4498 </td>
4499
4500
4501
4502 <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;">
4503
4504 </td>
4505
4506
4507 <td class="description last" style="min-width:310px; 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 to be called when the audio starts playing successfully. The function will be called with the following parameters (in order): &quot;startAt&quot;, &quot;stopAt&quot;, &quot;startAtNextLoop&quot;, &quot;loop&quot;, &quot;avoidDelayedPlay&quot;, &quot;allowedRecursiveDelay&quot; and &quot;startPlayingTime&quot;, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object. If the audio is looping, this will be called only once when the audio starts playing the first time and it will not be called next loops.</p></td>
4508 </tr>
4509
4510
4511
4512 <tr>
4513
4514 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>onLoadError</code></td>
4515
4516
4517 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4518
4519
4520<span class="param-type">function</span>
4521
4522
4523
4524
4525 </td>
4526
4527
4528 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4529
4530 &lt;optional><br>
4531
4532
4533
4534
4535
4536 </td>
4537
4538
4539
4540 <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;">
4541
4542 </td>
4543
4544
4545 <td class="description last" style="min-width:310px; 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 to be called if the audio cannot be played successfully. The first and unique parameter will be a string describing the error found (if it could be determined), being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object.</p></td>
4546 </tr>
4547
4548
4549
4550 <tr>
4551
4552 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>isResume</code></td>
4553
4554
4555 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4556
4557
4558<span class="param-type">boolean</span>
4559
4560
4561
4562
4563 </td>
4564
4565
4566 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4567
4568 &lt;optional><br>
4569
4570
4571
4572
4573
4574 </td>
4575
4576
4577
4578 <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;">
4579
4580 false
4581
4582 </td>
4583
4584
4585 <td class="description last" style="min-width:310px; 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) and it is a looping audio, the next loop will use the value of the <a href="CB_AudioFile_API.WAAPI.html#lastStartAt"><code>CB_AudioFile_API.WAAPI#lastStartAt</code></a> property as the &quot;startAt&quot; parameter when it calls this method again automatically (internally). Recommended for internal usage only.</p></td>
4586 </tr>
4587
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>isLooping</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">boolean</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 &lt;optional><br>
4609
4610
4611
4612
4613
4614 </td>
4615
4616
4617
4618 <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;">
4619
4620 false
4621
4622 </td>
4623
4624
4625 <td class="description last" style="min-width:310px; 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 to determine whether this method was called automatically again by itself because it is looping the audio. Recommended for internal usage only.</p></td>
4626 </tr>
4627
4628
4629
4630 <tr>
4631
4632 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>startPlayingTime</code></td>
4633
4634
4635 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4636
4637
4638<span class="param-type">integer</span>
4639
4640
4641
4642
4643 </td>
4644
4645
4646 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4647
4648 &lt;optional><br>
4649
4650
4651
4652
4653
4654 </td>
4655
4656
4657
4658 <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;">
4659
4660 </td>
4661
4662
4663 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Contains the time when the audio should start playing. Recommended for internal usage only.</p></td>
4664 </tr>
4665
4666
4667 </tbody>
4668</table>
4669
4670
4671
4672
4673<dl class="details">
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
4702
4703 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4704 <dd class="tag-source">
4705 <ul class="dummy">
4706 <li>
4707 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
4708 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-910">line 910</a>
4709 </li>
4710 </ul>
4711 </dd>
4712
4713
4714
4715
4716
4717
4718
4719</dl>
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733 <h5>Returns:</h5>
4734
4735
4736<div class="param-desc">
4737 <p>It returns false if the duration is 0 (&quot;startAt&quot; and &quot;stopAt&quot; are the same number), returns &quot;-1&quot; if the audio cannot be played and an error is detected or returns true otherwise. Note that even when it returns true there can be a non-detectable error and maybe the audio is not played.</p>
4738</div>
4739
4740
4741
4742<dl>
4743 <dt>
4744 Type
4745 </dt>
4746 <dd>
4747
4748<span class="param-type">boolean</span>
4749|
4750
4751<span class="param-type">integer</span>
4752
4753
4754
4755 </dd>
4756</dl>
4757
4758
4759
4760
4761
4762</dd>
4763
4764
4765
4766<hr>
4767<dt>
4768 <h4 class="name" id="resume"><span class="type-signature"></span>resume<span class="signature">( [loop] [, avoidDelayedPlay] [, allowedRecursiveDelay] [, onPlayStart] [, onLoadError])</span><span class="type-signature"> &rarr; {boolean|integer}</span></h4>
4769
4770
4771</dt>
4772<dd>
4773
4774
4775 <div class="description">
4776 <p>Resumes the audio (after being paused), starting from the same point it was paused previously.</p>
4777 </div>
4778
4779
4780
4781
4782
4783
4784
4785
4786 <h5>Parameters:</h5>
4787
4788
4789<table class="params table table-striped">
4790 <thead>
4791 <tr>
4792
4793 <th style="width:12%; min-width:110px;">Name</th>
4794
4795
4796 <th style="width:12%; min-width:110px;">Type</th>
4797
4798
4799 <th style="width:12%; min-width:110px;">Argument</th>
4800
4801
4802
4803 <th style="width:12%; min-width:110px;">Default</th>
4804
4805
4806 <th class="last" style="min-width:310px;">Description</th>
4807 </tr>
4808 </thead>
4809
4810 <tbody>
4811
4812
4813 <tr>
4814
4815 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>loop</code></td>
4816
4817
4818 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4819
4820
4821<span class="param-type">boolean</span>
4822
4823
4824
4825
4826 </td>
4827
4828
4829 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4830
4831 &lt;optional><br>
4832
4833
4834
4835
4836
4837 </td>
4838
4839
4840
4841 <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;">
4842
4843 <a href="CB_AudioFile_API.WAAPI.html#loop"><code>CB_AudioFile_API.WAAPI#loop</code></a>
4844
4845 </td>
4846
4847
4848 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Sets whether we want to play the audio looping (starting again and again) or just play it once. Note that at the end of each loop the &quot;onStop&quot; function defined (through the <a href="CB_AudioFile_API.WAAPI.html#onStop"><code>CB_AudioFile_API.WAAPI#onStop</code></a> method) will not be called.</p></td>
4849 </tr>
4850
4851
4852
4853 <tr>
4854
4855 <td class="name" style="width:12%; min-width:110px; 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>
4856
4857
4858 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4859
4860
4861<span class="param-type">boolean</span>
4862
4863
4864
4865
4866 </td>
4867
4868
4869 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4870
4871 &lt;optional><br>
4872
4873
4874
4875
4876
4877 </td>
4878
4879
4880
4881 <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;">
4882
4883 false
4884
4885 </td>
4886
4887
4888 <td class="description last" style="min-width:310px; 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 (recommended) and the audio failed previously or was aborted (destroyed), it will try to load it correctly again automatically and play it after that if possible (this can take some time so the audio could start playing after a delay). Otherwise, if set to true and the audio failed or was aborted (destroyed), the audio will not play at all and the <a href="CB_AudioFile_API.WAAPI.html#stop"><code>CB_AudioFile_API.WAAPI#stop</code></a> method will be called immediately.</p></td>
4889 </tr>
4890
4891
4892
4893 <tr>
4894
4895 <td class="name" style="width:12%; min-width:110px; 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>
4896
4897
4898 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4899
4900
4901<span class="param-type">boolean</span>
4902
4903
4904
4905
4906 </td>
4907
4908
4909 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4910
4911 &lt;optional><br>
4912
4913
4914
4915
4916
4917 </td>
4918
4919
4920
4921 <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;">
4922
4923 <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>
4924
4925 </td>
4926
4927
4928 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The maximum amount of time (in milliseconds) of delay that we accept before start playing the audio. If the amount of time is overcome, the audio will not play at all and the <a href="CB_AudioFile_API.WAAPI.html#stop"><code>CB_AudioFile_API.WAAPI#stop</code></a> method will be called immediately. Used only when the &quot;avoidDelayedPlay&quot; parameter is set to false and the audio needs to be loaded because it failed previously or was aborted (destroyed).</p></td>
4929 </tr>
4930
4931
4932
4933 <tr>
4934
4935 <td class="name" style="width:12%; min-width:110px; 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>
4936
4937
4938 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4939
4940
4941<span class="param-type">function</span>
4942
4943
4944
4945
4946 </td>
4947
4948
4949 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4950
4951 &lt;optional><br>
4952
4953
4954
4955
4956
4957 </td>
4958
4959
4960
4961 <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;">
4962
4963 </td>
4964
4965
4966 <td class="description last" style="min-width:310px; 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 to be called when the audio starts playing successfully. The function will be called with the following parameters (in order): &quot;startAt&quot;, &quot;stopAt&quot;, &quot;startAtNextLoop&quot;, &quot;loop&quot;, &quot;avoidDelayedPlay&quot;, &quot;allowedRecursiveDelay&quot; and &quot;startPlayingTime&quot;, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object. If the audio is looping, this will be called only once when the audio starts playing the first time and it will not be called next loops.</p></td>
4967 </tr>
4968
4969
4970
4971 <tr>
4972
4973 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>onLoadError</code></td>
4974
4975
4976 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4977
4978
4979<span class="param-type">function</span>
4980
4981
4982
4983
4984 </td>
4985
4986
4987 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4988
4989 &lt;optional><br>
4990
4991
4992
4993
4994
4995 </td>
4996
4997
4998
4999 <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;">
5000
5001 </td>
5002
5003
5004 <td class="description last" style="min-width:310px; 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 to be called if the audio cannot be played successfully. It will not be called if the audio is not paused or is stopped. The first and unique parameter will be a string describing the error found (if it could be determined), being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object.</p></td>
5005 </tr>
5006
5007
5008 </tbody>
5009</table>
5010
5011
5012
5013
5014<dl class="details">
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5045 <dd class="tag-source">
5046 <ul class="dummy">
5047 <li>
5048 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
5049 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-1112">line 1112</a>
5050 </li>
5051 </ul>
5052 </dd>
5053
5054
5055
5056
5057
5058
5059
5060</dl>
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074 <h5>Returns:</h5>
5075
5076
5077<div class="param-desc">
5078 <p>Returns the returning value of the <a href="CB_AudioFile_API.WAAPI.html#play"><code>CB_AudioFile_API.WAAPI#play</code></a> method which is called internally. It returns false if the audio is not paused or it is stopped, returns &quot;-1&quot; if the audio cannot be played and an error is detected or returns true otherwise. Note that even when it returns true there can be a non-detectable error and maybe the audio is not played.</p>
5079</div>
5080
5081
5082
5083<dl>
5084 <dt>
5085 Type
5086 </dt>
5087 <dd>
5088
5089<span class="param-type">boolean</span>
5090|
5091
5092<span class="param-type">integer</span>
5093
5094
5095
5096 </dd>
5097</dl>
5098
5099
5100
5101
5102
5103</dd>
5104
5105
5106
5107<hr>
5108<dt>
5109 <h4 class="name" id="setVolume"><span class="type-signature"></span>setVolume<span class="signature">( [volume] [, forceSetVolumeProperty] [, onSetVolume] [, saveForUnmute])</span><span class="type-signature"> &rarr; {number}</span></h4>
5110
5111
5112</dt>
5113<dd>
5114
5115
5116 <div class="description">
5117 <p>Sets the desired volume for the audio file (from 0 to the maximum value, where the maximum value will be the returning value of calling the <a href="CB_Speaker.html#.getVolume"><code>CB_Speaker.getVolume</code></a> function if the <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM</code></a> property is set to true or it will be 100 otherwise).</p>
5118 </div>
5119
5120
5121
5122
5123
5124
5125
5126
5127 <h5>Parameters:</h5>
5128
5129
5130<table class="params table table-striped">
5131 <thead>
5132 <tr>
5133
5134 <th style="width:12%; min-width:110px;">Name</th>
5135
5136
5137 <th style="width:12%; min-width:110px;">Type</th>
5138
5139
5140 <th style="width:12%; min-width:110px;">Argument</th>
5141
5142
5143
5144 <th style="width:12%; min-width:110px;">Default</th>
5145
5146
5147 <th class="last" style="min-width:310px;">Description</th>
5148 </tr>
5149 </thead>
5150
5151 <tbody>
5152
5153
5154 <tr>
5155
5156 <td class="name" style="width:12%; min-width:110px; 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>
5157
5158
5159 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5160
5161
5162<span class="param-type">number</span>
5163
5164
5165
5166
5167 </td>
5168
5169
5170 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5171
5172 &lt;optional><br>
5173
5174
5175
5176
5177
5178 </td>
5179
5180
5181
5182 <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;">
5183
5184 <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>
5185
5186 </td>
5187
5188
5189 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired volume (from 0 to the maximum value, where the maximum value will be the returning value of calling the <a href="CB_Speaker.html#.getVolume"><code>CB_Speaker.getVolume</code></a> function if the <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM</code></a> property is set to true or it will be 100 otherwise).</p></td>
5190 </tr>
5191
5192
5193
5194 <tr>
5195
5196 <td class="name" style="width:12%; min-width:110px; 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>
5197
5198
5199 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5200
5201
5202<span class="param-type">boolean</span>
5203
5204
5205
5206
5207 </td>
5208
5209
5210 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5211
5212 &lt;optional><br>
5213
5214
5215
5216
5217
5218 </td>
5219
5220
5221
5222 <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;">
5223
5224 false
5225
5226 </td>
5227
5228
5229 <td class="description last" style="min-width:310px; 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 change the <a href="CB_AudioFile_API.WAAPI.html#volume"><code>CB_AudioFile_API.WAAPI#volume</code></a> property even when the volume failed to be changed.</p></td>
5230 </tr>
5231
5232
5233
5234 <tr>
5235
5236 <td class="name" style="width:12%; min-width:110px; 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>
5237
5238
5239 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5240
5241
5242<span class="param-type">function</span>
5243
5244
5245
5246
5247 </td>
5248
5249
5250 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5251
5252 &lt;optional><br>
5253
5254
5255
5256
5257
5258 </td>
5259
5260
5261
5262 <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;">
5263
5264 </td>
5265
5266
5267 <td class="description last" style="min-width:310px; 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 if it has been possible to set the volume (or at least it was possible to try it). It will not receive any parameters, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object.</p></td>
5268 </tr>
5269
5270
5271
5272 <tr>
5273
5274 <td class="name" style="width:12%; min-width:110px; 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>
5275
5276
5277 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5278
5279
5280<span class="param-type">boolean</span>
5281
5282
5283
5284
5285 </td>
5286
5287
5288 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5289
5290 &lt;optional><br>
5291
5292
5293
5294
5295
5296 </td>
5297
5298
5299
5300 <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;">
5301
5302 false
5303
5304 </td>
5305
5306
5307 <td class="description last" style="min-width:310px; 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 save internally the current volume before setting it so it will restore the same volume again after calling the <a href="CB_AudioFile_API.WAAPI.html#unmute"><code>CB_AudioFile_API.WAAPI#unmute</code></a> method. Internal usage only recommended.</p></td>
5308 </tr>
5309
5310
5311 </tbody>
5312</table>
5313
5314
5315
5316
5317<dl class="details">
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5348 <dd class="tag-source">
5349 <ul class="dummy">
5350 <li>
5351 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
5352 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-1202">line 1202</a>
5353 </li>
5354 </ul>
5355 </dd>
5356
5357
5358
5359
5360
5361
5362
5363</dl>
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377 <h5>Returns:</h5>
5378
5379
5380<div class="param-desc">
5381 <p>Returns the current volume (from 0 to the maximum value, where the maximum value will be the returning value of calling the <a href="CB_Speaker.html#.getVolume"><code>CB_Speaker.getVolume</code></a> function if the <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM</code></a> property is set to true or it will be 100 otherwise).</p>
5382</div>
5383
5384
5385
5386<dl>
5387 <dt>
5388 Type
5389 </dt>
5390 <dd>
5391
5392<span class="param-type">number</span>
5393
5394
5395
5396 </dd>
5397</dl>
5398
5399
5400
5401
5402
5403</dd>
5404
5405
5406
5407<hr>
5408<dt>
5409 <h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">( [keepStoppedUnaltered] [, avoidOnStop] [, forceOnStop])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
5410
5411
5412</dt>
5413<dd>
5414
5415
5416 <div class="description">
5417 <p>Stops the audio.</p>
5418 </div>
5419
5420
5421
5422
5423
5424
5425
5426
5427 <h5>Parameters:</h5>
5428
5429
5430<table class="params table table-striped">
5431 <thead>
5432 <tr>
5433
5434 <th style="width:12%; min-width:110px;">Name</th>
5435
5436
5437 <th style="width:12%; min-width:110px;">Type</th>
5438
5439
5440 <th style="width:12%; min-width:110px;">Argument</th>
5441
5442
5443
5444 <th style="width:12%; min-width:110px;">Default</th>
5445
5446
5447 <th class="last" style="min-width:310px;">Description</th>
5448 </tr>
5449 </thead>
5450
5451 <tbody>
5452
5453
5454 <tr>
5455
5456 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepStoppedUnaltered</code></td>
5457
5458
5459 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5460
5461
5462<span class="param-type">boolean</span>
5463
5464
5465
5466
5467 </td>
5468
5469
5470 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5471
5472 &lt;optional><br>
5473
5474
5475
5476
5477
5478 </td>
5479
5480
5481
5482 <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;">
5483
5484 false
5485
5486 </td>
5487
5488
5489 <td class="description last" style="min-width:310px; 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), the <a href="CB_AudioFile_API.WAAPI.html#stopped"><code>CB_AudioFile_API.WAAPI#stopped</code></a> property will not be set to true and it will remain with its current value.</p></td>
5490 </tr>
5491
5492
5493
5494 <tr>
5495
5496 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidOnStop</code></td>
5497
5498
5499 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5500
5501
5502<span class="param-type">boolean</span>
5503
5504
5505
5506
5507 </td>
5508
5509
5510 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5511
5512 &lt;optional><br>
5513
5514
5515
5516
5517
5518 </td>
5519
5520
5521
5522 <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;">
5523
5524 false
5525
5526 </td>
5527
5528
5529 <td class="description last" style="min-width:310px; 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 and there is an &quot;onStop&quot; function defined (through the <a href="CB_AudioFile_API.WAAPI.html#onStop"><code>CB_AudioFile_API.WAAPI#onStop</code></a> method), it will be called after stopping the audio (or after trying to do it, at least) but only if either the &quot;forceOnStop&quot; parameter is set to true or if the &quot;keepStoppedUnaltered&quot; parameter is set to false and the audio was not already stopped before. If set to true, the &quot;onStop&quot; function (if any) will not be called at all.</p></td>
5530 </tr>
5531
5532
5533
5534 <tr>
5535
5536 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>forceOnStop</code></td>
5537
5538
5539 <td class="type" style="width:12%; min-width: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
5542<span class="param-type">boolean</span>
5543
5544
5545
5546
5547 </td>
5548
5549
5550 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5551
5552 &lt;optional><br>
5553
5554
5555
5556
5557
5558 </td>
5559
5560
5561
5562 <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;">
5563
5564 false
5565
5566 </td>
5567
5568
5569 <td class="description last" style="min-width:310px; 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 &quot;avoidOnStop&quot; parameter is set to false and there is an &quot;onStop&quot; function defined (through the <a href="CB_AudioFile_API.WAAPI.html#onStop"><code>CB_AudioFile_API.WAAPI#onStop</code></a> method), it will be called regardless the audio was stopped before or not. If set to false, the &quot;onStop&quot; function (if any) will only be called if the &quot;keepStoppedUnaltered&quot; parameter is set to false and the audio was not already stopped before. This parameter will be ignored if the &quot;avoidOnStop&quot; parameter is set to true.</p></td>
5570 </tr>
5571
5572
5573 </tbody>
5574</table>
5575
5576
5577
5578
5579<dl class="details">
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5610 <dd class="tag-source">
5611 <ul class="dummy">
5612 <li>
5613 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
5614 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-1173">line 1173</a>
5615 </li>
5616 </ul>
5617 </dd>
5618
5619
5620
5621
5622
5623
5624
5625</dl>
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639 <h5>Returns:</h5>
5640
5641
5642<div class="param-desc">
5643 <p>It returns false if the stopping action cannot be performed at all (this could happen when the audio has not been loaded properly, for example). Returns true otherwise (this only means that it has been tried to be stopped but it could not be successfully).</p>
5644</div>
5645
5646
5647
5648<dl>
5649 <dt>
5650 Type
5651 </dt>
5652 <dd>
5653
5654<span class="param-type">boolean</span>
5655
5656
5657
5658 </dd>
5659</dl>
5660
5661
5662
5663
5664
5665</dd>
5666
5667
5668
5669<hr>
5670<dt>
5671 <h4 class="name" id="unmute"><span class="type-signature"></span>unmute<span class="signature">( [onUnmute])</span><span class="type-signature"> &rarr; {number}</span></h4>
5672
5673
5674</dt>
5675<dd>
5676
5677
5678 <div class="description">
5679 <p>Restores audio after muting it (unmutes it).</p>
5680 </div>
5681
5682
5683
5684
5685
5686
5687
5688
5689 <h5>Parameters:</h5>
5690
5691
5692<table class="params table table-striped">
5693 <thead>
5694 <tr>
5695
5696 <th style="width:12%; min-width:110px;">Name</th>
5697
5698
5699 <th style="width:12%; min-width:110px;">Type</th>
5700
5701
5702 <th style="width:12%; min-width:110px;">Argument</th>
5703
5704
5705
5706
5707 <th class="last" style="min-width:310px;">Description</th>
5708 </tr>
5709 </thead>
5710
5711 <tbody>
5712
5713
5714 <tr>
5715
5716 <td class="name" style="width:12%; min-width:110px; 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>
5717
5718
5719 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5720
5721
5722<span class="param-type">function</span>
5723
5724
5725
5726
5727 </td>
5728
5729
5730 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5731
5732 &lt;optional><br>
5733
5734
5735
5736
5737
5738 </td>
5739
5740
5741
5742
5743 <td class="description last" style="min-width:310px; 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 if it has been possible to unmute the audio file (or at least it was possible to try it). It will not receive any parameters, being &quot;this&quot; the <a href="CB_AudioFile_API.WAAPI.html"><code>CB_AudioFile_API.WAAPI</code></a> object.</p></td>
5744 </tr>
5745
5746
5747 </tbody>
5748</table>
5749
5750
5751
5752
5753<dl class="details">
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5784 <dd class="tag-source">
5785 <ul class="dummy">
5786 <li>
5787 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
5788 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-1259">line 1259</a>
5789 </li>
5790 </ul>
5791 </dd>
5792
5793
5794
5795
5796
5797
5798
5799</dl>
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813 <h5>Returns:</h5>
5814
5815
5816<div class="param-desc">
5817 <p>Returns the current volume (from 0 to the maximum value, where the maximum value will be the returning value of calling the <a href="CB_Speaker.html#.getVolume"><code>CB_Speaker.getVolume</code></a> function if the <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM</code></a> property is set to true or it will be 100 otherwise).</p>
5818</div>
5819
5820
5821
5822<dl>
5823 <dt>
5824 Type
5825 </dt>
5826 <dd>
5827
5828<span class="param-type">number</span>
5829
5830
5831
5832 </dd>
5833</dl>
5834
5835
5836
5837
5838
5839</dd>
5840
5841 </dl>
5842
5843
5844
5845 <h3 class="subsection-title">Type Definitions</h3>
5846
5847 <dl>
5848
5849<hr>
5850<dt class="name" id=".OPTIONS">
5851 <h4 id=".OPTIONS">OPTIONS</h4>
5852
5853
5854</dt>
5855<dd>
5856
5857 <div class="description">
5858 <p>Object with the options for an audio file. The format is the following one: { autoLoad: boolean, autoPlay: boolean, loop: boolean, volume: number }.</p>
5859 </div>
5860
5861
5862
5863 <h5>Type:</h5>
5864 <ul>
5865 <li>
5866
5867<span class="param-type">Object</span>
5868
5869
5870
5871 </li>
5872 </ul>
5873
5874
5875
5876<dl class="details">
5877
5878
5879 <h5 class="subsection-title">Properties:</h5>
5880
5881 <dl>
5882
5883<table class="props table table-striped">
5884 <thead>
5885 <tr>
5886
5887 <th>Name</th>
5888
5889
5890 <th>Type</th>
5891
5892
5893 <th>Argument</th>
5894
5895
5896
5897 <th>Default</th>
5898
5899
5900 <th class="last">Description</th>
5901 </tr>
5902 </thead>
5903
5904 <tbody>
5905
5906
5907 <tr>
5908
5909 <td class="name"><code>autoLoad</code></td>
5910
5911
5912 <td class="type">
5913
5914
5915<span class="param-type">boolean</span>
5916
5917
5918
5919
5920 </td>
5921
5922
5923 <td class="attributes">
5924
5925 &lt;optional><br>
5926
5927
5928
5929 </td>
5930
5931
5932
5933 <td class="default">
5934
5935 <a href="CB_AudioFile_API.WAAPI.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS</code></a>.autoLoad
5936
5937 </td>
5938
5939
5940 <td class="description last"><p>If set to false, it will not call the <a href="CB_AudioFile_API.WAAPI.html#load"><code>CB_AudioFile_API.WAAPI#load</code></a> method internally when the constructor is called (not recommended).</p></td>
5941 </tr>
5942
5943
5944
5945 <tr>
5946
5947 <td class="name"><code>autoPlay</code></td>
5948
5949
5950 <td class="type">
5951
5952
5953<span class="param-type">boolean</span>
5954
5955
5956
5957
5958 </td>
5959
5960
5961 <td class="attributes">
5962
5963 &lt;optional><br>
5964
5965
5966
5967 </td>
5968
5969
5970
5971 <td class="default">
5972
5973 <a href="CB_AudioFile_API.WAAPI.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS</code></a>.autoPlay
5974
5975 </td>
5976
5977
5978 <td class="description last"><p>Value which will be used as the &quot;autoPlay&quot; parameter when calling the <a href="CB_AudioFile_API.WAAPI.html#load"><code>CB_AudioFile_API.WAAPI#load</code></a> method internally, only when the &quot;autoLoad&quot; is set to true (when the constructor is called).</p></td>
5979 </tr>
5980
5981
5982
5983 <tr>
5984
5985 <td class="name"><code>loop</code></td>
5986
5987
5988 <td class="type">
5989
5990
5991<span class="param-type">boolean</span>
5992
5993
5994
5995
5996 </td>
5997
5998
5999 <td class="attributes">
6000
6001 &lt;optional><br>
6002
6003
6004
6005 </td>
6006
6007
6008
6009 <td class="default">
6010
6011 <a href="CB_AudioFile_API.WAAPI.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS</code></a>.loop
6012
6013 </td>
6014
6015
6016 <td class="description last"><p>Value that will be used for the <a href="CB_AudioFile_API.WAAPI.html#loop"><code>CB_AudioFile_API.WAAPI#loop</code></a> property.</p></td>
6017 </tr>
6018
6019
6020
6021 <tr>
6022
6023 <td class="name"><code>volume</code></td>
6024
6025
6026 <td class="type">
6027
6028
6029<span class="param-type">number</span>
6030
6031
6032
6033
6034 </td>
6035
6036
6037 <td class="attributes">
6038
6039 &lt;optional><br>
6040
6041
6042
6043 </td>
6044
6045
6046
6047 <td class="default">
6048
6049 <a href="CB_AudioFile_API.WAAPI.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS</code></a>.volume
6050
6051 </td>
6052
6053
6054 <td class="description last"><p>The desired volume (from 0 to the maximum value, where the maximum value will be the returning value of calling the <a href="CB_Speaker.html#.getVolume"><code>CB_Speaker.getVolume</code></a> function if the <a href="CB_Configuration.CrossBase.html#.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM"><code>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM</code></a> property is set to true or it will be 100 otherwise) that will be used for the <a href="CB_AudioFile_API.WAAPI.html#volume"><code>CB_AudioFile_API.WAAPI#volume</code></a> property.</p></td>
6055 </tr>
6056
6057
6058 </tbody>
6059</table>
6060</dl>
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
6092 <dd class="tag-source">
6093 <ul class="dummy">
6094 <li>
6095 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</a>,
6096 <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_WAAPI.js.html#sunlight-1-line-224">line 224</a>
6097 </li>
6098 </ul>
6099 </dd>
6100
6101
6102
6103
6104
6105
6106
6107</dl>
6108
6109
6110
6111</dd>
6112
6113 </dl>
6114
6115
6116
6117</article>
6118
6119</section>
6120
6121
6122
6123
6124 </div>
6125 </div>
6126
6127 <div class="clearfix"></div>
6128
6129
6130 <div class="col-md-3">
6131 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
6132 </div>
6133
6134
6135</div>
6136</div>
6137
6138
6139 <div class="modal fade" id="searchResults">
6140 <div class="modal-dialog">
6141 <div class="modal-content">
6142 <div class="modal-header">
6143 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
6144 <h4 class="modal-title">Search results</h4>
6145 </div>
6146 <div class="modal-body"></div>
6147 <div class="modal-footer">
6148 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
6149 </div>
6150 </div><!-- /.modal-content -->
6151 </div><!-- /.modal-dialog -->
6152 </div>
6153
6154
6155<footer>
6156
6157
6158 <span class="copyright">
6159 <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>
6160 </span>
6161
6162<span class="jsdoc-message">
6163 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6164
6165 on Mon Feb 3rd 2020
6166
6167 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
6168</span>
6169</footer>
6170
6171<script src="scripts/docstrap.lib.js"></script>
6172<script src="scripts/toc.js"></script>
6173
6174 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
6175
6176
6177<script>
6178$( function () {
6179 $( "[id*='$']" ).each( function () {
6180 var $this = $( this );
6181
6182 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
6183 } );
6184
6185 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
6186 var $this = $( this );
6187
6188 var example = $this.find( "code" );
6189 exampleText = example.html();
6190 var lang = /{@lang (.*?)}/.exec( exampleText );
6191 if ( lang && lang[1] ) {
6192 exampleText = exampleText.replace( lang[0], "" );
6193 example.html( exampleText );
6194 lang = lang[1];
6195 } else {
6196 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
6197 lang = langClassMatch ? langClassMatch[1] : "javascript";
6198 }
6199
6200 if ( lang ) {
6201
6202 $this
6203 .addClass( "sunlight-highlight-" + lang )
6204 .addClass( "linenums" )
6205 .html( example.html() );
6206
6207 }
6208 } );
6209
6210 Sunlight.highlightAll( {
6211 lineNumbers : true,
6212 showMenu : true,
6213 enableDoclinks : true
6214 } );
6215
6216 $.catchAnchorLinks( {
6217 navbarOffset: 10
6218 } );
6219 $( "#toc" ).toc( {
6220 anchorName : function ( i, heading, prefix ) {
6221 return $( heading ).attr( "id" ) || ( prefix + i );
6222 },
6223 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
6224 showAndHide : false,
6225 smoothScrolling: true
6226 } );
6227
6228 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
6229 $( '.dropdown-toggle' ).dropdown();
6230
6231 $( "table" ).each( function () {
6232 var $this = $( this );
6233 $this.addClass('table');
6234 } );
6235
6236} );
6237</script>
6238
6239
6240
6241<!--Navigation and Symbol Display-->
6242
6243<script>
6244 $( function () {
6245 $( '#main' ).localScroll( {
6246 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
6247 } );
6248 $( "dt.name" ).each( function () {
6249 var $this = $( this ).find("h4");
6250 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
6251 var dt = $(this);
6252 var children = dt.next( "dd" );
6253
6254 dt.prepend( icon ).css( {cursor : "pointer"} );
6255 dt.addClass( "member-collapsed" ).addClass( "member" );
6256
6257
6258 children.hide();
6259
6260 dt.children().on( "click", function () {
6261 children = dt.next( "dd" );
6262 children.slideToggle( "fast", function () {
6263
6264 if ( children.is( ":visible" ) ) {
6265 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
6266 dt.addClass( "member-open" ).animate( "member-collapsed" );
6267 } else {
6268 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
6269 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
6270 }
6271 } );
6272 } );
6273
6274 } );
6275 } );
6276</script>
6277
6278
6279<!--Google Analytics-->
6280
6281
6282
6283 <script type="text/javascript">
6284 $(document).ready(function() {
6285 SearcherDisplay.init();
6286 });
6287 </script>
6288
6289
6290</body>
6291</html>
\No newline at end of file