Property that contains an object with the options for the main script.
- Source:
Members
-
<static, constant> BANDJS_LOAD :boolean
-
Defines whether to load or not Band.js.
Type:
- boolean
- Default Value:
-
- typeof(window.AudioContext) !== "undefined" || typeof(window.webkitAudioContext) !== "undefined"
- Source:
-
<static, constant> BANDJS_PATH :string
-
Directory that contains the Band.js files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/audio/band.js/"
- Source:
-
<static, constant> BANDJS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.BANDJS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> BANDJS_PATH_SCRIPT_FILE :string
-
The script file path for Band.js.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.BANDJS_PATH
+ "band.min.js"
- Source:
-
<static, constant> CANBOX_LOAD :boolean
-
Defines whether to load or not Canbox.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> CANBOX_PATH :string
-
Directory that contains the Canbox files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/image/canvas/canbox/"
- Source:
-
<static, constant> CANBOX_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.CANBOX_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> CANBOX_PATH_SCRIPT_FILE :string
-
The script file path for Canbox.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.CANBOX_PATH
+ "canbox.0.2.1.js"
- Source:
-
<static, constant> CANVAS_TEXT_LOAD :boolean
-
Defines whether to load or not canvas-text.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> CANVAS_TEXT_PATH :string
-
Directory that contains the canvas-text files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/image/canvas/excanvas_with_canvas_text/"
- Source:
-
<static, constant> CANVAS_TEXT_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.CANVAS_TEXT_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> CANVAS_TEXT_PATH_SCRIPT_FILE :string
-
The script file path for canvas-text.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.CANVAS_TEXT_PATH
+ "canvas.text.js"
- Source:
-
<static, constant> CB_AudioDetector_allowEmulation_DEFAULT :boolean
-
Value by default when the "allowEmulation" parameter is not provided in the
CB_AudioDetector.getPreferredAPI
, theCB_AudioDetector.getSupportedAPIs
or theCB_AudioDetector.isAPISupported
function.Type:
- boolean
- Source:
-
<static, constant> CB_AudioFileCache_PREFERRED_AUDIO_APIS :array
-
Array with the default preferred audio APIs by order of preference. Used by
CB_AudioFileCache
andCB_AudioDetector
.
Possible audio APIs are "WAAPI" (HTML5 Web Audio API), "SM2" (SoundManager 2), "ACMP" (Apache Cordova Media Plugin) or "AAPI" (HTML5 Audio API).
Note: since Internet Explorer 9 works better with SM2 than with AAPI, if it is detected then the default value will be: [ "WAAPI", "SM2", "ACMP", "AAPI" ]Type:
- array
- Default Value:
-
- ["WAAPI", "AAPI", "ACMP", "SM2"]
- Source:
-
<static, constant> CB_AudioFileCache_PREFERRED_AUDIO_FORMATS :array
-
Array with the default preferred audio formats by order of preference. Used by
CB_AudioFileCache
andCB_AudioDetector
.
NOTE: some web clients do not support to specify codecs so it is better to also provide strings without codecs.Type:
- array
- Default Value:
-
- ["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"]
- Source:
-
<static, constant> CB_AudioFile_AAPI_USE_TIMEOUT_TO_DETECT_STOPAT :boolean
-
Tells whether CB_AudioFile["AAPI"] uses setTimeout (instead of timeupdate event) to detect when the given "stopAt" is reached.
Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> CB_AudioFile_AUTOPLAY_SILENTLY_ON_LOAD_MS :integer
-
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
CB_AudioFile
.Type:
- integer
- Default Value:
-
- 500
- Source:
-
<static, constant> CB_AudioFile_AudioFileCache_ALLOWED_RECURSIVE_DELAY_DEFAULT :integer
-
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).
Used byCB_AudioFile_API.WAAPI
,CB_AudioFile_API.AAPI
,CB_AudioFile_API.SM2
,CB_AudioFile_API.ACMP
andCB_AudioFileCache
.Type:
- integer
- Default Value:
-
- 150
- Source:
-
<static, constant> CB_AudioFile_AudioFileCache_MUTE_ON_LOAD_AND_CHECKING :boolean
-
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.
Used byCB_AudioFile
,CB_AudioFile_API.WAAPI
,CB_AudioFile_API.AAPI
,CB_AudioFile_API.SM2
,CB_AudioFile_API.ACMP
andCB_AudioFileCache
.Type:
- boolean
- Default Value:
-
- !(navigator.userAgent.indexOf("PlayBook") !== -1 && navigator.userAgent.indexOf("Tablet OS") !== -1)
- Source:
-
<static, constant> CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_DEFAULT :boolean
-
Defines whether to use
CB_Speaker._volume
as default volume. Used byCB_AudioFile
,CB_AudioFile_API.WAAPI
,CB_AudioFile_API.AAPI
,CB_AudioFile_API.SM2
,CB_AudioFile_API.ACMP
andCB_AudioFileCache
.Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM :boolean
-
Defines whether to use
CB_Speaker._volume
as maximum volume. Used byCB_AudioFile
,CB_AudioFile_API.WAAPI
,CB_AudioFile_API.AAPI
,CB_AudioFile_API.SM2
andCB_AudioFile_API.ACMP
.Type:
- boolean
- Source:
-
<static, constant> CB_AudioFile_ONLOAD_TIMEOUT_MS :integer
-
Milliseconds to wait before declaring a sound as failed if it cannot be loaded before. Used by
CB_AudioFile_API.SM2
.Type:
- integer
- Default Value:
-
- 15000
- Source:
-
<static, constant> CB_Canvas_PREFERRED_EMULATION_METHODS :array
-
Array with the default desired canvas emulation methods by order of preference. Used by
CB_Canvas
.Type:
- array
- Default Value:
-
- ["FLASH","VML","DHTML","SILVERLIGHT"]
- Source:
-
<static, constant> CB_Client_PHPAcceptedLanguagesFirst_DEFAULT :boolean
-
Tells whether the
CB_Client.getLanguage
andCB_Client.getLanguages
functions will use the accepted languages detected by PHP (if any) as the first option by default or not.Type:
- boolean
- Default Value:
-
- true
- Source:
-
Default value for the "allowNavigatorLanguages" parameter for
CB_Client.getLanguage
andCB_Client.getLanguages
functions.Type:
- boolean
- Source:
-
<static, constant> CB_Client_language_DEFAULT :string
-
Default language to use for
CB_Client
when no language can be detected (very strange case!).Type:
- string
- Default Value:
-
- en
- Source:
-
<static, constant> CB_Controllers_avoidProprietary_DEFAULT :boolean
-
Default value for the "avoidProprietary" proprietary when calling different functions of the
CB_Controllers
static class, as theCB_Controllers.getButtonsDown
, theCB_Controllers.isButtonDown
and theCB_Controllers.getGamePads
functions, etc.Type:
- boolean
- Source:
-
<static, constant> CB_Device_getTime_HIGH_PRECISION :string
-
Defines whether to use high precision in the CB_Device.getTime (returning 'window.performance.timing.navigationStart + window.performance.now()', where 'window.performance.now' could be polyfilled) or not (returning 'Date.now()', where 'Date.now' could be polyfilled).
Type:
- string
- Default Value:
-
- true
- Source:
-
<static, constant> CB_Elements_classes_USE_CACHE :boolean
-
Defines whether to use cache for the function
CB_Elements.classes
by default.Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> CB_Elements_id_USE_CACHE :boolean
-
Defines whether to use cache for the function
CB_Elements.id
by default.Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> CB_Elements_tag_USE_CACHE :boolean
-
Defines whether to use cache for the
CB_Elements.tag
function by default.Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> CB_Keyboard_extended_PS4_allowDuplicateKeyAliases :boolean
-
Defines whether to allow Sony Playstation 4 codes set in the
CB_Keyboard.extended.PS4CB_Keyboard.extended.PS4
object to be defined in the key aliases even if they use codes which belong to other keys. Used byCB_Keyboard
.Type:
- boolean
- Source:
-
<static, constant> CB_Keyboard_extended_SAMSUNG_TV_allowDuplicateKeyAliases :boolean
-
Defines whether to allow Samsung TV key codes (from the remote control) set in the
CB_Keyboard.extended.SAMSUNG_TV
object to be defined in the key aliases even if they use codes which belong to other keys. Used byCB_Keyboard
.Type:
- boolean
- Source:
-
<static, constant> CB_Keyboard_extended_VK_allowDuplicateKeyAliases :boolean
-
Defines whether to allow Smart TV codes (from the remote control) and virtual key codes set in the
CB_Keyboard.extended.VK
object to be defined in the key aliases even if they use codes which belong to other keys. Used byCB_Keyboard
.Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> CB_Keyboard_extended_WII_allowDuplicateKeyAliases :boolean
-
Defines whether to allow Nintendo Wii codes (from the Wiimote) set in the
CB_Keyboard.extended.WII
object to be defined in the key aliases even if they use codes which belong to other keys. Used byCB_Keyboard
.Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> CB_Net_Sockets_PREVENT_FIREFOX_ESC_BUG :boolean
-
Defines whether we want to prevent the Firefox bug that affects SockJS library (see https://github.com/sockjs/sockjs-client/issues/18) or not. Used by
CB_Keyboard
.Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> CB_Net_XHR_PROXY_URL :string
-
URL for the proxy to prevent cross-domain issues through AJAX, used by
CB_Net.XHR.callProxy
function. Can be relative to the main script folder or not, depending onCB_Configuration.CrossBase.CB_Net_XHR_PROXY_URL_RELATIVE
.
NOTE: Edit the "CB_proxy.config.php" file to configure the default proxy. Apart from configuring it, adding some security measures is highly recommended.
Have in mind that, for safety reasons, the default proxy only allows to request the URLs defined in the "$allowedURLs" array in the "CB_proxy.config.php" file. Just edit it to allow other URLs.Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "net/proxy/CB_proxy.php"
- Source:
-
<static, constant> CB_Net_XHR_PROXY_URL_RELATIVE :boolean
-
Defines whether the URL for the proxy (defined in
CB_Configuration.CrossBase.CB_Net_XHR_PROXY_URL
) is relative to the main script folder or not. If it is relative, the "onCall" event of the CrossBase module will append the value of the "scriptPathGiven" parameter at the beginning.Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> CB_Screen_isFullScreen_ALLOWED_HEIGHT_MARGIN_PERCENTAGE :float
-
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
CB_Screen.isFullScreen
function.Type:
- float
- Default Value:
-
- 3.5
- Source:
-
<static, constant> CB_Screen_isFullScreen_ALLOWED_WIDTH_MARGIN_PERCENTAGE :float
-
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
CB_Screen.isFullScreen
function.Type:
- float
- Default Value:
-
- 3.9
- Source:
-
<static, constant> CB_Speaker_DEFAULT_VOLUME :integer
-
Default volume for CB_Speaker (from 0 to 100).
Type:
- integer
- Default Value:
-
- 100
- Source:
-
<static, constant> CORDOVAJS_LOAD :boolean
-
Defines whether to try to load or not cordova.js (used by Apache Cordova). It should not be loaded together with phonegap.js, normally.
If set to true, the checker defined atCB_Configuration.CrossBase.CORDOVAJS_LOAD_CHECKER
will finally decide whether to load it or not.Type:
- boolean
- Default Value:
- Source:
-
<static, constant> CORDOVAJS_LOAD_CHECKER :CB_Modules.neededFile_LOAD_CHECKER
-
Callback checker to determine whether cordova.js (used by Apache Cordova) is needed or not. Requires
CB_Configuration.CrossBase.CORDOVAJS_LOAD
set to true.Type:
- Default Value:
-
- function(currentPath, info) { return (typeof(window.cordova) === "undefined"); }
- Source:
-
<static, constant> CORDOVAJS_PATH :string
-
Directory that contains the "cordova.js" file (used by Apache Cordova).
Type:
- string
- Source:
-
<static, constant> CORDOVAJS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.CORDOVAJS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> CORDOVAJS_PATH_SCRIPT_FILE :string
-
The script file path for the cordova.js file (used by Apache Cordova).
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.CORDOVAJS_PATH
+ "cordova.js"
- Source:
-
<static, constant> EXCANVAS_LOAD :boolean
-
Defines whether to load or not ExplorerCanvas.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> EXCANVAS_PATH :string
-
Directory that contains the ExplorerCanvas files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/image/canvas/excanvas_with_canvas_text/"
- Source:
-
<static, constant> EXCANVAS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.EXCANVAS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> EXCANVAS_PATH_SCRIPT_FILE :string
-
The script file path for ExplorerCanvas.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.EXCANVAS_PATH
+ "excanvas.js"
- Source:
-
<static, constant> EXTEND_DOM :boolean
-
Defines whether to allow to extend the DOM if needed or not. If set to true and some methods (as for example Array.indexOf, Array.lastIndexOf, Array.isArray, Array.forEach, NodeList.forEach, HTMLCollection.forEach, etc.) are not supported natively, they will be added.
Type:
- boolean
- Source:
-
<static, constant> FLASHCANVAS_ALLOW_RUN_LOCALLY_DEFAULT :boolean
-
Defines whether to allow to run FlashCanvas locally or not (because the ".swf" file folder needs to be added to 'trusted files' in Flash global configuration to work locally in some operating systems).
Type:
- boolean
- Source:
-
<static, constant> FLASHCANVAS_DISABLE_CONTEXT_MENU :boolean
-
Disables the context menu when the right mouse button is clicked on any canvas using FlashCanvas' SWF. Belongs to the "disableContextMenu" parameter of the library set on the "window.FlashCanvasOptions" object. More information: https://web.archive.org/web/20180604011002/http://flashcanvas.net/docs/config
Type:
- boolean
- Source:
-
<static, constant> FLASHCANVAS_IMAGE_CACHE_SIZE :integer
-
Maximum size for the image cache used by FlashCanvas. Belongs to the "imageCacheSize" parameter of the library set on the "window.FlashCanvasOptions" object. More information: https://web.archive.org/web/20180604011002/http://flashcanvas.net/docs/config
Type:
- integer
- Source:
-
<static, constant> FLASHCANVAS_LOAD :boolean
-
Defines whether to load or not FlashCanvas.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> FLASHCANVAS_PATH :string
-
Directory that contains the FlashCanvas files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/image/canvas/FlashCanvas/pro/"
- Source:
-
<static, constant> FLASHCANVAS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.FLASHCANVAS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> FLASHCANVAS_PATH_SCRIPT_FILE :string
-
The script file path for FlashCanvas.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.FLASHCANVAS_PATH
+ "bin/flashcanvas.js"
- Source:
-
<static, constant> FLASHCANVAS_PATH_SWF :string
-
Directory that contains the SWF's for FlashCanvas. The value of the "scriptPathGiven" parameter will be attached at the beginning automatically. Belongs to the "swfPath" parameter of the library set on the "window.FlashCanvasOptions" object. More information: https://web.archive.org/web/20180604011002/http://flashcanvas.net/docs/config
Type:
- string
- Default Value:
- Source:
-
<static, constant> FLASHCANVAS_TURBO_MODE :boolean
-
Uses turbo mode to speed up FlashCanvas. Belongs to the "turbo" parameter of the library set on the "window.FlashCanvasOptions" object. More information: https://web.archive.org/web/20180604011002/http://flashcanvas.net/docs/config
Type:
- boolean
- Source:
-
<static, constant> GAMEPAD_PLUS_LOAD :boolean
-
Defines whether to load or not gamepad-plus.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> GAMEPAD_PLUS_PATH :string
-
Directory that contains the gamepad-plus files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "input/controllers/gamepad-plus/"
- Source:
-
<static, constant> GAMEPAD_PLUS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.GAMEPAD_PLUS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> GAMEPAD_PLUS_PATH_SCRIPT_FILE :string
-
The script file path for gamepad-plus.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.GAMEPAD_PLUS_PATH
+ "gamepads.js"
- Source:
-
<static, constant> HAMMERJS_HAMMER_TIME_PATH_SCRIPT_FILE :string
-
The script file path for Hammer Time.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.HAMMERJS_PATH
+ "hammer-time/hammer-time.min.js"
- Source:
-
<static, constant> HAMMERJS_LOAD :boolean
-
Defines whether to load or not Hammer.js and Hammer Time.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> HAMMERJS_PATH :string
-
Directory that contains the Hammer.js and Hammer Time files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "input/hammer.js/"
- Source:
-
<static, constant> HAMMERJS_PATH_ABSOLUTE :boolean
-
Defines whether the paths defined in
CB_Configuration.CrossBase.HAMMERJS_PATH_SCRIPT_FILE
andCB_Configuration.CrossBase.HAMMERJS_HAMMER_TIME_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> HAMMERJS_PATH_SCRIPT_FILE :string
-
The script file path for Hammer.js.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.HAMMERJS_PATH
+ "hammer.min.js"
- Source:
-
<static, constant> INTELXDKJS_LOAD :boolean
-
Defines whether to load or not intelxdk.js (used by Intel XDK).
Type:
- boolean
- Source:
-
<static, constant> INTELXDKJS_PATH :string
-
Directory that contains the "intelxdk.js" file (used by Intel XDK).
Type:
- string
- Source:
-
<static, constant> INTELXDKJS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.INTELXDKJS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> INTELXDKJS_PATH_SCRIPT_FILE :string
-
The script file path for intelxdk.js (used by Intel XDK).
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.INTELXDKJS_PATH
+ "intelxdk.js"
- Source:
-
<static, constant> INTELXDK_INITDEVJS_LOAD :boolean
-
Defines whether to try to load or not init-dev.js (used by Intel XDK).
If set to true, the checker defined atCB_Configuration.CrossBase.INTELXDK_INITDEVJS_LOAD_CHECKER
will finally decide whether to load it or not.Type:
- boolean
- Source:
-
<static, constant> INTELXDK_INITDEVJS_LOAD_CHECKER :CB_Modules.neededFile_LOAD_CHECKER
-
Callback checker to determine whether init-dev.js (used by Intel XDK) is needed or not. Requires
CB_Configuration.CrossBase.INTELXDK_INITDEVJS_LOAD
set to true.Type:
- Default Value:
-
- false
- Source:
-
<static, constant> INTELXDK_INITDEVJS_PATH :string
-
Directory that contains the "init-dev.js" (used by Intel XDK).
Type:
- string
- Source:
-
<static, constant> INTELXDK_INITDEVJS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.INTELXDK_INITDEVJS_PATH
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> INTELXDK_INITDEVJS_PATH_SCRIPT_FILE :string
-
The script file path for init-dev.js file (used by Intel XDK).
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.INTELXDK_INITDEVJS_PATH
+ "init-dev.js"
- Source:
-
<static, constant> JSFX_LOAD :boolean
-
Defines whether to load or not jsfx.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> JSFX_PATH :string
-
Directory that contains the jsfx files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/audio/jsfx/"
- Source:
-
<static, constant> JSFX_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.JSFX_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> JSFX_PATH_SCRIPT_FILE :string
-
The script file path for jsfx.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.JSFX_PATH
+ "jsfx.js"
- Source:
-
<static, constant> LOCALSTORAGE_POLYFILL_LOAD :boolean
-
Defines whether to load or not localStorage polyfill.
Type:
- boolean
- Source:
-
<static, constant> LOCALSTORAGE_POLYFILL_PATH :string
-
Directory that contains the localStorage polyfill files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "general/localStorage/"
- Source:
-
<static, constant> LOCALSTORAGE_POLYFILL_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.LOCALSTORAGE_POLYFILL_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> LOCALSTORAGE_POLYFILL_PATH_SCRIPT_FILE :string
-
The script file path for localStorage polyfill.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.LOCALSTORAGE_POLYFILL_PATH
+ "localStorage.min.js?swfURL=" + CB_Configuration[CB_BASE_NAME].LOCALSTORAGE_POLYFILL_PATH_SWF_FILE
- Source:
-
<static, constant> LOCALSTORAGE_POLYFILL_PATH_SWF :string
-
Directory that contains the SWF for localStorage polyfill. The value of the "scriptPathGiven" parameter will be attached at the beginning automatically. Belongs to the "swfURL" parameter (URL "GET" parameter) of the library when the localStorage script file is attached.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.LOCALSTORAGE_POLYFILL_PATH
+ "localStorage.swf"
- Source:
-
<static, constant> MIND_IFRAMES :boolean
-
Defines whether to have in mind possible iframes that could contain the script or not. Used by some functions of
CB_Client
,CB_Events
, etc.Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> NOSLEEP_LOAD :boolean
-
Defines whether to load or not NoSleep.js.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> NOSLEEP_PATH :string
-
Directory that contains the NoSleep.js files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/image/NoSleep/"
- Source:
-
<static, constant> NOSLEEP_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.NOSLEEP_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> NOSLEEP_PATH_SCRIPT_FILE :string
-
The script file path for NoSleep.js.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.NOSLEEP_PATH
+ "NoSleep.min.js"
- Source:
-
<static, constant> PHONEGAPJS_LOAD :boolean
-
Defines whether to load or not phonegap.js (used by Adobe PhoneGap).
Type:
- boolean
- Source:
-
<static, constant> PHONEGAPJS_PATH :string
-
Directory that contains the "phonegap.js" (used by Adobe PhoneGap) file.
Type:
- string
- Source:
-
<static, constant> PHONEGAPJS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.PHONEGAPJS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> PHONEGAPJS_PATH_SCRIPT_FILE :string
-
The script file path for phonegap.js (used by Adobe PhoneGap).
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.PHONEGAPJS_PATH
+ "phonegap.js"
- Source:
-
<static, constant> PRESSUREJS_LOAD :boolean
-
Defines whether to load or not Pressure.js.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> PRESSUREJS_PATH :string
-
Directory that contains the Pressure.js files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "input/pressure.js/"
- Source:
-
<static, constant> PRESSUREJS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.PRESSUREJS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> PRESSUREJS_PATH_SCRIPT_FILE :string
-
The script file path for Pressure.js.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.PRESSUREJS_PATH
+ "pressure.min.js"
- Source:
-
<static, constant> SCRIPT_PATH :string
-
Path to the CrossBase module, relative to the CrossBrowdy folder.
Type:
- string
- Default Value:
-
CB_BASE_NAME
+ "/"
- Source:
-
<static, constant> SLCANVAS_LOAD :boolean
-
Defines whether to load or not SLCanvas.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> SLCANVAS_PATH :string
-
Directory that contains the SLCanvas files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/image/canvas/slcanvas/"
- Source:
-
<static, constant> SLCANVAS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.SLCANVAS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> SLCANVAS_PATH_SCRIPT_FILE :string
-
The script file path for SLCanvas.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SLCANVAS_PATH
+ "slcanvas.js"
- Source:
-
<static, constant> SM2_AUDIO_FORMATS_REQUIRED :Object
-
Object with the required formats for SoundManager 2. If the format is required and the web client doesn't support it, SoundManager 2 will use Flash. More information: http://www.schillmania.com/projects/soundmanager2/doc/#soundmanager-audioformats
Type:
- Object
- Source:
Properties:
Name Type Default Description mp3
boolean false Defines MP3 format as required.
mp4
boolean false Defines MP4 format as required.
ogg
boolean false Defines OGG format as required.
opus
boolean false Defines OPUS format as required.
wav
boolean false Defines WAV format as required.
-
<static, constant> SM2_LOAD :boolean
-
Defines whether to load or not SoundManager 2.
Type:
- boolean
- Source:
-
<static, constant> SM2_PATH :string
-
Directory that contains the SoundManager 2 files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/audio/soundmanager2/"
- Source:
-
<static, constant> SM2_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.SM2_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> SM2_PATH_SCRIPT_FILE :string
-
The script file path for SoundManager 2.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SM2_PATH
+ "script/soundmanager2-nodebug-jsmin.js"
- Source:
-
<static, constant> SM2_PATH_SWF :string
-
Directory that contains the SWF's for SoundManager 2. The value of the "scriptPathGiven" parameter will be attached at the beginning automatically. Belongs to the "url" parameter of the library when soundManager.setup function is called. More information: http://www.schillmania.com/projects/soundmanager2/doc/#soundmanager-url
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SM2_PATH
+ "swf/"
- Source:
-
<static, constant> SM2_TIMEOUT_MS :integer
-
Milliseconds to wait after loading SoundManager 2 to define it as not supported if there is no response. Belongs to the "flashLoadTimeout" parameter of the library when soundManager.setup function is called. More information: http://www.schillmania.com/projects/soundmanager2/doc/#soundmanager-flashloadtimeout
Type:
- integer
- Source:
-
<static, constant> SM2_USE_HIGH_PERFORMANCE :boolean
-
Defines whether to use or not high performance mode in SoundManager 2 (may cause a flash object to be visible). Belongs to the "useHighPerformance" parameter of the library when soundManager.setup function is called. More information: http://www.schillmania.com/projects/soundmanager2/doc/#soundmanager-highperformance
Type:
- boolean
- Source:
-
<static, constant> SOCKJS_PATH :string
-
Directory that contains the SockJS library files.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "net/sockets/SockJS/"
- Source:
-
<static, constant> SOCKJS_PATH_SCRIPT_FILE :string
-
The script file path for the SockJS library. As the newer SockJS library versions do not work in old Internet Explorer versions (6, 7 or 8), if they are detected it will use the SockJS library 0.3.4 version instead.
Type:
- string
- Default Value:
-
CB_Configuration[CB_BASE_NAME].SOCKJS_PATH
+ 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.
- Source:
-
<static, constant> SUBCOLLIDERJS_LOAD :boolean
-
Defines whether to load or not subcollider.js.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> SUBCOLLIDERJS_PATH :string
-
Directory that contains the subcollider.js script.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.TIMBREJS_PATH
+ "subcollider/"
- Source:
-
<static, constant> SUBCOLLIDERJS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.SUBCOLLIDERJS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> SUBCOLLIDERJS_PATH_SCRIPT_FILE :string
-
The script file path for subcollider.js.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SUBCOLLIDERJS_PATH
+ "subcollider.js"
- Source:
-
<static, constant> TIMBREJS_LOAD :boolean
-
Defines whether to load or not timbre.js.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> TIMBREJS_PATH :string
-
Directory that contains the timbre.js files (script and SWF).
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/audio/timbre.js/"
- Source:
-
<static, constant> TIMBREJS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.TIMBREJS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> TIMBREJS_PATH_SCRIPT_FILE :string
-
The script file path for timbre.js.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.TIMBREJS_PATH
+ "timbre.js"
- Source:
-
<static, constant> WAAPISIM_LOAD :boolean
-
Defines whether to load or not WAAPISim.
Type:
- boolean
- Default Value:
- Source:
-
<static, constant> WAAPISIM_PATH :string
-
Directory that contains the WAAPISim files (script and SWF).
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "audiovisual/audio/WAAPISim/"
- Source:
-
<static, constant> WAAPISIM_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.WAAPISIM_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> WAAPISIM_PATH_SCRIPT_FILE :string
-
The script file path for the WAAPISim script file.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.WAAPISIM_PATH
+ "waapisim.min.js"
- Source:
-
<static, constant> WAAPI_EMULATION_ALLOWED :boolean
-
Defines whether to allow using "WAAPI" (HTML5 Web Audio API) emulation (it will use WAAPISim if needed) or not.
Type:
- boolean
- Default Value:
-
- true
- Source:
-
<static, constant> WII_JS_LOAD :boolean
-
Defines whether to load or not wii-js.
Type:
- boolean
- Source:
-
<static, constant> WII_JS_PATH :string
-
Directory that contains the wii-js script.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.SCRIPT_PATH
+ "input/controllers/wii-js/"
- Source:
-
<static, constant> WII_JS_PATH_ABSOLUTE :boolean
-
Defines whether the path defined in
CB_Configuration.CrossBase.WII_JS_PATH_SCRIPT_FILE
is either absolute or relative to the CrossBrowdy script path.Type:
- boolean
- Source:
-
<static, constant> WII_JS_PATH_SCRIPT_FILE :string
-
The script file path for wii-js.
Type:
- string
- Default Value:
-
CB_Configuration.CrossBase.WII_JS_PATH
+ "wii.min.js"
- Source:
Methods
-
<static> needsCanbox() → {boolean}
-
Detects whether the web client needs Canbox or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsCanvasText() → {boolean}
-
Detects whether the web client needs canvas-text or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsExplorerCanvas() → {boolean}
-
Detects whether the web client needs ExplorerCanvas or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsFlashCanvas() → {boolean}
-
Detects whether the web client needs FlashCanvas or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsGamepadPlus() → {boolean}
-
Detects whether the web client needs gamepad-plus or not.
- Source:
- To Do:
-
- 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.
Returns:
- Type
- boolean
-
<static> needsHammerJS() → {boolean}
-
Detects whether the web client needs Hammer.js or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsJsfx() → {boolean}
-
Detects whether the web client needs jsfx or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsPressureJS() → {boolean}
-
Detects whether the web client needs Pressure.js or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsSLCanvas() → {boolean}
-
Detects whether the web client needs SLCanvas or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsSleepJS() → {boolean}
-
Detects whether the web client needs NoSleep.js or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsTimbreJS() → {boolean}
-
Detects whether the web client needs timbre.js (including subcollider.js) or not.
- Source:
Returns:
- Type
- boolean
-
<static> needsWAAPISim() → {boolean}
-
Detects whether the web client needs WAAPISim or not.
- Source:
Returns:
- Type
- boolean