UNPKG

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