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.ACMP</title>
|
8 |
|
9 | |
10 |
|
11 |
|
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.ACMP</h1>
|
84 |
|
85 | <section>
|
86 |
|
87 | <header>
|
88 |
|
89 | <h2>
|
90 | CB_AudioFile_API.ACMP
|
91 | </h2>
|
92 |
|
93 | <div class="class-description"><p>Class to manage an audio file using "ACMP" (<a href="https://github.com/apache/cordova-plugin-media">Apache Cordova Media Plugin</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.</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.ACMP"><span class="type-signature"></span>new CB_AudioFile_API.ACMP<span class="signature">(filePath [, audioId] [, options] [, callbackOk] [, callbackError])</span><span class="type-signature"> → {<a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</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 "autoPlay" 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 | <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_ACMP_' + CB_AudioFile_API.ACMP._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.ACMP.html#.OPTIONS">CB_AudioFile_API.ACMP.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 | <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.ACMP#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 | <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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</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 | <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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</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_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
382 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-10">line 10</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.ACMP.html"><code>CB_AudioFile_API.ACMP</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.ACMP.html">CB_AudioFile_API.ACMP</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="DEFAULT_OPTIONS">
|
464 | <h4 id="DEFAULT_OPTIONS"><span class="type-signature"><constant> </span>DEFAULT_OPTIONS<span class="type-signature"> :<a href="CB_AudioFile_API.ACMP.html#.OPTIONS">CB_AudioFile_API.ACMP.OPTIONS</a></span></h4>
|
465 |
|
466 |
|
467 | </dt>
|
468 | <dd>
|
469 |
|
470 | <div class="description">
|
471 | <p>Keeps the default options when an object is created. Format: { autoLoad: boolean, autoPlay: boolean, loop: boolean, volume: number }.</p>
|
472 | </div>
|
473 |
|
474 |
|
475 |
|
476 | <h5>Type:</h5>
|
477 | <ul>
|
478 | <li>
|
479 |
|
480 | <span class="param-type"><a href="CB_AudioFile_API.ACMP.html#.OPTIONS">CB_AudioFile_API.ACMP.OPTIONS</a></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 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
516 | <dd class="tag-default">
|
517 | <ul class="dummy">
|
518 | <li>{ autoLoad: true, autoPlay: false, loop: false, volume: <a href="CB_AudioFile_API.ACMP.html#DEFAULT_VOLUME"><code>CB_AudioFile_API.ACMP.prototype.DEFAULT_VOLUME</code></a> }</li>
|
519 | </ul>
|
520 | </dd>
|
521 |
|
522 |
|
523 |
|
524 |
|
525 |
|
526 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
527 | <dd class="tag-source">
|
528 | <ul class="dummy">
|
529 | <li>
|
530 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
531 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-38">line 38</a>
|
532 | </li>
|
533 | </ul>
|
534 | </dd>
|
535 |
|
536 |
|
537 |
|
538 |
|
539 |
|
540 |
|
541 |
|
542 | </dl>
|
543 |
|
544 |
|
545 |
|
546 | </dd>
|
547 |
|
548 |
|
549 |
|
550 | <hr>
|
551 | <dt class="name" id="DEFAULT_VOLUME">
|
552 | <h4 id="DEFAULT_VOLUME"><span class="type-signature"><constant> </span>DEFAULT_VOLUME<span class="type-signature"> :number</span></h4>
|
553 |
|
554 |
|
555 | </dt>
|
556 | <dd>
|
557 |
|
558 | <div class="description">
|
559 | <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>
|
560 | </div>
|
561 |
|
562 |
|
563 |
|
564 | <h5>Type:</h5>
|
565 | <ul>
|
566 | <li>
|
567 |
|
568 | <span class="param-type">number</span>
|
569 |
|
570 |
|
571 |
|
572 | </li>
|
573 | </ul>
|
574 |
|
575 |
|
576 |
|
577 | <dl class="details">
|
578 |
|
579 |
|
580 |
|
581 |
|
582 |
|
583 |
|
584 |
|
585 |
|
586 |
|
587 |
|
588 |
|
589 |
|
590 |
|
591 |
|
592 |
|
593 |
|
594 |
|
595 |
|
596 |
|
597 |
|
598 |
|
599 |
|
600 |
|
601 |
|
602 |
|
603 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
604 | <dd class="tag-default">
|
605 | <ul class="dummy">
|
606 | <li>CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_DEFAULT ? CB_Speaker.getVolume() : CB_Configuration.CrossBase.CB_Speaker_DEFAULT_VOLUME</li>
|
607 | </ul>
|
608 | </dd>
|
609 |
|
610 |
|
611 |
|
612 |
|
613 |
|
614 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
615 | <dd class="tag-source">
|
616 | <ul class="dummy">
|
617 | <li>
|
618 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
619 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-30">line 30</a>
|
620 | </li>
|
621 | </ul>
|
622 | </dd>
|
623 |
|
624 |
|
625 |
|
626 |
|
627 |
|
628 |
|
629 |
|
630 | </dl>
|
631 |
|
632 |
|
633 |
|
634 | </dd>
|
635 |
|
636 |
|
637 |
|
638 | <hr>
|
639 | <dt class="name" id="filePath">
|
640 | <h4 id="filePath"><span class="type-signature"><readonly> </span>filePath<span class="type-signature"> :string</span></h4>
|
641 |
|
642 |
|
643 | </dt>
|
644 | <dd>
|
645 |
|
646 | <div class="description">
|
647 | <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>
|
648 | </div>
|
649 |
|
650 |
|
651 |
|
652 | <h5>Type:</h5>
|
653 | <ul>
|
654 | <li>
|
655 |
|
656 | <span class="param-type">string</span>
|
657 |
|
658 |
|
659 |
|
660 | </li>
|
661 | </ul>
|
662 |
|
663 |
|
664 |
|
665 | <dl class="details">
|
666 |
|
667 |
|
668 |
|
669 |
|
670 |
|
671 |
|
672 |
|
673 |
|
674 |
|
675 |
|
676 |
|
677 |
|
678 |
|
679 |
|
680 |
|
681 |
|
682 |
|
683 |
|
684 |
|
685 |
|
686 |
|
687 |
|
688 |
|
689 |
|
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_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
700 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-92">line 92</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="id">
|
721 | <h4 id="id"><span class="type-signature"><readonly> </span>id<span class="type-signature"> :string</span></h4>
|
722 |
|
723 |
|
724 | </dt>
|
725 | <dd>
|
726 |
|
727 | <div class="description">
|
728 | <p>Stores the identifier for the audio file.</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 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
773 | <dd class="tag-default">
|
774 | <ul class="dummy">
|
775 | <li>'CB_AUDIOFILE_ACMP_' + CB_AudioFile_API.ACMP._idUnique++</li>
|
776 | </ul>
|
777 | </dd>
|
778 |
|
779 |
|
780 |
|
781 |
|
782 |
|
783 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
784 | <dd class="tag-source">
|
785 | <ul class="dummy">
|
786 | <li>
|
787 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
788 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-83">line 83</a>
|
789 | </li>
|
790 | </ul>
|
791 | </dd>
|
792 |
|
793 |
|
794 |
|
795 |
|
796 |
|
797 |
|
798 |
|
799 | </dl>
|
800 |
|
801 |
|
802 |
|
803 | </dd>
|
804 |
|
805 |
|
806 |
|
807 | <hr>
|
808 | <dt class="name" id="lastStartAt">
|
809 | <h4 id="lastStartAt"><span class="type-signature"><readonly> </span>lastStartAt<span class="type-signature"> :number</span></h4>
|
810 |
|
811 |
|
812 | </dt>
|
813 | <dd>
|
814 |
|
815 | <div class="description">
|
816 | <p>Stores the last "startAt" parameter value used by the <a href="CB_AudioFile_API.ACMP.html#play"><code>CB_AudioFile_API.ACMP#play</code></a> or the <a href="CB_AudioFile_API.ACMP.html#resume"><code>CB_AudioFile_API.ACMP#resume</code></a> method.</p>
|
817 | </div>
|
818 |
|
819 |
|
820 |
|
821 | <h5>Type:</h5>
|
822 | <ul>
|
823 | <li>
|
824 |
|
825 | <span class="param-type">number</span>
|
826 |
|
827 |
|
828 |
|
829 | </li>
|
830 | </ul>
|
831 |
|
832 |
|
833 |
|
834 | <dl class="details">
|
835 |
|
836 |
|
837 |
|
838 |
|
839 |
|
840 |
|
841 |
|
842 |
|
843 |
|
844 |
|
845 |
|
846 |
|
847 |
|
848 |
|
849 |
|
850 |
|
851 |
|
852 |
|
853 |
|
854 |
|
855 |
|
856 |
|
857 |
|
858 |
|
859 |
|
860 |
|
861 |
|
862 |
|
863 |
|
864 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
865 | <dd class="tag-source">
|
866 | <ul class="dummy">
|
867 | <li>
|
868 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
869 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-137">line 137</a>
|
870 | </li>
|
871 | </ul>
|
872 | </dd>
|
873 |
|
874 |
|
875 |
|
876 |
|
877 |
|
878 |
|
879 |
|
880 | </dl>
|
881 |
|
882 |
|
883 |
|
884 | </dd>
|
885 |
|
886 |
|
887 |
|
888 | <hr>
|
889 | <dt class="name" id="lastStopAt">
|
890 | <h4 id="lastStopAt"><span class="type-signature"><readonly> </span>lastStopAt<span class="type-signature"> :number</span></h4>
|
891 |
|
892 |
|
893 | </dt>
|
894 | <dd>
|
895 |
|
896 | <div class="description">
|
897 | <p>Stores the last "stopAt" parameter value used by the <a href="CB_AudioFile_API.ACMP.html#play"><code>CB_AudioFile_API.ACMP#play</code></a> or the <a href="CB_AudioFile_API.ACMP.html#resume"><code>CB_AudioFile_API.ACMP#resume</code></a> method.</p>
|
898 | </div>
|
899 |
|
900 |
|
901 |
|
902 | <h5>Type:</h5>
|
903 | <ul>
|
904 | <li>
|
905 |
|
906 | <span class="param-type">number</span>
|
907 |
|
908 |
|
909 |
|
910 | </li>
|
911 | </ul>
|
912 |
|
913 |
|
914 |
|
915 | <dl class="details">
|
916 |
|
917 |
|
918 |
|
919 |
|
920 |
|
921 |
|
922 |
|
923 |
|
924 |
|
925 |
|
926 |
|
927 |
|
928 |
|
929 |
|
930 |
|
931 |
|
932 |
|
933 |
|
934 |
|
935 |
|
936 |
|
937 |
|
938 |
|
939 |
|
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_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
950 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-146">line 146</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="loop">
|
971 | <h4 id="loop"><span class="type-signature"><readonly> </span>loop<span class="type-signature"> :boolean</span></h4>
|
972 |
|
973 |
|
974 | </dt>
|
975 | <dd>
|
976 |
|
977 | <div class="description">
|
978 | <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.ACMP.html#play"><code>CB_AudioFile_API.ACMP#play</code></a> method is called, getting the value from the "loop" parameter (but only if contains a boolean).</p>
|
979 | </div>
|
980 |
|
981 |
|
982 |
|
983 | <h5>Type:</h5>
|
984 | <ul>
|
985 | <li>
|
986 |
|
987 | <span class="param-type">boolean</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 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1023 | <dd class="tag-default">
|
1024 | <ul class="dummy">
|
1025 | <li><a href="CB_AudioFile_API.ACMP.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.ACMP.prototype.DEFAULT_OPTIONS</code></a>.loop</li>
|
1026 | </ul>
|
1027 | </dd>
|
1028 |
|
1029 |
|
1030 |
|
1031 |
|
1032 |
|
1033 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1034 | <dd class="tag-source">
|
1035 | <ul class="dummy">
|
1036 | <li>
|
1037 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1038 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-56">line 56</a>
|
1039 | </li>
|
1040 | </ul>
|
1041 | </dd>
|
1042 |
|
1043 |
|
1044 |
|
1045 |
|
1046 |
|
1047 |
|
1048 |
|
1049 | </dl>
|
1050 |
|
1051 |
|
1052 |
|
1053 | </dd>
|
1054 |
|
1055 |
|
1056 |
|
1057 | <hr>
|
1058 | <dt class="name" id="mediaObject">
|
1059 | <h4 id="mediaObject"><span class="type-signature"><readonly> </span>mediaObject<span class="type-signature"> :Object</span></h4>
|
1060 |
|
1061 |
|
1062 | </dt>
|
1063 | <dd>
|
1064 |
|
1065 | <div class="description">
|
1066 | <p>Stores the <a href="https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media/">Media</a> object of the audio, used by the "ACMP" (<a href="https://github.com/apache/cordova-plugin-media">Apache Cordova Media Plugin</a>).</p>
|
1067 | </div>
|
1068 |
|
1069 |
|
1070 |
|
1071 | <h5>Type:</h5>
|
1072 | <ul>
|
1073 | <li>
|
1074 |
|
1075 | <span class="param-type">Object</span>
|
1076 |
|
1077 |
|
1078 |
|
1079 | </li>
|
1080 | </ul>
|
1081 |
|
1082 |
|
1083 |
|
1084 | <dl class="details">
|
1085 |
|
1086 |
|
1087 |
|
1088 |
|
1089 |
|
1090 |
|
1091 |
|
1092 |
|
1093 |
|
1094 |
|
1095 |
|
1096 |
|
1097 |
|
1098 |
|
1099 |
|
1100 |
|
1101 |
|
1102 |
|
1103 |
|
1104 |
|
1105 |
|
1106 |
|
1107 |
|
1108 |
|
1109 |
|
1110 |
|
1111 |
|
1112 |
|
1113 |
|
1114 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1115 | <dd class="tag-source">
|
1116 | <ul class="dummy">
|
1117 | <li>
|
1118 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1119 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-155">line 155</a>
|
1120 | </li>
|
1121 | </ul>
|
1122 | </dd>
|
1123 |
|
1124 |
|
1125 |
|
1126 |
|
1127 |
|
1128 |
|
1129 |
|
1130 | </dl>
|
1131 |
|
1132 |
|
1133 |
|
1134 | </dd>
|
1135 |
|
1136 |
|
1137 |
|
1138 | <hr>
|
1139 | <dt class="name" id="onStopFunction">
|
1140 | <h4 id="onStopFunction"><span class="type-signature"><readonly> </span>onStopFunction<span class="type-signature"> :function</span></h4>
|
1141 |
|
1142 |
|
1143 | </dt>
|
1144 | <dd>
|
1145 |
|
1146 | <div class="description">
|
1147 | <p>Function to call when the audio stops.</p>
|
1148 | </div>
|
1149 |
|
1150 |
|
1151 |
|
1152 | <h5>Type:</h5>
|
1153 | <ul>
|
1154 | <li>
|
1155 |
|
1156 | <span class="param-type">function</span>
|
1157 |
|
1158 |
|
1159 |
|
1160 | </li>
|
1161 | </ul>
|
1162 |
|
1163 |
|
1164 |
|
1165 | <dl class="details">
|
1166 |
|
1167 |
|
1168 |
|
1169 |
|
1170 |
|
1171 |
|
1172 |
|
1173 |
|
1174 |
|
1175 |
|
1176 |
|
1177 |
|
1178 |
|
1179 |
|
1180 |
|
1181 |
|
1182 |
|
1183 |
|
1184 |
|
1185 |
|
1186 |
|
1187 |
|
1188 |
|
1189 |
|
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_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1200 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-128">line 128</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="paused">
|
1221 | <h4 id="paused"><span class="type-signature"><readonly> </span>paused<span class="type-signature"> :boolean</span></h4>
|
1222 |
|
1223 |
|
1224 | </dt>
|
1225 | <dd>
|
1226 |
|
1227 | <div class="description">
|
1228 | <p>Tells whether the audio is paused or not.</p>
|
1229 | </div>
|
1230 |
|
1231 |
|
1232 |
|
1233 | <h5>Type:</h5>
|
1234 | <ul>
|
1235 | <li>
|
1236 |
|
1237 | <span class="param-type">boolean</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 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1273 | <dd class="tag-default">
|
1274 | <ul class="dummy">
|
1275 | <li>false</li>
|
1276 | </ul>
|
1277 | </dd>
|
1278 |
|
1279 |
|
1280 |
|
1281 |
|
1282 |
|
1283 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1284 | <dd class="tag-source">
|
1285 | <ul class="dummy">
|
1286 | <li>
|
1287 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1288 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-101">line 101</a>
|
1289 | </li>
|
1290 | </ul>
|
1291 | </dd>
|
1292 |
|
1293 |
|
1294 |
|
1295 |
|
1296 |
|
1297 |
|
1298 |
|
1299 | </dl>
|
1300 |
|
1301 |
|
1302 |
|
1303 | </dd>
|
1304 |
|
1305 |
|
1306 |
|
1307 | <hr>
|
1308 | <dt class="name" id="pauseTime">
|
1309 | <h4 id="pauseTime"><span class="type-signature"><readonly> </span>pauseTime<span class="type-signature"> :number</span></h4>
|
1310 |
|
1311 |
|
1312 | </dt>
|
1313 | <dd>
|
1314 |
|
1315 | <div class="description">
|
1316 | <p>Stores the time (in milliseconds) when the audio has been paused.</p>
|
1317 | </div>
|
1318 |
|
1319 |
|
1320 |
|
1321 | <h5>Type:</h5>
|
1322 | <ul>
|
1323 | <li>
|
1324 |
|
1325 | <span class="param-type">number</span>
|
1326 |
|
1327 |
|
1328 |
|
1329 | </li>
|
1330 | </ul>
|
1331 |
|
1332 |
|
1333 |
|
1334 | <dl class="details">
|
1335 |
|
1336 |
|
1337 |
|
1338 |
|
1339 |
|
1340 |
|
1341 |
|
1342 |
|
1343 |
|
1344 |
|
1345 |
|
1346 |
|
1347 |
|
1348 |
|
1349 |
|
1350 |
|
1351 |
|
1352 |
|
1353 |
|
1354 |
|
1355 |
|
1356 |
|
1357 |
|
1358 |
|
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_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1369 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-110">line 110</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="position">
|
1390 | <h4 id="position"><span class="type-signature"><readonly> </span>position<span class="type-signature"> :number</span></h4>
|
1391 |
|
1392 |
|
1393 | </dt>
|
1394 | <dd>
|
1395 |
|
1396 | <div class="description">
|
1397 | <p>Stores the current position (in seconds) where the audio is playing (returned by the <a href="https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media/">getCurrentPosition</a> method), used by the "ACMP" (<a href="https://github.com/apache/cordova-plugin-media">Apache Cordova Media Plugin</a>).</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_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1450 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-164">line 164</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="status">
|
1471 | <h4 id="status"><span class="type-signature"><readonly> </span>status<span class="type-signature"> :integer</span></h4>
|
1472 |
|
1473 |
|
1474 | </dt>
|
1475 | <dd>
|
1476 |
|
1477 | <div class="description">
|
1478 | <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>
|
1479 | </div>
|
1480 |
|
1481 |
|
1482 |
|
1483 | <h5>Type:</h5>
|
1484 | <ul>
|
1485 | <li>
|
1486 |
|
1487 | <span class="param-type">integer</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><a href="CB_AudioFile.html#.UNLOADED"><code>CB_AudioFile.UNLOADED</code></a></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_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1538 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-47">line 47</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="stopped">
|
1559 | <h4 id="stopped"><span class="type-signature"><readonly> </span>stopped<span class="type-signature"> :boolean</span></h4>
|
1560 |
|
1561 |
|
1562 | </dt>
|
1563 | <dd>
|
1564 |
|
1565 | <div class="description">
|
1566 | <p>Tells whether the audio is stopped or not.</p>
|
1567 | </div>
|
1568 |
|
1569 |
|
1570 |
|
1571 | <h5>Type:</h5>
|
1572 | <ul>
|
1573 | <li>
|
1574 |
|
1575 | <span class="param-type">boolean</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 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1611 | <dd class="tag-default">
|
1612 | <ul class="dummy">
|
1613 | <li>true</li>
|
1614 | </ul>
|
1615 | </dd>
|
1616 |
|
1617 |
|
1618 |
|
1619 |
|
1620 |
|
1621 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1622 | <dd class="tag-source">
|
1623 | <ul class="dummy">
|
1624 | <li>
|
1625 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1626 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-119">line 119</a>
|
1627 | </li>
|
1628 | </ul>
|
1629 | </dd>
|
1630 |
|
1631 |
|
1632 |
|
1633 |
|
1634 |
|
1635 |
|
1636 |
|
1637 | </dl>
|
1638 |
|
1639 |
|
1640 |
|
1641 | </dd>
|
1642 |
|
1643 |
|
1644 |
|
1645 | <hr>
|
1646 | <dt class="name" id="volume">
|
1647 | <h4 id="volume"><span class="type-signature"><readonly> </span>volume<span class="type-signature"> :number</span></h4>
|
1648 |
|
1649 |
|
1650 | </dt>
|
1651 | <dd>
|
1652 |
|
1653 | <div class="description">
|
1654 | <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>
|
1655 | </div>
|
1656 |
|
1657 |
|
1658 |
|
1659 | <h5>Type:</h5>
|
1660 | <ul>
|
1661 | <li>
|
1662 |
|
1663 | <span class="param-type">number</span>
|
1664 |
|
1665 |
|
1666 |
|
1667 | </li>
|
1668 | </ul>
|
1669 |
|
1670 |
|
1671 |
|
1672 | <dl class="details">
|
1673 |
|
1674 |
|
1675 |
|
1676 |
|
1677 |
|
1678 |
|
1679 |
|
1680 |
|
1681 |
|
1682 |
|
1683 |
|
1684 |
|
1685 |
|
1686 |
|
1687 |
|
1688 |
|
1689 |
|
1690 |
|
1691 |
|
1692 |
|
1693 |
|
1694 |
|
1695 |
|
1696 |
|
1697 |
|
1698 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1699 | <dd class="tag-default">
|
1700 | <ul class="dummy">
|
1701 | <li><a href="CB_AudioFile_API.ACMP.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.ACMP.prototype.DEFAULT_OPTIONS</code></a>.volume</li>
|
1702 | </ul>
|
1703 | </dd>
|
1704 |
|
1705 |
|
1706 |
|
1707 |
|
1708 |
|
1709 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1710 | <dd class="tag-source">
|
1711 | <ul class="dummy">
|
1712 | <li>
|
1713 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1714 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-65">line 65</a>
|
1715 | </li>
|
1716 | </ul>
|
1717 | </dd>
|
1718 |
|
1719 |
|
1720 |
|
1721 |
|
1722 |
|
1723 |
|
1724 |
|
1725 | </dl>
|
1726 |
|
1727 |
|
1728 |
|
1729 | </dd>
|
1730 |
|
1731 |
|
1732 |
|
1733 | <hr>
|
1734 | <dt class="name" id="volumeBeforeMute">
|
1735 | <h4 id="volumeBeforeMute"><span class="type-signature"><readonly> </span>volumeBeforeMute<span class="type-signature"> :number</span></h4>
|
1736 |
|
1737 |
|
1738 | </dt>
|
1739 | <dd>
|
1740 |
|
1741 | <div class="description">
|
1742 | <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>
|
1743 | </div>
|
1744 |
|
1745 |
|
1746 |
|
1747 | <h5>Type:</h5>
|
1748 | <ul>
|
1749 | <li>
|
1750 |
|
1751 | <span class="param-type">number</span>
|
1752 |
|
1753 |
|
1754 |
|
1755 | </li>
|
1756 | </ul>
|
1757 |
|
1758 |
|
1759 |
|
1760 | <dl class="details">
|
1761 |
|
1762 |
|
1763 |
|
1764 |
|
1765 |
|
1766 |
|
1767 |
|
1768 |
|
1769 |
|
1770 |
|
1771 |
|
1772 |
|
1773 |
|
1774 |
|
1775 |
|
1776 |
|
1777 |
|
1778 |
|
1779 |
|
1780 |
|
1781 |
|
1782 |
|
1783 |
|
1784 |
|
1785 |
|
1786 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
1787 | <dd class="tag-default">
|
1788 | <ul class="dummy">
|
1789 | <li><a href="CB_AudioFile_API.ACMP.html#volume"><code>CB_AudioFile_API.ACMP#volume</code></a></li>
|
1790 | </ul>
|
1791 | </dd>
|
1792 |
|
1793 |
|
1794 |
|
1795 |
|
1796 |
|
1797 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1798 | <dd class="tag-source">
|
1799 | <ul class="dummy">
|
1800 | <li>
|
1801 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
1802 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-74">line 74</a>
|
1803 | </li>
|
1804 | </ul>
|
1805 | </dd>
|
1806 |
|
1807 |
|
1808 |
|
1809 |
|
1810 |
|
1811 |
|
1812 |
|
1813 | </dl>
|
1814 |
|
1815 |
|
1816 |
|
1817 | </dd>
|
1818 |
|
1819 | </dl>
|
1820 |
|
1821 |
|
1822 |
|
1823 | <h3 class="subsection-title">Methods</h3>
|
1824 |
|
1825 | <dl>
|
1826 |
|
1827 | <hr>
|
1828 | <dt>
|
1829 | <h4 class="name" id="checkPlaying"><span class="type-signature"></span>checkPlaying<span class="signature">( [callbackOk] [, callbackError] [, ignoreStatus] [, ignoreQueue] [, useCache] [, isSwapObject])</span><span class="type-signature"> → {boolean}</span></h4>
|
1830 |
|
1831 |
|
1832 | </dt>
|
1833 | <dd>
|
1834 |
|
1835 |
|
1836 | <div class="description">
|
1837 | <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.ACMP.html#play"><code>CB_AudioFile_API.ACMP#play</code></a> method the first time. The checking action will only be performed if the value of the <a href="CB_AudioFile_API.ACMP.html#status"><code>CB_AudioFile_API.ACMP#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.ACMP.html#status"><code>CB_AudioFile_API.ACMP#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.ACMP.html#status"><code>CB_AudioFile_API.ACMP#status</code></a> property will get the value of {CB_AudioFile.FAILED}.</p>
|
1838 | </div>
|
1839 |
|
1840 |
|
1841 |
|
1842 |
|
1843 |
|
1844 |
|
1845 |
|
1846 |
|
1847 | <h5>Parameters:</h5>
|
1848 |
|
1849 |
|
1850 | <table class="params table table-striped">
|
1851 | <thead>
|
1852 | <tr>
|
1853 |
|
1854 | <th style="width:12%; min-width:110px;">Name</th>
|
1855 |
|
1856 |
|
1857 | <th style="width:12%; min-width:110px;">Type</th>
|
1858 |
|
1859 |
|
1860 | <th style="width:12%; min-width:110px;">Argument</th>
|
1861 |
|
1862 |
|
1863 |
|
1864 | <th style="width:12%; min-width:110px;">Default</th>
|
1865 |
|
1866 |
|
1867 | <th class="last" style="min-width:310px;">Description</th>
|
1868 | </tr>
|
1869 | </thead>
|
1870 |
|
1871 | <tbody>
|
1872 |
|
1873 |
|
1874 | <tr>
|
1875 |
|
1876 | <td class="name" style="width:12%; min-width:110px; 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>
|
1877 |
|
1878 |
|
1879 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1880 |
|
1881 |
|
1882 | <span class="param-type">function</span>
|
1883 |
|
1884 |
|
1885 |
|
1886 |
|
1887 | </td>
|
1888 |
|
1889 |
|
1890 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1891 |
|
1892 | <optional><br>
|
1893 |
|
1894 |
|
1895 |
|
1896 |
|
1897 |
|
1898 | </td>
|
1899 |
|
1900 |
|
1901 |
|
1902 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1903 |
|
1904 | </td>
|
1905 |
|
1906 |
|
1907 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object itself.</p></td>
|
1908 | </tr>
|
1909 |
|
1910 |
|
1911 |
|
1912 | <tr>
|
1913 |
|
1914 | <td class="name" style="width:12%; min-width:110px; 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>
|
1915 |
|
1916 |
|
1917 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1918 |
|
1919 |
|
1920 | <span class="param-type">function</span>
|
1921 |
|
1922 |
|
1923 |
|
1924 |
|
1925 | </td>
|
1926 |
|
1927 |
|
1928 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1929 |
|
1930 | <optional><br>
|
1931 |
|
1932 |
|
1933 |
|
1934 |
|
1935 |
|
1936 | </td>
|
1937 |
|
1938 |
|
1939 |
|
1940 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1941 |
|
1942 | </td>
|
1943 |
|
1944 |
|
1945 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object itself.</p></td>
|
1946 | </tr>
|
1947 |
|
1948 |
|
1949 |
|
1950 | <tr>
|
1951 |
|
1952 | <td class="name" style="width:12%; min-width:110px; 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>
|
1953 |
|
1954 |
|
1955 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1956 |
|
1957 |
|
1958 | <span class="param-type">boolean</span>
|
1959 |
|
1960 |
|
1961 |
|
1962 |
|
1963 | </td>
|
1964 |
|
1965 |
|
1966 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1967 |
|
1968 | <optional><br>
|
1969 |
|
1970 |
|
1971 |
|
1972 |
|
1973 |
|
1974 | </td>
|
1975 |
|
1976 |
|
1977 |
|
1978 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1979 |
|
1980 | false
|
1981 |
|
1982 | </td>
|
1983 |
|
1984 |
|
1985 | <td class="description last" style="min-width:310px; 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.ACMP.html#status"><code>CB_AudioFile_API.ACMP#status</code></a> property does not belong neither to the "UNCHECKED" status (defined in the <a href="CB_AudioFile.html#.UNCHECKED"><code>CB_AudioFile.UNCHECKED</code></a> constant) nor to the "CHECKING" status (defined in the <a href="CB_AudioFile.html#.CHECKING"><code>CB_AudioFile.CHECKING</code></a> constant), it will fail calling the "callbackError" function (if any). If set to true, it will try to perform the checking action regardless the status of the audio.</p></td>
|
1986 | </tr>
|
1987 |
|
1988 |
|
1989 |
|
1990 | <tr>
|
1991 |
|
1992 | <td class="name" style="width:12%; min-width:110px; 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>
|
1993 |
|
1994 |
|
1995 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1996 |
|
1997 |
|
1998 | <span class="param-type">boolean</span>
|
1999 |
|
2000 |
|
2001 |
|
2002 |
|
2003 | </td>
|
2004 |
|
2005 |
|
2006 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2007 |
|
2008 | <optional><br>
|
2009 |
|
2010 |
|
2011 |
|
2012 |
|
2013 |
|
2014 | </td>
|
2015 |
|
2016 |
|
2017 |
|
2018 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2019 |
|
2020 | false
|
2021 |
|
2022 | </td>
|
2023 |
|
2024 |
|
2025 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>This parameter will be ignored in this audio API.</p></td>
|
2026 | </tr>
|
2027 |
|
2028 |
|
2029 |
|
2030 | <tr>
|
2031 |
|
2032 | <td class="name" style="width:12%; min-width:110px; 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>
|
2033 |
|
2034 |
|
2035 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2036 |
|
2037 |
|
2038 | <span class="param-type">boolean</span>
|
2039 |
|
2040 |
|
2041 |
|
2042 |
|
2043 | </td>
|
2044 |
|
2045 |
|
2046 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2047 |
|
2048 | <optional><br>
|
2049 |
|
2050 |
|
2051 |
|
2052 |
|
2053 |
|
2054 | </td>
|
2055 |
|
2056 |
|
2057 |
|
2058 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2059 |
|
2060 | false
|
2061 |
|
2062 | </td>
|
2063 |
|
2064 |
|
2065 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>This parameter will be ignored in this audio API.</p></td>
|
2066 | </tr>
|
2067 |
|
2068 |
|
2069 |
|
2070 | <tr>
|
2071 |
|
2072 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>isSwapObject</code></td>
|
2073 |
|
2074 |
|
2075 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2076 |
|
2077 |
|
2078 | <span class="param-type">boolean</span>
|
2079 |
|
2080 |
|
2081 |
|
2082 |
|
2083 | </td>
|
2084 |
|
2085 |
|
2086 | <td class="attributes" style="width:12%; min-width: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 | <optional><br>
|
2089 |
|
2090 |
|
2091 |
|
2092 |
|
2093 |
|
2094 | </td>
|
2095 |
|
2096 |
|
2097 |
|
2098 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2099 |
|
2100 | false
|
2101 |
|
2102 | </td>
|
2103 |
|
2104 |
|
2105 | <td class="description last" style="min-width:310px; 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 the <a href="https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media/">Media</a> object to check is a swap object or the normal one (a swap object is stored internally as it is necessary due ACMP issues when looping a sprite near the end of the audio file). Internal usage only recommended.</p></td>
|
2106 | </tr>
|
2107 |
|
2108 |
|
2109 | </tbody>
|
2110 | </table>
|
2111 |
|
2112 |
|
2113 |
|
2114 |
|
2115 | <dl class="details">
|
2116 |
|
2117 |
|
2118 |
|
2119 |
|
2120 |
|
2121 |
|
2122 |
|
2123 |
|
2124 |
|
2125 |
|
2126 |
|
2127 |
|
2128 |
|
2129 |
|
2130 |
|
2131 |
|
2132 |
|
2133 |
|
2134 |
|
2135 |
|
2136 |
|
2137 |
|
2138 |
|
2139 |
|
2140 |
|
2141 |
|
2142 |
|
2143 |
|
2144 |
|
2145 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2146 | <dd class="tag-source">
|
2147 | <ul class="dummy">
|
2148 | <li>
|
2149 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
2150 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-521">line 521</a>
|
2151 | </li>
|
2152 | </ul>
|
2153 | </dd>
|
2154 |
|
2155 |
|
2156 |
|
2157 |
|
2158 |
|
2159 |
|
2160 |
|
2161 | </dl>
|
2162 |
|
2163 |
|
2164 |
|
2165 |
|
2166 |
|
2167 |
|
2168 |
|
2169 |
|
2170 |
|
2171 |
|
2172 |
|
2173 |
|
2174 |
|
2175 | <h5>Returns:</h5>
|
2176 |
|
2177 |
|
2178 | <div class="param-desc">
|
2179 | <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>
|
2180 | </div>
|
2181 |
|
2182 |
|
2183 |
|
2184 | <dl>
|
2185 | <dt>
|
2186 | Type
|
2187 | </dt>
|
2188 | <dd>
|
2189 |
|
2190 | <span class="param-type">boolean</span>
|
2191 |
|
2192 |
|
2193 |
|
2194 | </dd>
|
2195 | </dl>
|
2196 |
|
2197 |
|
2198 |
|
2199 |
|
2200 |
|
2201 | </dd>
|
2202 |
|
2203 |
|
2204 |
|
2205 | <hr>
|
2206 | <dt>
|
2207 | <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>
|
2208 |
|
2209 |
|
2210 | </dt>
|
2211 | <dd>
|
2212 |
|
2213 |
|
2214 | <div class="description">
|
2215 | <p>Destroys the audio file object and frees memory. Sets its current <a href="CB_AudioFile_API.ACMP.html#status"><code>CB_AudioFile_API.ACMP#status</code></a> property to ABORTED (<a href="CB_AudioFile.html#.ABORTED"><code>CB_AudioFile.ABORTED</code></a> value).</p>
|
2216 | </div>
|
2217 |
|
2218 |
|
2219 |
|
2220 |
|
2221 |
|
2222 |
|
2223 |
|
2224 |
|
2225 | <h5>Parameters:</h5>
|
2226 |
|
2227 |
|
2228 | <table class="params table table-striped">
|
2229 | <thead>
|
2230 | <tr>
|
2231 |
|
2232 | <th style="width:12%; min-width:110px;">Name</th>
|
2233 |
|
2234 |
|
2235 | <th style="width:12%; min-width:110px;">Type</th>
|
2236 |
|
2237 |
|
2238 | <th style="width:12%; min-width:110px;">Argument</th>
|
2239 |
|
2240 |
|
2241 |
|
2242 | <th style="width:12%; min-width:110px;">Default</th>
|
2243 |
|
2244 |
|
2245 | <th class="last" style="min-width:310px;">Description</th>
|
2246 | </tr>
|
2247 | </thead>
|
2248 |
|
2249 | <tbody>
|
2250 |
|
2251 |
|
2252 | <tr>
|
2253 |
|
2254 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>stopSound</code></td>
|
2255 |
|
2256 |
|
2257 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2258 |
|
2259 |
|
2260 | <span class="param-type">boolean</span>
|
2261 |
|
2262 |
|
2263 |
|
2264 |
|
2265 | </td>
|
2266 |
|
2267 |
|
2268 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2269 |
|
2270 | <optional><br>
|
2271 |
|
2272 |
|
2273 |
|
2274 |
|
2275 |
|
2276 | </td>
|
2277 |
|
2278 |
|
2279 |
|
2280 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2281 |
|
2282 | false
|
2283 |
|
2284 | </td>
|
2285 |
|
2286 |
|
2287 | <td class="description last" style="min-width:310px; 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.ACMP.html#stop"><code>CB_AudioFile_API.ACMP#stop</code></a> method.</p></td>
|
2288 | </tr>
|
2289 |
|
2290 |
|
2291 |
|
2292 | <tr>
|
2293 |
|
2294 | <td class="name" style="width:12%; min-width:110px; 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>
|
2295 |
|
2296 |
|
2297 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2298 |
|
2299 |
|
2300 | <span class="param-type">boolean</span>
|
2301 |
|
2302 |
|
2303 |
|
2304 |
|
2305 | </td>
|
2306 |
|
2307 |
|
2308 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2309 |
|
2310 | <optional><br>
|
2311 |
|
2312 |
|
2313 |
|
2314 |
|
2315 |
|
2316 | </td>
|
2317 |
|
2318 |
|
2319 |
|
2320 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2321 |
|
2322 | false
|
2323 |
|
2324 | </td>
|
2325 |
|
2326 |
|
2327 | <td class="description last" style="min-width:310px; 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 "keepStoppedUnaltered" parameter to call the <a href="CB_AudioFile_API.ACMP.html#stop"><code>CB_AudioFile_API.ACMP#stop</code></a> method. If the "stopSound" parameter is not set to true, this parameter will be ignored as the "stop" method will not be called.</p></td>
|
2328 | </tr>
|
2329 |
|
2330 |
|
2331 |
|
2332 | <tr>
|
2333 |
|
2334 | <td class="name" style="width:12%; min-width:110px; 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>
|
2335 |
|
2336 |
|
2337 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2338 |
|
2339 |
|
2340 | <span class="param-type">boolean</span>
|
2341 |
|
2342 |
|
2343 |
|
2344 |
|
2345 | </td>
|
2346 |
|
2347 |
|
2348 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2349 |
|
2350 | <optional><br>
|
2351 |
|
2352 |
|
2353 |
|
2354 |
|
2355 |
|
2356 | </td>
|
2357 |
|
2358 |
|
2359 |
|
2360 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2361 |
|
2362 | false
|
2363 |
|
2364 | </td>
|
2365 |
|
2366 |
|
2367 | <td class="description last" style="min-width:310px; 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 "avoidOnStop" parameter to call the <a href="CB_AudioFile_API.ACMP.html#stop"><code>CB_AudioFile_API.ACMP#stop</code></a> method. If the "stopSound" parameter is not set to true, this parameter will be ignored as the "stop" method will not be called.</p></td>
|
2368 | </tr>
|
2369 |
|
2370 |
|
2371 |
|
2372 | <tr>
|
2373 |
|
2374 | <td class="name" style="width:12%; min-width:110px; 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>
|
2375 |
|
2376 |
|
2377 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2378 |
|
2379 |
|
2380 | <span class="param-type">boolean</span>
|
2381 |
|
2382 |
|
2383 |
|
2384 |
|
2385 | </td>
|
2386 |
|
2387 |
|
2388 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2389 |
|
2390 | <optional><br>
|
2391 |
|
2392 |
|
2393 |
|
2394 |
|
2395 |
|
2396 | </td>
|
2397 |
|
2398 |
|
2399 |
|
2400 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2401 |
|
2402 | false
|
2403 |
|
2404 | </td>
|
2405 |
|
2406 |
|
2407 | <td class="description last" style="min-width:310px; 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 "forceOnStop" parameter to call the <a href="CB_AudioFile_API.ACMP.html#stop"><code>CB_AudioFile_API.ACMP#stop</code></a> method. If the "stopSound" parameter is not set to true, this parameter will be ignored as the "stop" method will not be called.</p></td>
|
2408 | </tr>
|
2409 |
|
2410 |
|
2411 | </tbody>
|
2412 | </table>
|
2413 |
|
2414 |
|
2415 |
|
2416 |
|
2417 | <dl class="details">
|
2418 |
|
2419 |
|
2420 |
|
2421 |
|
2422 |
|
2423 |
|
2424 |
|
2425 |
|
2426 |
|
2427 |
|
2428 |
|
2429 |
|
2430 |
|
2431 |
|
2432 |
|
2433 |
|
2434 |
|
2435 |
|
2436 |
|
2437 |
|
2438 |
|
2439 |
|
2440 |
|
2441 |
|
2442 |
|
2443 |
|
2444 |
|
2445 |
|
2446 |
|
2447 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2448 | <dd class="tag-source">
|
2449 | <ul class="dummy">
|
2450 | <li>
|
2451 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
2452 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-255">line 255</a>
|
2453 | </li>
|
2454 | </ul>
|
2455 | </dd>
|
2456 |
|
2457 |
|
2458 |
|
2459 |
|
2460 |
|
2461 |
|
2462 |
|
2463 | </dl>
|
2464 |
|
2465 |
|
2466 |
|
2467 |
|
2468 |
|
2469 |
|
2470 |
|
2471 |
|
2472 |
|
2473 |
|
2474 |
|
2475 |
|
2476 |
|
2477 |
|
2478 |
|
2479 | </dd>
|
2480 |
|
2481 |
|
2482 |
|
2483 | <hr>
|
2484 | <dt>
|
2485 | <h4 class="name" id="getCurrentTime"><span class="type-signature"></span>getCurrentTime<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
|
2486 |
|
2487 |
|
2488 | </dt>
|
2489 | <dd>
|
2490 |
|
2491 |
|
2492 | <div class="description">
|
2493 | <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>
|
2494 | </div>
|
2495 |
|
2496 |
|
2497 |
|
2498 |
|
2499 |
|
2500 |
|
2501 |
|
2502 |
|
2503 |
|
2504 |
|
2505 | <dl class="details">
|
2506 |
|
2507 |
|
2508 |
|
2509 |
|
2510 |
|
2511 |
|
2512 |
|
2513 |
|
2514 |
|
2515 |
|
2516 |
|
2517 |
|
2518 |
|
2519 |
|
2520 |
|
2521 |
|
2522 |
|
2523 |
|
2524 |
|
2525 |
|
2526 |
|
2527 |
|
2528 |
|
2529 |
|
2530 |
|
2531 |
|
2532 |
|
2533 |
|
2534 |
|
2535 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2536 | <dd class="tag-source">
|
2537 | <ul class="dummy">
|
2538 | <li>
|
2539 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
2540 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-1066">line 1066</a>
|
2541 | </li>
|
2542 | </ul>
|
2543 | </dd>
|
2544 |
|
2545 |
|
2546 |
|
2547 |
|
2548 |
|
2549 |
|
2550 |
|
2551 | </dl>
|
2552 |
|
2553 |
|
2554 |
|
2555 |
|
2556 |
|
2557 |
|
2558 |
|
2559 |
|
2560 |
|
2561 |
|
2562 |
|
2563 |
|
2564 |
|
2565 | <h5>Returns:</h5>
|
2566 |
|
2567 |
|
2568 | <div class="param-desc">
|
2569 | <p>Returns the current time (in milliseconds). Note that some audio APIs and clients could give wrong values.</p>
|
2570 | </div>
|
2571 |
|
2572 |
|
2573 |
|
2574 | <dl>
|
2575 | <dt>
|
2576 | Type
|
2577 | </dt>
|
2578 | <dd>
|
2579 |
|
2580 | <span class="param-type">number</span>
|
2581 |
|
2582 |
|
2583 |
|
2584 | </dd>
|
2585 | </dl>
|
2586 |
|
2587 |
|
2588 |
|
2589 |
|
2590 |
|
2591 | </dd>
|
2592 |
|
2593 |
|
2594 |
|
2595 | <hr>
|
2596 | <dt>
|
2597 | <h4 class="name" id="getDuration"><span class="type-signature"></span>getDuration<span class="signature">( [mediaObject])</span><span class="type-signature"> → {number}</span></h4>
|
2598 |
|
2599 |
|
2600 | </dt>
|
2601 | <dd>
|
2602 |
|
2603 |
|
2604 | <div class="description">
|
2605 | <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>
|
2606 | </div>
|
2607 |
|
2608 |
|
2609 |
|
2610 |
|
2611 |
|
2612 |
|
2613 |
|
2614 |
|
2615 | <h5>Parameters:</h5>
|
2616 |
|
2617 |
|
2618 | <table class="params table table-striped">
|
2619 | <thead>
|
2620 | <tr>
|
2621 |
|
2622 | <th style="width:12%; min-width:110px;">Name</th>
|
2623 |
|
2624 |
|
2625 | <th style="width:12%; min-width:110px;">Type</th>
|
2626 |
|
2627 |
|
2628 | <th style="width:12%; min-width:110px;">Argument</th>
|
2629 |
|
2630 |
|
2631 |
|
2632 | <th style="width:12%; min-width:110px;">Default</th>
|
2633 |
|
2634 |
|
2635 | <th class="last" style="min-width:310px;">Description</th>
|
2636 | </tr>
|
2637 | </thead>
|
2638 |
|
2639 | <tbody>
|
2640 |
|
2641 |
|
2642 | <tr>
|
2643 |
|
2644 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>mediaObject</code></td>
|
2645 |
|
2646 |
|
2647 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2648 |
|
2649 |
|
2650 | <span class="param-type">Object</span>
|
2651 |
|
2652 |
|
2653 |
|
2654 |
|
2655 | </td>
|
2656 |
|
2657 |
|
2658 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2659 |
|
2660 | <optional><br>
|
2661 |
|
2662 |
|
2663 |
|
2664 |
|
2665 |
|
2666 | </td>
|
2667 |
|
2668 |
|
2669 |
|
2670 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2671 |
|
2672 | <a href="CB_AudioFile_API.ACMP.html#mediaObject"><code>CB_AudioFile_API.ACMP#mediaObject</code></a>
|
2673 |
|
2674 | </td>
|
2675 |
|
2676 |
|
2677 | <td class="description last" style="min-width:310px; 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://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media/">Media</a> object whose audio duration we want to check. Used internally to check either normal or swap <a href="https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media/">Media</a> object (a swap object is stored internally as it is necessary due ACMP issues when looping a sprite near the end of the audio file). Internal usage only recommended.</p></td>
|
2678 | </tr>
|
2679 |
|
2680 |
|
2681 | </tbody>
|
2682 | </table>
|
2683 |
|
2684 |
|
2685 |
|
2686 |
|
2687 | <dl class="details">
|
2688 |
|
2689 |
|
2690 |
|
2691 |
|
2692 |
|
2693 |
|
2694 |
|
2695 |
|
2696 |
|
2697 |
|
2698 |
|
2699 |
|
2700 |
|
2701 |
|
2702 |
|
2703 |
|
2704 |
|
2705 |
|
2706 |
|
2707 |
|
2708 |
|
2709 |
|
2710 |
|
2711 |
|
2712 |
|
2713 |
|
2714 |
|
2715 |
|
2716 |
|
2717 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2718 | <dd class="tag-source">
|
2719 | <ul class="dummy">
|
2720 | <li>
|
2721 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
2722 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-680">line 680</a>
|
2723 | </li>
|
2724 | </ul>
|
2725 | </dd>
|
2726 |
|
2727 |
|
2728 |
|
2729 |
|
2730 |
|
2731 |
|
2732 |
|
2733 | </dl>
|
2734 |
|
2735 |
|
2736 |
|
2737 |
|
2738 |
|
2739 |
|
2740 |
|
2741 |
|
2742 |
|
2743 |
|
2744 |
|
2745 |
|
2746 |
|
2747 | <h5>Returns:</h5>
|
2748 |
|
2749 |
|
2750 | <div class="param-desc">
|
2751 | <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>
|
2752 | </div>
|
2753 |
|
2754 |
|
2755 |
|
2756 | <dl>
|
2757 | <dt>
|
2758 | Type
|
2759 | </dt>
|
2760 | <dd>
|
2761 |
|
2762 | <span class="param-type">number</span>
|
2763 |
|
2764 |
|
2765 |
|
2766 | </dd>
|
2767 | </dl>
|
2768 |
|
2769 |
|
2770 |
|
2771 |
|
2772 |
|
2773 | </dd>
|
2774 |
|
2775 |
|
2776 |
|
2777 | <hr>
|
2778 | <dt>
|
2779 | <h4 class="name" id="getProgress"><span class="type-signature"></span>getProgress<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
|
2780 |
|
2781 |
|
2782 | </dt>
|
2783 | <dd>
|
2784 |
|
2785 |
|
2786 | <div class="description">
|
2787 | <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>
|
2788 | </div>
|
2789 |
|
2790 |
|
2791 |
|
2792 |
|
2793 |
|
2794 |
|
2795 |
|
2796 |
|
2797 |
|
2798 |
|
2799 | <dl class="details">
|
2800 |
|
2801 |
|
2802 |
|
2803 |
|
2804 |
|
2805 |
|
2806 |
|
2807 |
|
2808 |
|
2809 |
|
2810 |
|
2811 |
|
2812 |
|
2813 |
|
2814 |
|
2815 |
|
2816 |
|
2817 |
|
2818 |
|
2819 |
|
2820 |
|
2821 |
|
2822 |
|
2823 |
|
2824 |
|
2825 |
|
2826 |
|
2827 |
|
2828 |
|
2829 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2830 | <dd class="tag-source">
|
2831 | <ul class="dummy">
|
2832 | <li>
|
2833 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
2834 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-1126">line 1126</a>
|
2835 | </li>
|
2836 | </ul>
|
2837 | </dd>
|
2838 |
|
2839 |
|
2840 |
|
2841 |
|
2842 |
|
2843 |
|
2844 |
|
2845 | </dl>
|
2846 |
|
2847 |
|
2848 |
|
2849 |
|
2850 |
|
2851 |
|
2852 |
|
2853 |
|
2854 |
|
2855 |
|
2856 |
|
2857 |
|
2858 |
|
2859 | <h5>Returns:</h5>
|
2860 |
|
2861 |
|
2862 | <div class="param-desc">
|
2863 | <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>
|
2864 | </div>
|
2865 |
|
2866 |
|
2867 |
|
2868 | <dl>
|
2869 | <dt>
|
2870 | Type
|
2871 | </dt>
|
2872 | <dd>
|
2873 |
|
2874 | <span class="param-type">number</span>
|
2875 |
|
2876 |
|
2877 |
|
2878 | </dd>
|
2879 | </dl>
|
2880 |
|
2881 |
|
2882 |
|
2883 |
|
2884 |
|
2885 | </dd>
|
2886 |
|
2887 |
|
2888 |
|
2889 | <hr>
|
2890 | <dt>
|
2891 | <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">( [filePath] [, autoPlay] [, callbackOk] [, callbackError] [, forceReload])</span><span class="type-signature"> → {<a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a>|null}</span></h4>
|
2892 |
|
2893 |
|
2894 | </dt>
|
2895 | <dd>
|
2896 |
|
2897 |
|
2898 | <div class="description">
|
2899 | <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. This method will be called automatically by the constructor if the "autoLoad" option was set to true in its given "options" parameter.<br>When this method is called, if the <a href="CB_AudioFile_API.ACMP.html#status"><code>CB_AudioFile_API.ACMP#status</code></a> property already has the "LOADED" status (defined in the <a href="CB_AudioFile.html#.LOADED"><code>CB_AudioFile.LOADED</code></a> constant) and the "forceReload" parameter is not set to true, it will exit calling the given "callbackOk" function (if any) immediately. Otherwise, regardless the status, the status will be set to "LOADING" (defined in the <a href="CB_AudioFile.html#.LOADING"><code>CB_AudioFile.LOADING</code></a> constant). After it, it will reach the "UNCHECKED" (defined in the <a href="CB_AudioFile.html#.UNCHECKED"><code>CB_AudioFile.UNCHECKED</code></a> constant). If the "autoPlay" 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.ACMP.html#checkPlaying"><code>CB_AudioFile_API.ACMP#checkPlaying</code></a> method after it). After it and only if the "autoPlay" is set to true, as the <a href="CB_AudioFile_API.ACMP.html#checkPlaying"><code>CB_AudioFile_API.ACMP#checkPlaying</code></a> method will be called internally, it will have the "CHECKING" status (defined in the <a href="CB_AudioFile.html#.CHECKING"><code>CB_AudioFile.CHECKING</code></a> constant) and finally the "LOADED" status (defined in the <a href="CB_AudioFile.html#.LOADED"><code>CB_AudioFile.LOADED</code></a> constant) if all goes well.</p>
|
2900 | </div>
|
2901 |
|
2902 |
|
2903 |
|
2904 |
|
2905 |
|
2906 |
|
2907 |
|
2908 |
|
2909 | <h5>Parameters:</h5>
|
2910 |
|
2911 |
|
2912 | <table class="params table table-striped">
|
2913 | <thead>
|
2914 | <tr>
|
2915 |
|
2916 | <th style="width:12%; min-width:110px;">Name</th>
|
2917 |
|
2918 |
|
2919 | <th style="width:12%; min-width:110px;">Type</th>
|
2920 |
|
2921 |
|
2922 | <th style="width:12%; min-width:110px;">Argument</th>
|
2923 |
|
2924 |
|
2925 |
|
2926 | <th style="width:12%; min-width:110px;">Default</th>
|
2927 |
|
2928 |
|
2929 | <th class="last" style="min-width:310px;">Description</th>
|
2930 | </tr>
|
2931 | </thead>
|
2932 |
|
2933 | <tbody>
|
2934 |
|
2935 |
|
2936 | <tr>
|
2937 |
|
2938 | <td class="name" style="width:12%; min-width:110px; 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>
|
2939 |
|
2940 |
|
2941 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2942 |
|
2943 |
|
2944 | <span class="param-type">string</span>
|
2945 |
|
2946 |
|
2947 |
|
2948 |
|
2949 | </td>
|
2950 |
|
2951 |
|
2952 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2953 |
|
2954 | <optional><br>
|
2955 |
|
2956 |
|
2957 |
|
2958 |
|
2959 |
|
2960 | </td>
|
2961 |
|
2962 |
|
2963 |
|
2964 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2965 |
|
2966 | <a href="CB_AudioFile_API.ACMP.html#filePath"><code>CB_AudioFile_API.ACMP#filePath</code></a>
|
2967 |
|
2968 | </td>
|
2969 |
|
2970 |
|
2971 | <td class="description last" style="min-width:310px; 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>
|
2972 | </tr>
|
2973 |
|
2974 |
|
2975 |
|
2976 | <tr>
|
2977 |
|
2978 | <td class="name" style="width:12%; min-width:110px; 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>
|
2979 |
|
2980 |
|
2981 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2982 |
|
2983 |
|
2984 | <span class="param-type">string</span>
|
2985 |
|
2986 |
|
2987 |
|
2988 |
|
2989 | </td>
|
2990 |
|
2991 |
|
2992 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
2993 |
|
2994 | <optional><br>
|
2995 |
|
2996 |
|
2997 |
|
2998 |
|
2999 |
|
3000 | </td>
|
3001 |
|
3002 |
|
3003 |
|
3004 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3005 |
|
3006 | false
|
3007 |
|
3008 | </td>
|
3009 |
|
3010 |
|
3011 | <td class="description last" style="min-width:310px; 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.ACMP.html#play"><code>CB_AudioFile_API.ACMP#play</code></a> method internally). If set to true and the <a href="CB_AudioFile_API.ACMP.html#status"><code>CB_AudioFile_API.ACMP#status</code></a> property reaches to the "UNCHECKED" 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.ACMP.html#checkPlaying"><code>CB_AudioFile_API.ACMP#checkPlaying</code></a> method.</p></td>
|
3012 | </tr>
|
3013 |
|
3014 |
|
3015 |
|
3016 | <tr>
|
3017 |
|
3018 | <td class="name" style="width:12%; min-width:110px; 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>
|
3019 |
|
3020 |
|
3021 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3022 |
|
3023 |
|
3024 | <span class="param-type">function</span>
|
3025 |
|
3026 |
|
3027 |
|
3028 |
|
3029 | </td>
|
3030 |
|
3031 |
|
3032 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3033 |
|
3034 | <optional><br>
|
3035 |
|
3036 |
|
3037 |
|
3038 |
|
3039 |
|
3040 | </td>
|
3041 |
|
3042 |
|
3043 |
|
3044 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3045 |
|
3046 | </td>
|
3047 |
|
3048 |
|
3049 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object itself.</p></td>
|
3050 | </tr>
|
3051 |
|
3052 |
|
3053 |
|
3054 | <tr>
|
3055 |
|
3056 | <td class="name" style="width:12%; min-width:110px; 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>
|
3057 |
|
3058 |
|
3059 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3060 |
|
3061 |
|
3062 | <span class="param-type">function</span>
|
3063 |
|
3064 |
|
3065 |
|
3066 |
|
3067 | </td>
|
3068 |
|
3069 |
|
3070 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3071 |
|
3072 | <optional><br>
|
3073 |
|
3074 |
|
3075 |
|
3076 |
|
3077 |
|
3078 | </td>
|
3079 |
|
3080 |
|
3081 |
|
3082 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3083 |
|
3084 | </td>
|
3085 |
|
3086 |
|
3087 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object itself.</p></td>
|
3088 | </tr>
|
3089 |
|
3090 |
|
3091 |
|
3092 | <tr>
|
3093 |
|
3094 | <td class="name" style="width:12%; min-width:110px; 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>
|
3095 |
|
3096 |
|
3097 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3098 |
|
3099 |
|
3100 | <span class="param-type">boolean</span>
|
3101 |
|
3102 |
|
3103 |
|
3104 |
|
3105 | </td>
|
3106 |
|
3107 |
|
3108 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3109 |
|
3110 | <optional><br>
|
3111 |
|
3112 |
|
3113 |
|
3114 |
|
3115 |
|
3116 | </td>
|
3117 |
|
3118 |
|
3119 |
|
3120 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3121 |
|
3122 | false
|
3123 |
|
3124 | </td>
|
3125 |
|
3126 |
|
3127 | <td class="description last" style="min-width:310px; 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 "filePath" has not been changed from the previously used and the <a href="CB_AudioFile_API.ACMP.html#status"><code>CB_AudioFile_API.ACMP#status</code></a> property belongs to the "LOADED" 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 "callbackOk" function, if any).</p></td>
|
3128 | </tr>
|
3129 |
|
3130 |
|
3131 | </tbody>
|
3132 | </table>
|
3133 |
|
3134 |
|
3135 |
|
3136 |
|
3137 | <dl class="details">
|
3138 |
|
3139 |
|
3140 |
|
3141 |
|
3142 |
|
3143 |
|
3144 |
|
3145 |
|
3146 |
|
3147 |
|
3148 |
|
3149 |
|
3150 |
|
3151 |
|
3152 |
|
3153 |
|
3154 |
|
3155 |
|
3156 |
|
3157 |
|
3158 |
|
3159 |
|
3160 |
|
3161 |
|
3162 |
|
3163 |
|
3164 |
|
3165 |
|
3166 |
|
3167 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3168 | <dd class="tag-source">
|
3169 | <ul class="dummy">
|
3170 | <li>
|
3171 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
3172 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-288">line 288</a>
|
3173 | </li>
|
3174 | </ul>
|
3175 | </dd>
|
3176 |
|
3177 |
|
3178 |
|
3179 |
|
3180 |
|
3181 |
|
3182 |
|
3183 | </dl>
|
3184 |
|
3185 |
|
3186 |
|
3187 |
|
3188 |
|
3189 |
|
3190 |
|
3191 |
|
3192 |
|
3193 |
|
3194 |
|
3195 |
|
3196 |
|
3197 | <h5>Returns:</h5>
|
3198 |
|
3199 |
|
3200 | <div class="param-desc">
|
3201 | <p>Returns the audio API object (if it was possible to create) or null otherwise.</p>
|
3202 | </div>
|
3203 |
|
3204 |
|
3205 |
|
3206 | <dl>
|
3207 | <dt>
|
3208 | Type
|
3209 | </dt>
|
3210 | <dd>
|
3211 |
|
3212 | <span class="param-type"><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></span>
|
3213 | |
|
3214 |
|
3215 | <span class="param-type">null</span>
|
3216 |
|
3217 |
|
3218 |
|
3219 | </dd>
|
3220 | </dl>
|
3221 |
|
3222 |
|
3223 |
|
3224 |
|
3225 |
|
3226 | </dd>
|
3227 |
|
3228 |
|
3229 |
|
3230 | <hr>
|
3231 | <dt>
|
3232 | <h4 class="name" id="mute"><span class="type-signature"></span>mute<span class="signature">( [onMute])</span><span class="type-signature"> → {number}</span></h4>
|
3233 |
|
3234 |
|
3235 | </dt>
|
3236 | <dd>
|
3237 |
|
3238 |
|
3239 | <div class="description">
|
3240 | <p>Mutes the audio file.</p>
|
3241 | </div>
|
3242 |
|
3243 |
|
3244 |
|
3245 |
|
3246 |
|
3247 |
|
3248 |
|
3249 |
|
3250 | <h5>Parameters:</h5>
|
3251 |
|
3252 |
|
3253 | <table class="params table table-striped">
|
3254 | <thead>
|
3255 | <tr>
|
3256 |
|
3257 | <th style="width:12%; min-width:110px;">Name</th>
|
3258 |
|
3259 |
|
3260 | <th style="width:12%; min-width:110px;">Type</th>
|
3261 |
|
3262 |
|
3263 | <th style="width:12%; min-width:110px;">Argument</th>
|
3264 |
|
3265 |
|
3266 |
|
3267 |
|
3268 | <th class="last" style="min-width:310px;">Description</th>
|
3269 | </tr>
|
3270 | </thead>
|
3271 |
|
3272 | <tbody>
|
3273 |
|
3274 |
|
3275 | <tr>
|
3276 |
|
3277 | <td class="name" style="width:12%; min-width:110px; 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>
|
3278 |
|
3279 |
|
3280 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3281 |
|
3282 |
|
3283 | <span class="param-type">function</span>
|
3284 |
|
3285 |
|
3286 |
|
3287 |
|
3288 | </td>
|
3289 |
|
3290 |
|
3291 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3292 |
|
3293 | <optional><br>
|
3294 |
|
3295 |
|
3296 |
|
3297 |
|
3298 |
|
3299 | </td>
|
3300 |
|
3301 |
|
3302 |
|
3303 |
|
3304 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object.</p></td>
|
3305 | </tr>
|
3306 |
|
3307 |
|
3308 | </tbody>
|
3309 | </table>
|
3310 |
|
3311 |
|
3312 |
|
3313 |
|
3314 | <dl class="details">
|
3315 |
|
3316 |
|
3317 |
|
3318 |
|
3319 |
|
3320 |
|
3321 |
|
3322 |
|
3323 |
|
3324 |
|
3325 |
|
3326 |
|
3327 |
|
3328 |
|
3329 |
|
3330 |
|
3331 |
|
3332 |
|
3333 |
|
3334 |
|
3335 |
|
3336 |
|
3337 |
|
3338 |
|
3339 |
|
3340 |
|
3341 |
|
3342 |
|
3343 |
|
3344 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3345 | <dd class="tag-source">
|
3346 | <ul class="dummy">
|
3347 | <li>
|
3348 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
3349 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-1030">line 1030</a>
|
3350 | </li>
|
3351 | </ul>
|
3352 | </dd>
|
3353 |
|
3354 |
|
3355 |
|
3356 |
|
3357 |
|
3358 |
|
3359 |
|
3360 | </dl>
|
3361 |
|
3362 |
|
3363 |
|
3364 |
|
3365 |
|
3366 |
|
3367 |
|
3368 |
|
3369 |
|
3370 |
|
3371 |
|
3372 |
|
3373 |
|
3374 | <h5>Returns:</h5>
|
3375 |
|
3376 |
|
3377 | <div class="param-desc">
|
3378 | <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>
|
3379 | </div>
|
3380 |
|
3381 |
|
3382 |
|
3383 | <dl>
|
3384 | <dt>
|
3385 | Type
|
3386 | </dt>
|
3387 | <dd>
|
3388 |
|
3389 | <span class="param-type">number</span>
|
3390 |
|
3391 |
|
3392 |
|
3393 | </dd>
|
3394 | </dl>
|
3395 |
|
3396 |
|
3397 |
|
3398 |
|
3399 |
|
3400 | </dd>
|
3401 |
|
3402 |
|
3403 |
|
3404 | <hr>
|
3405 | <dt>
|
3406 | <h4 class="name" id="onStop"><span class="type-signature"></span>onStop<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"> → {boolean}</span></h4>
|
3407 |
|
3408 |
|
3409 | </dt>
|
3410 | <dd>
|
3411 |
|
3412 |
|
3413 | <div class="description">
|
3414 | <p>Sets a function to execute when the audio file stops playing or removes it.</p>
|
3415 | </div>
|
3416 |
|
3417 |
|
3418 |
|
3419 |
|
3420 |
|
3421 |
|
3422 |
|
3423 |
|
3424 | <h5>Parameters:</h5>
|
3425 |
|
3426 |
|
3427 | <table class="params table table-striped">
|
3428 | <thead>
|
3429 | <tr>
|
3430 |
|
3431 | <th style="width:12%; min-width:110px;">Name</th>
|
3432 |
|
3433 |
|
3434 | <th style="width:12%; min-width:110px;">Type</th>
|
3435 |
|
3436 |
|
3437 | <th style="width:12%; min-width:110px;">Argument</th>
|
3438 |
|
3439 |
|
3440 |
|
3441 | <th style="width:12%; min-width:110px;">Default</th>
|
3442 |
|
3443 |
|
3444 | <th class="last" style="min-width:310px;">Description</th>
|
3445 | </tr>
|
3446 | </thead>
|
3447 |
|
3448 | <tbody>
|
3449 |
|
3450 |
|
3451 | <tr>
|
3452 |
|
3453 | <td class="name" style="width:12%; min-width:110px; 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>
|
3454 |
|
3455 |
|
3456 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3457 |
|
3458 |
|
3459 | <span class="param-type">function</span>
|
3460 | |
|
3461 |
|
3462 | <span class="param-type">null</span>
|
3463 |
|
3464 |
|
3465 |
|
3466 |
|
3467 | </td>
|
3468 |
|
3469 |
|
3470 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3471 |
|
3472 |
|
3473 |
|
3474 |
|
3475 |
|
3476 | </td>
|
3477 |
|
3478 |
|
3479 |
|
3480 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3481 |
|
3482 | </td>
|
3483 |
|
3484 |
|
3485 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object. If a null value is used, the event will be removed.</p></td>
|
3486 | </tr>
|
3487 |
|
3488 |
|
3489 |
|
3490 | <tr>
|
3491 |
|
3492 | <td class="name" style="width:12%; min-width:110px; 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>
|
3493 |
|
3494 |
|
3495 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3496 |
|
3497 |
|
3498 | <span class="param-type">boolean</span>
|
3499 |
|
3500 |
|
3501 |
|
3502 |
|
3503 | </td>
|
3504 |
|
3505 |
|
3506 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3507 |
|
3508 | <optional><br>
|
3509 |
|
3510 |
|
3511 |
|
3512 |
|
3513 |
|
3514 | </td>
|
3515 |
|
3516 |
|
3517 |
|
3518 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3519 |
|
3520 | true
|
3521 |
|
3522 | </td>
|
3523 |
|
3524 |
|
3525 | <td class="description last" style="min-width:310px; 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>
|
3526 | </tr>
|
3527 |
|
3528 |
|
3529 | </tbody>
|
3530 | </table>
|
3531 |
|
3532 |
|
3533 |
|
3534 |
|
3535 | <dl class="details">
|
3536 |
|
3537 |
|
3538 |
|
3539 |
|
3540 |
|
3541 |
|
3542 |
|
3543 |
|
3544 |
|
3545 |
|
3546 |
|
3547 |
|
3548 |
|
3549 |
|
3550 |
|
3551 |
|
3552 |
|
3553 |
|
3554 |
|
3555 |
|
3556 |
|
3557 |
|
3558 |
|
3559 |
|
3560 |
|
3561 |
|
3562 |
|
3563 |
|
3564 |
|
3565 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3566 | <dd class="tag-source">
|
3567 | <ul class="dummy">
|
3568 | <li>
|
3569 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
3570 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-1089">line 1089</a>
|
3571 | </li>
|
3572 | </ul>
|
3573 | </dd>
|
3574 |
|
3575 |
|
3576 |
|
3577 |
|
3578 |
|
3579 |
|
3580 |
|
3581 | </dl>
|
3582 |
|
3583 |
|
3584 |
|
3585 |
|
3586 |
|
3587 |
|
3588 |
|
3589 |
|
3590 |
|
3591 |
|
3592 |
|
3593 |
|
3594 |
|
3595 | <h5>Returns:</h5>
|
3596 |
|
3597 |
|
3598 | <div class="param-desc">
|
3599 | <p>Returns whether the event has been set or not (removed).</p>
|
3600 | </div>
|
3601 |
|
3602 |
|
3603 |
|
3604 | <dl>
|
3605 | <dt>
|
3606 | Type
|
3607 | </dt>
|
3608 | <dd>
|
3609 |
|
3610 | <span class="param-type">boolean</span>
|
3611 |
|
3612 |
|
3613 |
|
3614 | </dd>
|
3615 | </dl>
|
3616 |
|
3617 |
|
3618 |
|
3619 |
|
3620 |
|
3621 | </dd>
|
3622 |
|
3623 |
|
3624 |
|
3625 | <hr>
|
3626 | <dt>
|
3627 | <h4 class="name" id="pause"><span class="type-signature"></span>pause<span class="signature">( [onPause] [, keepPausedUnaltered])</span><span class="type-signature"> → {boolean}</span></h4>
|
3628 |
|
3629 |
|
3630 | </dt>
|
3631 | <dd>
|
3632 |
|
3633 |
|
3634 | <div class="description">
|
3635 | <p>Pauses the audio when it is being played.</p>
|
3636 | </div>
|
3637 |
|
3638 |
|
3639 |
|
3640 |
|
3641 |
|
3642 |
|
3643 |
|
3644 |
|
3645 | <h5>Parameters:</h5>
|
3646 |
|
3647 |
|
3648 | <table class="params table table-striped">
|
3649 | <thead>
|
3650 | <tr>
|
3651 |
|
3652 | <th style="width:12%; min-width:110px;">Name</th>
|
3653 |
|
3654 |
|
3655 | <th style="width:12%; min-width:110px;">Type</th>
|
3656 |
|
3657 |
|
3658 | <th style="width:12%; min-width:110px;">Argument</th>
|
3659 |
|
3660 |
|
3661 |
|
3662 | <th style="width:12%; min-width:110px;">Default</th>
|
3663 |
|
3664 |
|
3665 | <th class="last" style="min-width:310px;">Description</th>
|
3666 | </tr>
|
3667 | </thead>
|
3668 |
|
3669 | <tbody>
|
3670 |
|
3671 |
|
3672 | <tr>
|
3673 |
|
3674 | <td class="name" style="width:12%; min-width:110px; 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>
|
3675 |
|
3676 |
|
3677 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3678 |
|
3679 |
|
3680 | <span class="param-type">function</span>
|
3681 |
|
3682 |
|
3683 |
|
3684 |
|
3685 | </td>
|
3686 |
|
3687 |
|
3688 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3689 |
|
3690 | <optional><br>
|
3691 |
|
3692 |
|
3693 |
|
3694 |
|
3695 |
|
3696 | </td>
|
3697 |
|
3698 |
|
3699 |
|
3700 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3701 |
|
3702 | </td>
|
3703 |
|
3704 |
|
3705 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object.</p></td>
|
3706 | </tr>
|
3707 |
|
3708 |
|
3709 |
|
3710 | <tr>
|
3711 |
|
3712 | <td class="name" style="width:12%; min-width:110px; 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>
|
3713 |
|
3714 |
|
3715 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3716 |
|
3717 |
|
3718 | <span class="param-type">boolean</span>
|
3719 |
|
3720 |
|
3721 |
|
3722 |
|
3723 | </td>
|
3724 |
|
3725 |
|
3726 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3727 |
|
3728 | <optional><br>
|
3729 |
|
3730 |
|
3731 |
|
3732 |
|
3733 |
|
3734 | </td>
|
3735 |
|
3736 |
|
3737 |
|
3738 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3739 |
|
3740 | false
|
3741 |
|
3742 | </td>
|
3743 |
|
3744 |
|
3745 | <td class="description last" style="min-width:310px; 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.ACMP.html#paused"><code>CB_AudioFile_API.ACMP#paused</code></a> property will not be set to true and it will remain with its current value.</p></td>
|
3746 | </tr>
|
3747 |
|
3748 |
|
3749 | </tbody>
|
3750 | </table>
|
3751 |
|
3752 |
|
3753 |
|
3754 |
|
3755 | <dl class="details">
|
3756 |
|
3757 |
|
3758 |
|
3759 |
|
3760 |
|
3761 |
|
3762 |
|
3763 |
|
3764 |
|
3765 |
|
3766 |
|
3767 |
|
3768 |
|
3769 |
|
3770 |
|
3771 |
|
3772 |
|
3773 |
|
3774 |
|
3775 |
|
3776 |
|
3777 |
|
3778 |
|
3779 |
|
3780 |
|
3781 |
|
3782 |
|
3783 |
|
3784 |
|
3785 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3786 | <dd class="tag-source">
|
3787 | <ul class="dummy">
|
3788 | <li>
|
3789 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
3790 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-931">line 931</a>
|
3791 | </li>
|
3792 | </ul>
|
3793 | </dd>
|
3794 |
|
3795 |
|
3796 |
|
3797 |
|
3798 |
|
3799 |
|
3800 |
|
3801 | </dl>
|
3802 |
|
3803 |
|
3804 |
|
3805 |
|
3806 |
|
3807 |
|
3808 |
|
3809 |
|
3810 |
|
3811 |
|
3812 |
|
3813 |
|
3814 |
|
3815 | <h5>Returns:</h5>
|
3816 |
|
3817 |
|
3818 | <div class="param-desc">
|
3819 | <p>It returns false if the audio is already paused or it is stopped or if it cannot be paused. Returns true otherwise.</p>
|
3820 | </div>
|
3821 |
|
3822 |
|
3823 |
|
3824 | <dl>
|
3825 | <dt>
|
3826 | Type
|
3827 | </dt>
|
3828 | <dd>
|
3829 |
|
3830 | <span class="param-type">boolean</span>
|
3831 |
|
3832 |
|
3833 |
|
3834 | </dd>
|
3835 | </dl>
|
3836 |
|
3837 |
|
3838 |
|
3839 |
|
3840 |
|
3841 | </dd>
|
3842 |
|
3843 |
|
3844 |
|
3845 | <hr>
|
3846 | <dt>
|
3847 | <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"> → {boolean|integer}</span></h4>
|
3848 |
|
3849 |
|
3850 | </dt>
|
3851 | <dd>
|
3852 |
|
3853 |
|
3854 | <div class="description">
|
3855 | <p>Plays the audio.</p>
|
3856 | </div>
|
3857 |
|
3858 |
|
3859 |
|
3860 |
|
3861 |
|
3862 |
|
3863 |
|
3864 |
|
3865 | <h5>Parameters:</h5>
|
3866 |
|
3867 |
|
3868 | <table class="params table table-striped">
|
3869 | <thead>
|
3870 | <tr>
|
3871 |
|
3872 | <th style="width:12%; min-width:110px;">Name</th>
|
3873 |
|
3874 |
|
3875 | <th style="width:12%; min-width:110px;">Type</th>
|
3876 |
|
3877 |
|
3878 | <th style="width:12%; min-width:110px;">Argument</th>
|
3879 |
|
3880 |
|
3881 |
|
3882 | <th style="width:12%; min-width:110px;">Default</th>
|
3883 |
|
3884 |
|
3885 | <th class="last" style="min-width:310px;">Description</th>
|
3886 | </tr>
|
3887 | </thead>
|
3888 |
|
3889 | <tbody>
|
3890 |
|
3891 |
|
3892 | <tr>
|
3893 |
|
3894 | <td class="name" style="width:12%; min-width:110px; 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>
|
3895 |
|
3896 |
|
3897 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3898 |
|
3899 |
|
3900 | <span class="param-type">number</span>
|
3901 |
|
3902 |
|
3903 |
|
3904 |
|
3905 | </td>
|
3906 |
|
3907 |
|
3908 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3909 |
|
3910 | <optional><br>
|
3911 |
|
3912 |
|
3913 |
|
3914 |
|
3915 |
|
3916 | </td>
|
3917 |
|
3918 |
|
3919 |
|
3920 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3921 |
|
3922 | 0 | <a href="CB_AudioFile_API.ACMP.html#lastStartAt"><code>CB_AudioFile_API.ACMP#lastStartAt</code></a> | stopAt
|
3923 |
|
3924 | </td>
|
3925 |
|
3926 |
|
3927 | <td class="description last" style="min-width:310px; 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 "stopAt" provided, it will use the value set in the <a href="CB_AudioFile_API.ACMP.html#lastStartAt"><code>CB_AudioFile_API.ACMP#lastStartAt</code></a> property (which belongs to the "startAt" value the last time that this method was called). If, even using the <a href="CB_AudioFile_API.ACMP.html#lastStartAt"><code>CB_AudioFile_API.ACMP#lastStartAt</code></a> value is still greather than the "stopAt" provided, it will use the same value as the "stopAt" which means it will not play and will stop immediately.</p></td>
|
3928 | </tr>
|
3929 |
|
3930 |
|
3931 |
|
3932 | <tr>
|
3933 |
|
3934 | <td class="name" style="width:12%; min-width:110px; 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>
|
3935 |
|
3936 |
|
3937 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3938 |
|
3939 |
|
3940 | <span class="param-type">number</span>
|
3941 |
|
3942 |
|
3943 |
|
3944 |
|
3945 | </td>
|
3946 |
|
3947 |
|
3948 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3949 |
|
3950 | <optional><br>
|
3951 |
|
3952 |
|
3953 |
|
3954 |
|
3955 |
|
3956 | </td>
|
3957 |
|
3958 |
|
3959 |
|
3960 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3961 |
|
3962 | <a href="CB_AudioFile_API.ACMP.html#getDuration"><code>CB_AudioFile_API.ACMP#getDuration</code></a>()
|
3963 |
|
3964 | </td>
|
3965 |
|
3966 |
|
3967 | <td class="description last" style="min-width:310px; 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.ACMP.html#getDuration"><code>CB_AudioFile_API.ACMP#getDuration</code></a> method (which should belong to the total duration of the audio, if it was calculated correctly).</p></td>
|
3968 | </tr>
|
3969 |
|
3970 |
|
3971 |
|
3972 | <tr>
|
3973 |
|
3974 | <td class="name" style="width:12%; min-width:110px; 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>
|
3975 |
|
3976 |
|
3977 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3978 |
|
3979 |
|
3980 | <span class="param-type">boolean</span>
|
3981 |
|
3982 |
|
3983 |
|
3984 |
|
3985 | </td>
|
3986 |
|
3987 |
|
3988 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
3989 |
|
3990 | <optional><br>
|
3991 |
|
3992 |
|
3993 |
|
3994 |
|
3995 |
|
3996 | </td>
|
3997 |
|
3998 |
|
3999 |
|
4000 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4001 |
|
4002 | <a href="CB_AudioFile_API.ACMP.html#loop"><code>CB_AudioFile_API.ACMP#loop</code></a>
|
4003 |
|
4004 | </td>
|
4005 |
|
4006 |
|
4007 | <td class="description last" style="min-width:310px; 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 "onStop" function defined (through the <a href="CB_AudioFile_API.ACMP.html#onStop"><code>CB_AudioFile_API.ACMP#onStop</code></a> method) will not be called.</p></td>
|
4008 | </tr>
|
4009 |
|
4010 |
|
4011 |
|
4012 | <tr>
|
4013 |
|
4014 | <td class="name" style="width:12%; min-width:110px; 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>
|
4015 |
|
4016 |
|
4017 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4018 |
|
4019 |
|
4020 | <span class="param-type">boolean</span>
|
4021 |
|
4022 |
|
4023 |
|
4024 |
|
4025 | </td>
|
4026 |
|
4027 |
|
4028 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4029 |
|
4030 | <optional><br>
|
4031 |
|
4032 |
|
4033 |
|
4034 |
|
4035 |
|
4036 | </td>
|
4037 |
|
4038 |
|
4039 |
|
4040 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4041 |
|
4042 | false
|
4043 |
|
4044 | </td>
|
4045 |
|
4046 |
|
4047 | <td class="description last" style="min-width:310px; 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 "stop" method will be called immediately.</p></td>
|
4048 | </tr>
|
4049 |
|
4050 |
|
4051 |
|
4052 | <tr>
|
4053 |
|
4054 | <td class="name" style="width:12%; min-width:110px; 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>
|
4055 |
|
4056 |
|
4057 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4058 |
|
4059 |
|
4060 | <span class="param-type">boolean</span>
|
4061 |
|
4062 |
|
4063 |
|
4064 |
|
4065 | </td>
|
4066 |
|
4067 |
|
4068 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4069 |
|
4070 | <optional><br>
|
4071 |
|
4072 |
|
4073 |
|
4074 |
|
4075 |
|
4076 | </td>
|
4077 |
|
4078 |
|
4079 |
|
4080 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4081 |
|
4082 | <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>
|
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>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.ACMP.html#stop"><code>CB_AudioFile_API.ACMP#stop</code></a> method will be called immediately. Used only when the "avoidDelayedPlay" parameter is set to false and the audio needs to be loaded because it failed previously or was aborted (destroyed).</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>onPlayStart</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">function</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 | <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 | </td>
|
4123 |
|
4124 |
|
4125 | <td class="description last" style="min-width:310px; 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): "startAt", "stopAt", "startAtNextLoop", "loop", "avoidDelayedPlay", "allowedRecursiveDelay" and "startPlayingTime", being "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</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>
|
4126 | </tr>
|
4127 |
|
4128 |
|
4129 |
|
4130 | <tr>
|
4131 |
|
4132 | <td class="name" style="width:12%; min-width:110px; 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>
|
4133 |
|
4134 |
|
4135 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4136 |
|
4137 |
|
4138 | <span class="param-type">function</span>
|
4139 |
|
4140 |
|
4141 |
|
4142 |
|
4143 | </td>
|
4144 |
|
4145 |
|
4146 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4147 |
|
4148 | <optional><br>
|
4149 |
|
4150 |
|
4151 |
|
4152 |
|
4153 |
|
4154 | </td>
|
4155 |
|
4156 |
|
4157 |
|
4158 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4159 |
|
4160 | </td>
|
4161 |
|
4162 |
|
4163 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object.</p></td>
|
4164 | </tr>
|
4165 |
|
4166 |
|
4167 |
|
4168 | <tr>
|
4169 |
|
4170 | <td class="name" style="width:12%; min-width:110px; 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>
|
4171 |
|
4172 |
|
4173 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4174 |
|
4175 |
|
4176 | <span class="param-type">boolean</span>
|
4177 |
|
4178 |
|
4179 |
|
4180 |
|
4181 | </td>
|
4182 |
|
4183 |
|
4184 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4185 |
|
4186 | <optional><br>
|
4187 |
|
4188 |
|
4189 |
|
4190 |
|
4191 |
|
4192 | </td>
|
4193 |
|
4194 |
|
4195 |
|
4196 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4197 |
|
4198 | false
|
4199 |
|
4200 | </td>
|
4201 |
|
4202 |
|
4203 | <td class="description last" style="min-width:310px; 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.ACMP.html#lastStartAt"><code>CB_AudioFile_API.ACMP#lastStartAt</code></a> property as the "startAt" parameter when it calls this method again automatically (internally). Recommended for internal usage only.</p></td>
|
4204 | </tr>
|
4205 |
|
4206 |
|
4207 |
|
4208 | <tr>
|
4209 |
|
4210 | <td class="name" style="width:12%; min-width:110px; 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>
|
4211 |
|
4212 |
|
4213 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4214 |
|
4215 |
|
4216 | <span class="param-type">boolean</span>
|
4217 |
|
4218 |
|
4219 |
|
4220 |
|
4221 | </td>
|
4222 |
|
4223 |
|
4224 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4225 |
|
4226 | <optional><br>
|
4227 |
|
4228 |
|
4229 |
|
4230 |
|
4231 |
|
4232 | </td>
|
4233 |
|
4234 |
|
4235 |
|
4236 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4237 |
|
4238 | false
|
4239 |
|
4240 | </td>
|
4241 |
|
4242 |
|
4243 | <td class="description last" style="min-width:310px; 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>
|
4244 | </tr>
|
4245 |
|
4246 |
|
4247 |
|
4248 | <tr>
|
4249 |
|
4250 | <td class="name" style="width:12%; min-width:110px; 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>
|
4251 |
|
4252 |
|
4253 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4254 |
|
4255 |
|
4256 | <span class="param-type">integer</span>
|
4257 |
|
4258 |
|
4259 |
|
4260 |
|
4261 | </td>
|
4262 |
|
4263 |
|
4264 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4265 |
|
4266 | <optional><br>
|
4267 |
|
4268 |
|
4269 |
|
4270 |
|
4271 |
|
4272 | </td>
|
4273 |
|
4274 |
|
4275 |
|
4276 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4277 |
|
4278 | </td>
|
4279 |
|
4280 |
|
4281 | <td class="description last" style="min-width:310px; 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>
|
4282 | </tr>
|
4283 |
|
4284 |
|
4285 | </tbody>
|
4286 | </table>
|
4287 |
|
4288 |
|
4289 |
|
4290 |
|
4291 | <dl class="details">
|
4292 |
|
4293 |
|
4294 |
|
4295 |
|
4296 |
|
4297 |
|
4298 |
|
4299 |
|
4300 |
|
4301 |
|
4302 |
|
4303 |
|
4304 |
|
4305 |
|
4306 |
|
4307 |
|
4308 |
|
4309 |
|
4310 |
|
4311 |
|
4312 |
|
4313 |
|
4314 |
|
4315 |
|
4316 |
|
4317 |
|
4318 |
|
4319 |
|
4320 |
|
4321 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4322 | <dd class="tag-source">
|
4323 | <ul class="dummy">
|
4324 | <li>
|
4325 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
4326 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-703">line 703</a>
|
4327 | </li>
|
4328 | </ul>
|
4329 | </dd>
|
4330 |
|
4331 |
|
4332 |
|
4333 |
|
4334 |
|
4335 |
|
4336 |
|
4337 | </dl>
|
4338 |
|
4339 |
|
4340 |
|
4341 |
|
4342 |
|
4343 |
|
4344 |
|
4345 |
|
4346 |
|
4347 |
|
4348 |
|
4349 |
|
4350 |
|
4351 | <h5>Returns:</h5>
|
4352 |
|
4353 |
|
4354 | <div class="param-desc">
|
4355 | <p>It returns false if the duration is 0 ("startAt" and "stopAt" are the same number), returns "-1" 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>
|
4356 | </div>
|
4357 |
|
4358 |
|
4359 |
|
4360 | <dl>
|
4361 | <dt>
|
4362 | Type
|
4363 | </dt>
|
4364 | <dd>
|
4365 |
|
4366 | <span class="param-type">boolean</span>
|
4367 | |
|
4368 |
|
4369 | <span class="param-type">integer</span>
|
4370 |
|
4371 |
|
4372 |
|
4373 | </dd>
|
4374 | </dl>
|
4375 |
|
4376 |
|
4377 |
|
4378 |
|
4379 |
|
4380 | </dd>
|
4381 |
|
4382 |
|
4383 |
|
4384 | <hr>
|
4385 | <dt>
|
4386 | <h4 class="name" id="resume"><span class="type-signature"></span>resume<span class="signature">( [loop] [, avoidDelayedPlay] [, allowedRecursiveDelay] [, onPlayStart] [, onLoadError])</span><span class="type-signature"> → {boolean|integer}</span></h4>
|
4387 |
|
4388 |
|
4389 | </dt>
|
4390 | <dd>
|
4391 |
|
4392 |
|
4393 | <div class="description">
|
4394 | <p>Resumes the audio (after being paused), starting from the same point it was paused previously.</p>
|
4395 | </div>
|
4396 |
|
4397 |
|
4398 |
|
4399 |
|
4400 |
|
4401 |
|
4402 |
|
4403 |
|
4404 | <h5>Parameters:</h5>
|
4405 |
|
4406 |
|
4407 | <table class="params table table-striped">
|
4408 | <thead>
|
4409 | <tr>
|
4410 |
|
4411 | <th style="width:12%; min-width:110px;">Name</th>
|
4412 |
|
4413 |
|
4414 | <th style="width:12%; min-width:110px;">Type</th>
|
4415 |
|
4416 |
|
4417 | <th style="width:12%; min-width:110px;">Argument</th>
|
4418 |
|
4419 |
|
4420 |
|
4421 | <th style="width:12%; min-width:110px;">Default</th>
|
4422 |
|
4423 |
|
4424 | <th class="last" style="min-width:310px;">Description</th>
|
4425 | </tr>
|
4426 | </thead>
|
4427 |
|
4428 | <tbody>
|
4429 |
|
4430 |
|
4431 | <tr>
|
4432 |
|
4433 | <td class="name" style="width:12%; min-width:110px; 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>
|
4434 |
|
4435 |
|
4436 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4437 |
|
4438 |
|
4439 | <span class="param-type">boolean</span>
|
4440 |
|
4441 |
|
4442 |
|
4443 |
|
4444 | </td>
|
4445 |
|
4446 |
|
4447 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4448 |
|
4449 | <optional><br>
|
4450 |
|
4451 |
|
4452 |
|
4453 |
|
4454 |
|
4455 | </td>
|
4456 |
|
4457 |
|
4458 |
|
4459 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4460 |
|
4461 | <a href="CB_AudioFile_API.ACMP.html#loop"><code>CB_AudioFile_API.ACMP#loop</code></a>
|
4462 |
|
4463 | </td>
|
4464 |
|
4465 |
|
4466 | <td class="description last" style="min-width:310px; 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 "onStop" function defined (through the <a href="CB_AudioFile_API.ACMP.html#onStop"><code>CB_AudioFile_API.ACMP#onStop</code></a> method) will not be called.</p></td>
|
4467 | </tr>
|
4468 |
|
4469 |
|
4470 |
|
4471 | <tr>
|
4472 |
|
4473 | <td class="name" style="width:12%; min-width:110px; 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>
|
4474 |
|
4475 |
|
4476 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4477 |
|
4478 |
|
4479 | <span class="param-type">boolean</span>
|
4480 |
|
4481 |
|
4482 |
|
4483 |
|
4484 | </td>
|
4485 |
|
4486 |
|
4487 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4488 |
|
4489 | <optional><br>
|
4490 |
|
4491 |
|
4492 |
|
4493 |
|
4494 |
|
4495 | </td>
|
4496 |
|
4497 |
|
4498 |
|
4499 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4500 |
|
4501 | false
|
4502 |
|
4503 | </td>
|
4504 |
|
4505 |
|
4506 | <td class="description last" style="min-width:310px; 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.ACMP.html#stop"><code>CB_AudioFile_API.ACMP#stop</code></a> method will be called immediately.</p></td>
|
4507 | </tr>
|
4508 |
|
4509 |
|
4510 |
|
4511 | <tr>
|
4512 |
|
4513 | <td class="name" style="width:12%; min-width:110px; 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>
|
4514 |
|
4515 |
|
4516 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4517 |
|
4518 |
|
4519 | <span class="param-type">boolean</span>
|
4520 |
|
4521 |
|
4522 |
|
4523 |
|
4524 | </td>
|
4525 |
|
4526 |
|
4527 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4528 |
|
4529 | <optional><br>
|
4530 |
|
4531 |
|
4532 |
|
4533 |
|
4534 |
|
4535 | </td>
|
4536 |
|
4537 |
|
4538 |
|
4539 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4540 |
|
4541 | <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>
|
4542 |
|
4543 | </td>
|
4544 |
|
4545 |
|
4546 | <td class="description last" style="min-width:310px; 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.ACMP.html#stop"><code>CB_AudioFile_API.ACMP#stop</code></a> method will be called immediately. Used only when the "avoidDelayedPlay" parameter is set to false and the audio needs to be loaded because it failed previously or was aborted (destroyed).</p></td>
|
4547 | </tr>
|
4548 |
|
4549 |
|
4550 |
|
4551 | <tr>
|
4552 |
|
4553 | <td class="name" style="width:12%; min-width:110px; 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>
|
4554 |
|
4555 |
|
4556 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4557 |
|
4558 |
|
4559 | <span class="param-type">function</span>
|
4560 |
|
4561 |
|
4562 |
|
4563 |
|
4564 | </td>
|
4565 |
|
4566 |
|
4567 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4568 |
|
4569 | <optional><br>
|
4570 |
|
4571 |
|
4572 |
|
4573 |
|
4574 |
|
4575 | </td>
|
4576 |
|
4577 |
|
4578 |
|
4579 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4580 |
|
4581 | </td>
|
4582 |
|
4583 |
|
4584 | <td class="description last" style="min-width:310px; 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): "startAt", "stopAt", "startAtNextLoop", "loop", "avoidDelayedPlay", "allowedRecursiveDelay" and "startPlayingTime", being "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</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>
|
4585 | </tr>
|
4586 |
|
4587 |
|
4588 |
|
4589 | <tr>
|
4590 |
|
4591 | <td class="name" style="width:12%; min-width:110px; 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>
|
4592 |
|
4593 |
|
4594 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4595 |
|
4596 |
|
4597 | <span class="param-type">function</span>
|
4598 |
|
4599 |
|
4600 |
|
4601 |
|
4602 | </td>
|
4603 |
|
4604 |
|
4605 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4606 |
|
4607 | <optional><br>
|
4608 |
|
4609 |
|
4610 |
|
4611 |
|
4612 |
|
4613 | </td>
|
4614 |
|
4615 |
|
4616 |
|
4617 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4618 |
|
4619 | </td>
|
4620 |
|
4621 |
|
4622 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object.</p></td>
|
4623 | </tr>
|
4624 |
|
4625 |
|
4626 | </tbody>
|
4627 | </table>
|
4628 |
|
4629 |
|
4630 |
|
4631 |
|
4632 | <dl class="details">
|
4633 |
|
4634 |
|
4635 |
|
4636 |
|
4637 |
|
4638 |
|
4639 |
|
4640 |
|
4641 |
|
4642 |
|
4643 |
|
4644 |
|
4645 |
|
4646 |
|
4647 |
|
4648 |
|
4649 |
|
4650 |
|
4651 |
|
4652 |
|
4653 |
|
4654 |
|
4655 |
|
4656 |
|
4657 |
|
4658 |
|
4659 |
|
4660 |
|
4661 |
|
4662 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4663 | <dd class="tag-source">
|
4664 | <ul class="dummy">
|
4665 | <li>
|
4666 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
4667 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-902">line 902</a>
|
4668 | </li>
|
4669 | </ul>
|
4670 | </dd>
|
4671 |
|
4672 |
|
4673 |
|
4674 |
|
4675 |
|
4676 |
|
4677 |
|
4678 | </dl>
|
4679 |
|
4680 |
|
4681 |
|
4682 |
|
4683 |
|
4684 |
|
4685 |
|
4686 |
|
4687 |
|
4688 |
|
4689 |
|
4690 |
|
4691 |
|
4692 | <h5>Returns:</h5>
|
4693 |
|
4694 |
|
4695 | <div class="param-desc">
|
4696 | <p>Returns the returning value of the <a href="CB_AudioFile_API.ACMP.html#play"><code>CB_AudioFile_API.ACMP#play</code></a> method which is called internally. It returns false if the audio is not paused or it is stopped, returns "-1" 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>
|
4697 | </div>
|
4698 |
|
4699 |
|
4700 |
|
4701 | <dl>
|
4702 | <dt>
|
4703 | Type
|
4704 | </dt>
|
4705 | <dd>
|
4706 |
|
4707 | <span class="param-type">boolean</span>
|
4708 | |
|
4709 |
|
4710 | <span class="param-type">integer</span>
|
4711 |
|
4712 |
|
4713 |
|
4714 | </dd>
|
4715 | </dl>
|
4716 |
|
4717 |
|
4718 |
|
4719 |
|
4720 |
|
4721 | </dd>
|
4722 |
|
4723 |
|
4724 |
|
4725 | <hr>
|
4726 | <dt>
|
4727 | <h4 class="name" id="setVolume"><span class="type-signature"></span>setVolume<span class="signature">( [volume] [, forceSetVolumeProperty] [, onSetVolume] [, saveForUnmute] [, mediaObject])</span><span class="type-signature"> → {number}</span></h4>
|
4728 |
|
4729 |
|
4730 | </dt>
|
4731 | <dd>
|
4732 |
|
4733 |
|
4734 | <div class="description">
|
4735 | <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>
|
4736 | </div>
|
4737 |
|
4738 |
|
4739 |
|
4740 |
|
4741 |
|
4742 |
|
4743 |
|
4744 |
|
4745 | <h5>Parameters:</h5>
|
4746 |
|
4747 |
|
4748 | <table class="params table table-striped">
|
4749 | <thead>
|
4750 | <tr>
|
4751 |
|
4752 | <th style="width:12%; min-width:110px;">Name</th>
|
4753 |
|
4754 |
|
4755 | <th style="width:12%; min-width:110px;">Type</th>
|
4756 |
|
4757 |
|
4758 | <th style="width:12%; min-width:110px;">Argument</th>
|
4759 |
|
4760 |
|
4761 |
|
4762 | <th style="width:12%; min-width:110px;">Default</th>
|
4763 |
|
4764 |
|
4765 | <th class="last" style="min-width:310px;">Description</th>
|
4766 | </tr>
|
4767 | </thead>
|
4768 |
|
4769 | <tbody>
|
4770 |
|
4771 |
|
4772 | <tr>
|
4773 |
|
4774 | <td class="name" style="width:12%; min-width:110px; 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>
|
4775 |
|
4776 |
|
4777 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4778 |
|
4779 |
|
4780 | <span class="param-type">number</span>
|
4781 |
|
4782 |
|
4783 |
|
4784 |
|
4785 | </td>
|
4786 |
|
4787 |
|
4788 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4789 |
|
4790 | <optional><br>
|
4791 |
|
4792 |
|
4793 |
|
4794 |
|
4795 |
|
4796 | </td>
|
4797 |
|
4798 |
|
4799 |
|
4800 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4801 |
|
4802 | <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>
|
4803 |
|
4804 | </td>
|
4805 |
|
4806 |
|
4807 | <td class="description last" style="min-width:310px; 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>
|
4808 | </tr>
|
4809 |
|
4810 |
|
4811 |
|
4812 | <tr>
|
4813 |
|
4814 | <td class="name" style="width:12%; min-width:110px; 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>
|
4815 |
|
4816 |
|
4817 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4818 |
|
4819 |
|
4820 | <span class="param-type">boolean</span>
|
4821 |
|
4822 |
|
4823 |
|
4824 |
|
4825 | </td>
|
4826 |
|
4827 |
|
4828 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4829 |
|
4830 | <optional><br>
|
4831 |
|
4832 |
|
4833 |
|
4834 |
|
4835 |
|
4836 | </td>
|
4837 |
|
4838 |
|
4839 |
|
4840 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4841 |
|
4842 | false
|
4843 |
|
4844 | </td>
|
4845 |
|
4846 |
|
4847 | <td class="description last" style="min-width:310px; 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.ACMP.html#volume"><code>CB_AudioFile_API.ACMP#volume</code></a> property even when the volume failed to be changed.</p></td>
|
4848 | </tr>
|
4849 |
|
4850 |
|
4851 |
|
4852 | <tr>
|
4853 |
|
4854 | <td class="name" style="width:12%; min-width:110px; 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>
|
4855 |
|
4856 |
|
4857 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4858 |
|
4859 |
|
4860 | <span class="param-type">function</span>
|
4861 |
|
4862 |
|
4863 |
|
4864 |
|
4865 | </td>
|
4866 |
|
4867 |
|
4868 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4869 |
|
4870 | <optional><br>
|
4871 |
|
4872 |
|
4873 |
|
4874 |
|
4875 |
|
4876 | </td>
|
4877 |
|
4878 |
|
4879 |
|
4880 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4881 |
|
4882 | </td>
|
4883 |
|
4884 |
|
4885 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object.</p></td>
|
4886 | </tr>
|
4887 |
|
4888 |
|
4889 |
|
4890 | <tr>
|
4891 |
|
4892 | <td class="name" style="width:12%; min-width:110px; 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>
|
4893 |
|
4894 |
|
4895 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4896 |
|
4897 |
|
4898 | <span class="param-type">boolean</span>
|
4899 |
|
4900 |
|
4901 |
|
4902 |
|
4903 | </td>
|
4904 |
|
4905 |
|
4906 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4907 |
|
4908 | <optional><br>
|
4909 |
|
4910 |
|
4911 |
|
4912 |
|
4913 |
|
4914 | </td>
|
4915 |
|
4916 |
|
4917 |
|
4918 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4919 |
|
4920 | false
|
4921 |
|
4922 | </td>
|
4923 |
|
4924 |
|
4925 | <td class="description last" style="min-width:310px; 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.ACMP.html#unmute"><code>CB_AudioFile_API.ACMP#unmute</code></a> method. Internal usage only recommended.</p></td>
|
4926 | </tr>
|
4927 |
|
4928 |
|
4929 |
|
4930 | <tr>
|
4931 |
|
4932 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>mediaObject</code></td>
|
4933 |
|
4934 |
|
4935 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4936 |
|
4937 |
|
4938 | <span class="param-type">Object</span>
|
4939 |
|
4940 |
|
4941 |
|
4942 |
|
4943 | </td>
|
4944 |
|
4945 |
|
4946 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4947 |
|
4948 | <optional><br>
|
4949 |
|
4950 |
|
4951 |
|
4952 |
|
4953 |
|
4954 | </td>
|
4955 |
|
4956 |
|
4957 |
|
4958 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
4959 |
|
4960 | <a href="CB_AudioFile_API.ACMP.html#mediaObject"><code>CB_AudioFile_API.ACMP#mediaObject</code></a>
|
4961 |
|
4962 | </td>
|
4963 |
|
4964 |
|
4965 | <td class="description last" style="min-width:310px; 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://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media/">Media</a> object whose volume we want to set. Used internally to affect either normal or swap <a href="https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media/">Media</a> object (a swap object is stored internally as it is necessary due ACMP issues when looping a sprite near the end of the audio file). Internal usage only recommended.</p></td>
|
4966 | </tr>
|
4967 |
|
4968 |
|
4969 | </tbody>
|
4970 | </table>
|
4971 |
|
4972 |
|
4973 |
|
4974 |
|
4975 | <dl class="details">
|
4976 |
|
4977 |
|
4978 |
|
4979 |
|
4980 |
|
4981 |
|
4982 |
|
4983 |
|
4984 |
|
4985 |
|
4986 |
|
4987 |
|
4988 |
|
4989 |
|
4990 |
|
4991 |
|
4992 |
|
4993 |
|
4994 |
|
4995 |
|
4996 |
|
4997 |
|
4998 |
|
4999 |
|
5000 |
|
5001 |
|
5002 |
|
5003 |
|
5004 |
|
5005 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5006 | <dd class="tag-source">
|
5007 | <ul class="dummy">
|
5008 | <li>
|
5009 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
5010 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-985">line 985</a>
|
5011 | </li>
|
5012 | </ul>
|
5013 | </dd>
|
5014 |
|
5015 |
|
5016 |
|
5017 |
|
5018 |
|
5019 |
|
5020 |
|
5021 | </dl>
|
5022 |
|
5023 |
|
5024 |
|
5025 |
|
5026 |
|
5027 |
|
5028 |
|
5029 |
|
5030 |
|
5031 |
|
5032 |
|
5033 |
|
5034 |
|
5035 | <h5>Returns:</h5>
|
5036 |
|
5037 |
|
5038 | <div class="param-desc">
|
5039 | <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>
|
5040 | </div>
|
5041 |
|
5042 |
|
5043 |
|
5044 | <dl>
|
5045 | <dt>
|
5046 | Type
|
5047 | </dt>
|
5048 | <dd>
|
5049 |
|
5050 | <span class="param-type">number</span>
|
5051 |
|
5052 |
|
5053 |
|
5054 | </dd>
|
5055 | </dl>
|
5056 |
|
5057 |
|
5058 |
|
5059 |
|
5060 |
|
5061 | </dd>
|
5062 |
|
5063 |
|
5064 |
|
5065 | <hr>
|
5066 | <dt>
|
5067 | <h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">( [keepStoppedUnaltered] [, avoidOnStop] [, forceOnStop])</span><span class="type-signature"> → {boolean}</span></h4>
|
5068 |
|
5069 |
|
5070 | </dt>
|
5071 | <dd>
|
5072 |
|
5073 |
|
5074 | <div class="description">
|
5075 | <p>Stops the audio.</p>
|
5076 | </div>
|
5077 |
|
5078 |
|
5079 |
|
5080 |
|
5081 |
|
5082 |
|
5083 |
|
5084 |
|
5085 | <h5>Parameters:</h5>
|
5086 |
|
5087 |
|
5088 | <table class="params table table-striped">
|
5089 | <thead>
|
5090 | <tr>
|
5091 |
|
5092 | <th style="width:12%; min-width:110px;">Name</th>
|
5093 |
|
5094 |
|
5095 | <th style="width:12%; min-width:110px;">Type</th>
|
5096 |
|
5097 |
|
5098 | <th style="width:12%; min-width:110px;">Argument</th>
|
5099 |
|
5100 |
|
5101 |
|
5102 | <th style="width:12%; min-width:110px;">Default</th>
|
5103 |
|
5104 |
|
5105 | <th class="last" style="min-width:310px;">Description</th>
|
5106 | </tr>
|
5107 | </thead>
|
5108 |
|
5109 | <tbody>
|
5110 |
|
5111 |
|
5112 | <tr>
|
5113 |
|
5114 | <td class="name" style="width:12%; min-width:110px; 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>
|
5115 |
|
5116 |
|
5117 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5118 |
|
5119 |
|
5120 | <span class="param-type">boolean</span>
|
5121 |
|
5122 |
|
5123 |
|
5124 |
|
5125 | </td>
|
5126 |
|
5127 |
|
5128 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5129 |
|
5130 | <optional><br>
|
5131 |
|
5132 |
|
5133 |
|
5134 |
|
5135 |
|
5136 | </td>
|
5137 |
|
5138 |
|
5139 |
|
5140 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5141 |
|
5142 | false
|
5143 |
|
5144 | </td>
|
5145 |
|
5146 |
|
5147 | <td class="description last" style="min-width:310px; 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.ACMP.html#stopped"><code>CB_AudioFile_API.ACMP#stopped</code></a> property will not be set to true and it will remain with its current value.</p></td>
|
5148 | </tr>
|
5149 |
|
5150 |
|
5151 |
|
5152 | <tr>
|
5153 |
|
5154 | <td class="name" style="width:12%; min-width:110px; 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>
|
5155 |
|
5156 |
|
5157 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5158 |
|
5159 |
|
5160 | <span class="param-type">boolean</span>
|
5161 |
|
5162 |
|
5163 |
|
5164 |
|
5165 | </td>
|
5166 |
|
5167 |
|
5168 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5169 |
|
5170 | <optional><br>
|
5171 |
|
5172 |
|
5173 |
|
5174 |
|
5175 |
|
5176 | </td>
|
5177 |
|
5178 |
|
5179 |
|
5180 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5181 |
|
5182 | false
|
5183 |
|
5184 | </td>
|
5185 |
|
5186 |
|
5187 | <td class="description last" style="min-width:310px; 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 "onStop" function defined (through the <a href="CB_AudioFile_API.ACMP.html#onStop"><code>CB_AudioFile_API.ACMP#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 "forceOnStop" parameter is set to true or if the "keepStoppedUnaltered" parameter is set to false and the audio was not already stopped before. If set to true, the "onStop" function (if any) will not be called at all.</p></td>
|
5188 | </tr>
|
5189 |
|
5190 |
|
5191 |
|
5192 | <tr>
|
5193 |
|
5194 | <td class="name" style="width:12%; min-width:110px; 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>
|
5195 |
|
5196 |
|
5197 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5198 |
|
5199 |
|
5200 | <span class="param-type">boolean</span>
|
5201 |
|
5202 |
|
5203 |
|
5204 |
|
5205 | </td>
|
5206 |
|
5207 |
|
5208 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5209 |
|
5210 | <optional><br>
|
5211 |
|
5212 |
|
5213 |
|
5214 |
|
5215 |
|
5216 | </td>
|
5217 |
|
5218 |
|
5219 |
|
5220 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5221 |
|
5222 | false
|
5223 |
|
5224 | </td>
|
5225 |
|
5226 |
|
5227 | <td class="description last" style="min-width:310px; 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 "avoidOnStop" parameter is set to false and there is an "onStop" function defined (through the <a href="CB_AudioFile_API.ACMP.html#onStop"><code>CB_AudioFile_API.ACMP#onStop</code></a> method), it will be called regardless the audio was stopped before or not. If set to false, the "onStop" function (if any) will only be called if the "keepStoppedUnaltered" parameter is set to false and the audio was not already stopped before. This parameter will be ignored if the "avoidOnStop" parameter is set to true.</p></td>
|
5228 | </tr>
|
5229 |
|
5230 |
|
5231 | </tbody>
|
5232 | </table>
|
5233 |
|
5234 |
|
5235 |
|
5236 |
|
5237 | <dl class="details">
|
5238 |
|
5239 |
|
5240 |
|
5241 |
|
5242 |
|
5243 |
|
5244 |
|
5245 |
|
5246 |
|
5247 |
|
5248 |
|
5249 |
|
5250 |
|
5251 |
|
5252 |
|
5253 |
|
5254 |
|
5255 |
|
5256 |
|
5257 |
|
5258 |
|
5259 |
|
5260 |
|
5261 |
|
5262 |
|
5263 |
|
5264 |
|
5265 |
|
5266 |
|
5267 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5268 | <dd class="tag-source">
|
5269 | <ul class="dummy">
|
5270 | <li>
|
5271 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
5272 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-959">line 959</a>
|
5273 | </li>
|
5274 | </ul>
|
5275 | </dd>
|
5276 |
|
5277 |
|
5278 |
|
5279 |
|
5280 |
|
5281 |
|
5282 |
|
5283 | </dl>
|
5284 |
|
5285 |
|
5286 |
|
5287 |
|
5288 |
|
5289 |
|
5290 |
|
5291 |
|
5292 |
|
5293 |
|
5294 |
|
5295 |
|
5296 |
|
5297 | <h5>Returns:</h5>
|
5298 |
|
5299 |
|
5300 | <div class="param-desc">
|
5301 | <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>
|
5302 | </div>
|
5303 |
|
5304 |
|
5305 |
|
5306 | <dl>
|
5307 | <dt>
|
5308 | Type
|
5309 | </dt>
|
5310 | <dd>
|
5311 |
|
5312 | <span class="param-type">boolean</span>
|
5313 |
|
5314 |
|
5315 |
|
5316 | </dd>
|
5317 | </dl>
|
5318 |
|
5319 |
|
5320 |
|
5321 |
|
5322 |
|
5323 | </dd>
|
5324 |
|
5325 |
|
5326 |
|
5327 | <hr>
|
5328 | <dt>
|
5329 | <h4 class="name" id="unmute"><span class="type-signature"></span>unmute<span class="signature">( [onUnmute])</span><span class="type-signature"> → {number}</span></h4>
|
5330 |
|
5331 |
|
5332 | </dt>
|
5333 | <dd>
|
5334 |
|
5335 |
|
5336 | <div class="description">
|
5337 | <p>Restores audio after muting it (unmutes it).</p>
|
5338 | </div>
|
5339 |
|
5340 |
|
5341 |
|
5342 |
|
5343 |
|
5344 |
|
5345 |
|
5346 |
|
5347 | <h5>Parameters:</h5>
|
5348 |
|
5349 |
|
5350 | <table class="params table table-striped">
|
5351 | <thead>
|
5352 | <tr>
|
5353 |
|
5354 | <th style="width:12%; min-width:110px;">Name</th>
|
5355 |
|
5356 |
|
5357 | <th style="width:12%; min-width:110px;">Type</th>
|
5358 |
|
5359 |
|
5360 | <th style="width:12%; min-width:110px;">Argument</th>
|
5361 |
|
5362 |
|
5363 |
|
5364 |
|
5365 | <th class="last" style="min-width:310px;">Description</th>
|
5366 | </tr>
|
5367 | </thead>
|
5368 |
|
5369 | <tbody>
|
5370 |
|
5371 |
|
5372 | <tr>
|
5373 |
|
5374 | <td class="name" style="width:12%; min-width:110px; 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>
|
5375 |
|
5376 |
|
5377 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5378 |
|
5379 |
|
5380 | <span class="param-type">function</span>
|
5381 |
|
5382 |
|
5383 |
|
5384 |
|
5385 | </td>
|
5386 |
|
5387 |
|
5388 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
5389 |
|
5390 | <optional><br>
|
5391 |
|
5392 |
|
5393 |
|
5394 |
|
5395 |
|
5396 | </td>
|
5397 |
|
5398 |
|
5399 |
|
5400 |
|
5401 | <td class="description last" style="min-width:310px; 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 "this" the <a href="CB_AudioFile_API.ACMP.html"><code>CB_AudioFile_API.ACMP</code></a> object.</p></td>
|
5402 | </tr>
|
5403 |
|
5404 |
|
5405 | </tbody>
|
5406 | </table>
|
5407 |
|
5408 |
|
5409 |
|
5410 |
|
5411 | <dl class="details">
|
5412 |
|
5413 |
|
5414 |
|
5415 |
|
5416 |
|
5417 |
|
5418 |
|
5419 |
|
5420 |
|
5421 |
|
5422 |
|
5423 |
|
5424 |
|
5425 |
|
5426 |
|
5427 |
|
5428 |
|
5429 |
|
5430 |
|
5431 |
|
5432 |
|
5433 |
|
5434 |
|
5435 |
|
5436 |
|
5437 |
|
5438 |
|
5439 |
|
5440 |
|
5441 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5442 | <dd class="tag-source">
|
5443 | <ul class="dummy">
|
5444 | <li>
|
5445 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
5446 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-1048">line 1048</a>
|
5447 | </li>
|
5448 | </ul>
|
5449 | </dd>
|
5450 |
|
5451 |
|
5452 |
|
5453 |
|
5454 |
|
5455 |
|
5456 |
|
5457 | </dl>
|
5458 |
|
5459 |
|
5460 |
|
5461 |
|
5462 |
|
5463 |
|
5464 |
|
5465 |
|
5466 |
|
5467 |
|
5468 |
|
5469 |
|
5470 |
|
5471 | <h5>Returns:</h5>
|
5472 |
|
5473 |
|
5474 | <div class="param-desc">
|
5475 | <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>
|
5476 | </div>
|
5477 |
|
5478 |
|
5479 |
|
5480 | <dl>
|
5481 | <dt>
|
5482 | Type
|
5483 | </dt>
|
5484 | <dd>
|
5485 |
|
5486 | <span class="param-type">number</span>
|
5487 |
|
5488 |
|
5489 |
|
5490 | </dd>
|
5491 | </dl>
|
5492 |
|
5493 |
|
5494 |
|
5495 |
|
5496 |
|
5497 | </dd>
|
5498 |
|
5499 | </dl>
|
5500 |
|
5501 |
|
5502 |
|
5503 | <h3 class="subsection-title">Type Definitions</h3>
|
5504 |
|
5505 | <dl>
|
5506 |
|
5507 | <hr>
|
5508 | <dt class="name" id=".OPTIONS">
|
5509 | <h4 id=".OPTIONS">OPTIONS</h4>
|
5510 |
|
5511 |
|
5512 | </dt>
|
5513 | <dd>
|
5514 |
|
5515 | <div class="description">
|
5516 | <p>Object with the options for an audio file. The format is the following one: { autoLoad: boolean, autoPlay: boolean, loop: boolean, volume: number }.</p>
|
5517 | </div>
|
5518 |
|
5519 |
|
5520 |
|
5521 | <h5>Type:</h5>
|
5522 | <ul>
|
5523 | <li>
|
5524 |
|
5525 | <span class="param-type">Object</span>
|
5526 |
|
5527 |
|
5528 |
|
5529 | </li>
|
5530 | </ul>
|
5531 |
|
5532 |
|
5533 |
|
5534 | <dl class="details">
|
5535 |
|
5536 |
|
5537 | <h5 class="subsection-title">Properties:</h5>
|
5538 |
|
5539 | <dl>
|
5540 |
|
5541 | <table class="props table table-striped">
|
5542 | <thead>
|
5543 | <tr>
|
5544 |
|
5545 | <th>Name</th>
|
5546 |
|
5547 |
|
5548 | <th>Type</th>
|
5549 |
|
5550 |
|
5551 | <th>Argument</th>
|
5552 |
|
5553 |
|
5554 |
|
5555 | <th>Default</th>
|
5556 |
|
5557 |
|
5558 | <th class="last">Description</th>
|
5559 | </tr>
|
5560 | </thead>
|
5561 |
|
5562 | <tbody>
|
5563 |
|
5564 |
|
5565 | <tr>
|
5566 |
|
5567 | <td class="name"><code>autoLoad</code></td>
|
5568 |
|
5569 |
|
5570 | <td class="type">
|
5571 |
|
5572 |
|
5573 | <span class="param-type">boolean</span>
|
5574 |
|
5575 |
|
5576 |
|
5577 |
|
5578 | </td>
|
5579 |
|
5580 |
|
5581 | <td class="attributes">
|
5582 |
|
5583 | <optional><br>
|
5584 |
|
5585 |
|
5586 |
|
5587 | </td>
|
5588 |
|
5589 |
|
5590 |
|
5591 | <td class="default">
|
5592 |
|
5593 | <a href="CB_AudioFile_API.ACMP.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.ACMP#DEFAULT_OPTIONS</code></a>.autoLoad
|
5594 |
|
5595 | </td>
|
5596 |
|
5597 |
|
5598 | <td class="description last"><p>If set to false, it will not call the <a href="CB_AudioFile_API.ACMP.html#load"><code>CB_AudioFile_API.ACMP#load</code></a> method internally when the constructor is called (not recommended).</p></td>
|
5599 | </tr>
|
5600 |
|
5601 |
|
5602 |
|
5603 | <tr>
|
5604 |
|
5605 | <td class="name"><code>autoPlay</code></td>
|
5606 |
|
5607 |
|
5608 | <td class="type">
|
5609 |
|
5610 |
|
5611 | <span class="param-type">boolean</span>
|
5612 |
|
5613 |
|
5614 |
|
5615 |
|
5616 | </td>
|
5617 |
|
5618 |
|
5619 | <td class="attributes">
|
5620 |
|
5621 | <optional><br>
|
5622 |
|
5623 |
|
5624 |
|
5625 | </td>
|
5626 |
|
5627 |
|
5628 |
|
5629 | <td class="default">
|
5630 |
|
5631 | <a href="CB_AudioFile_API.ACMP.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.ACMP#DEFAULT_OPTIONS</code></a>.autoPlay
|
5632 |
|
5633 | </td>
|
5634 |
|
5635 |
|
5636 | <td class="description last"><p>Value which will be used as the "autoPlay" parameter when calling the <a href="CB_AudioFile_API.ACMP.html#load"><code>CB_AudioFile_API.ACMP#load</code></a> method internally, only when the "autoLoad" is set to true (when the constructor is called).</p></td>
|
5637 | </tr>
|
5638 |
|
5639 |
|
5640 |
|
5641 | <tr>
|
5642 |
|
5643 | <td class="name"><code>loop</code></td>
|
5644 |
|
5645 |
|
5646 | <td class="type">
|
5647 |
|
5648 |
|
5649 | <span class="param-type">boolean</span>
|
5650 |
|
5651 |
|
5652 |
|
5653 |
|
5654 | </td>
|
5655 |
|
5656 |
|
5657 | <td class="attributes">
|
5658 |
|
5659 | <optional><br>
|
5660 |
|
5661 |
|
5662 |
|
5663 | </td>
|
5664 |
|
5665 |
|
5666 |
|
5667 | <td class="default">
|
5668 |
|
5669 | <a href="CB_AudioFile_API.ACMP.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.ACMP#DEFAULT_OPTIONS</code></a>.loop
|
5670 |
|
5671 | </td>
|
5672 |
|
5673 |
|
5674 | <td class="description last"><p>Value that will be used for the <a href="CB_AudioFile_API.ACMP.html#loop"><code>CB_AudioFile_API.ACMP#loop</code></a> property.</p></td>
|
5675 | </tr>
|
5676 |
|
5677 |
|
5678 |
|
5679 | <tr>
|
5680 |
|
5681 | <td class="name"><code>volume</code></td>
|
5682 |
|
5683 |
|
5684 | <td class="type">
|
5685 |
|
5686 |
|
5687 | <span class="param-type">number</span>
|
5688 |
|
5689 |
|
5690 |
|
5691 |
|
5692 | </td>
|
5693 |
|
5694 |
|
5695 | <td class="attributes">
|
5696 |
|
5697 | <optional><br>
|
5698 |
|
5699 |
|
5700 |
|
5701 | </td>
|
5702 |
|
5703 |
|
5704 |
|
5705 | <td class="default">
|
5706 |
|
5707 | <a href="CB_AudioFile_API.ACMP.html#DEFAULT_OPTIONS"><code>CB_AudioFile_API.ACMP#DEFAULT_OPTIONS</code></a>.volume
|
5708 |
|
5709 | </td>
|
5710 |
|
5711 |
|
5712 | <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.ACMP.html#volume"><code>CB_AudioFile_API.ACMP#volume</code></a> property.</p></td>
|
5713 | </tr>
|
5714 |
|
5715 |
|
5716 | </tbody>
|
5717 | </table>
|
5718 | </dl>
|
5719 |
|
5720 |
|
5721 |
|
5722 |
|
5723 |
|
5724 |
|
5725 |
|
5726 |
|
5727 |
|
5728 |
|
5729 |
|
5730 |
|
5731 |
|
5732 |
|
5733 |
|
5734 |
|
5735 |
|
5736 |
|
5737 |
|
5738 |
|
5739 |
|
5740 |
|
5741 |
|
5742 |
|
5743 |
|
5744 |
|
5745 |
|
5746 |
|
5747 |
|
5748 |
|
5749 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5750 | <dd class="tag-source">
|
5751 | <ul class="dummy">
|
5752 | <li>
|
5753 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html">CrossBase/audiovisual/audio/CB_AudioFile_API_ACMP.js</a>,
|
5754 | <a href="CrossBase_audiovisual_audio_CB_AudioFile_API_ACMP.js.html#sunlight-1-line-194">line 194</a>
|
5755 | </li>
|
5756 | </ul>
|
5757 | </dd>
|
5758 |
|
5759 |
|
5760 |
|
5761 |
|
5762 |
|
5763 |
|
5764 |
|
5765 | </dl>
|
5766 |
|
5767 |
|
5768 |
|
5769 | </dd>
|
5770 |
|
5771 | </dl>
|
5772 |
|
5773 |
|
5774 |
|
5775 | </article>
|
5776 |
|
5777 | </section>
|
5778 |
|
5779 |
|
5780 |
|
5781 |
|
5782 | </div>
|
5783 | </div>
|
5784 |
|
5785 | <div class="clearfix"></div>
|
5786 |
|
5787 |
|
5788 | <div class="col-md-3">
|
5789 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
5790 | </div>
|
5791 |
|
5792 |
|
5793 | </div>
|
5794 | </div>
|
5795 |
|
5796 |
|
5797 | <div class="modal fade" id="searchResults">
|
5798 | <div class="modal-dialog">
|
5799 | <div class="modal-content">
|
5800 | <div class="modal-header">
|
5801 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
5802 | <h4 class="modal-title">Search results</h4>
|
5803 | </div>
|
5804 | <div class="modal-body"></div>
|
5805 | <div class="modal-footer">
|
5806 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
5807 | </div>
|
5808 | </div>
|
5809 | </div>
|
5810 | </div>
|
5811 |
|
5812 |
|
5813 | <footer>
|
5814 |
|
5815 |
|
5816 | <span class="copyright">
|
5817 | <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>
|
5818 | </span>
|
5819 |
|
5820 | <span class="jsdoc-message">
|
5821 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
5822 |
|
5823 | on Mon Feb 3rd 2020
|
5824 |
|
5825 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
5826 | </span>
|
5827 | </footer>
|
5828 |
|
5829 | <script src="scripts/docstrap.lib.js"></script>
|
5830 | <script src="scripts/toc.js"></script>
|
5831 |
|
5832 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
5833 |
|
5834 |
|
5835 | <script>
|
5836 | $( function () {
|
5837 | $( "[id*='$']" ).each( function () {
|
5838 | var $this = $( this );
|
5839 |
|
5840 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
5841 | } );
|
5842 |
|
5843 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
5844 | var $this = $( this );
|
5845 |
|
5846 | var example = $this.find( "code" );
|
5847 | exampleText = example.html();
|
5848 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
5849 | if ( lang && lang[1] ) {
|
5850 | exampleText = exampleText.replace( lang[0], "" );
|
5851 | example.html( exampleText );
|
5852 | lang = lang[1];
|
5853 | } else {
|
5854 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
5855 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
5856 | }
|
5857 |
|
5858 | if ( lang ) {
|
5859 |
|
5860 | $this
|
5861 | .addClass( "sunlight-highlight-" + lang )
|
5862 | .addClass( "linenums" )
|
5863 | .html( example.html() );
|
5864 |
|
5865 | }
|
5866 | } );
|
5867 |
|
5868 | Sunlight.highlightAll( {
|
5869 | lineNumbers : true,
|
5870 | showMenu : true,
|
5871 | enableDoclinks : true
|
5872 | } );
|
5873 |
|
5874 | $.catchAnchorLinks( {
|
5875 | navbarOffset: 10
|
5876 | } );
|
5877 | $( "#toc" ).toc( {
|
5878 | anchorName : function ( i, heading, prefix ) {
|
5879 | return $( heading ).attr( "id" ) || ( prefix + i );
|
5880 | },
|
5881 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
5882 | showAndHide : false,
|
5883 | smoothScrolling: true
|
5884 | } );
|
5885 |
|
5886 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
5887 | $( '.dropdown-toggle' ).dropdown();
|
5888 |
|
5889 | $( "table" ).each( function () {
|
5890 | var $this = $( this );
|
5891 | $this.addClass('table');
|
5892 | } );
|
5893 |
|
5894 | } );
|
5895 | </script>
|
5896 |
|
5897 |
|
5898 |
|
5899 |
|
5900 |
|
5901 | <script>
|
5902 | $( function () {
|
5903 | $( '#main' ).localScroll( {
|
5904 | offset : { top : 60 }
|
5905 | } );
|
5906 | $( "dt.name" ).each( function () {
|
5907 | var $this = $( this ).find("h4");
|
5908 | var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
|
5909 | var dt = $(this);
|
5910 | var children = dt.next( "dd" );
|
5911 |
|
5912 | dt.prepend( icon ).css( {cursor : "pointer"} );
|
5913 | dt.addClass( "member-collapsed" ).addClass( "member" );
|
5914 |
|
5915 |
|
5916 | children.hide();
|
5917 |
|
5918 | dt.children().on( "click", function () {
|
5919 | children = dt.next( "dd" );
|
5920 | children.slideToggle( "fast", function () {
|
5921 |
|
5922 | if ( children.is( ":visible" ) ) {
|
5923 | icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
|
5924 | dt.addClass( "member-open" ).animate( "member-collapsed" );
|
5925 | } else {
|
5926 | icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
|
5927 | dt.addClass( "member-collapsed" ).removeClass( "member-open" );
|
5928 | }
|
5929 | } );
|
5930 | } );
|
5931 |
|
5932 | } );
|
5933 | } );
|
5934 | </script>
|
5935 |
|
5936 |
|
5937 |
|
5938 |
|
5939 |
|
5940 |
|
5941 | <script type="text/javascript">
|
5942 | $(document).ready(function() {
|
5943 | SearcherDisplay.init();
|
5944 | });
|
5945 | </script>
|
5946 |
|
5947 |
|
5948 | </body>
|
5949 | </html> |
\ | No newline at end of file |