crossbrowdy
Version:
A Multimedia JavaScript framework to create real cross-platform and hybrid game engines, games, emulators, multimedia libraries and apps.
808 lines (688 loc) • 93.6 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>CrossBrowdy API documentation Source: CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
</head>
<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;">
<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<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>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<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>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<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>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content" style="width:100%;">
<div class="row" style="width:100%;">
<div class="col-md-12">
<div id="main">
<h1 class="page-title">Source: CrossBase/audiovisual/audio/CB_AudioFile_API_WAAPI.js</h1>
<section>
<article>
<pre
class="sunlight-highlight-javascript linenums">/**
* @file Audio files management using "WAAPI" ([HTML5 Web Audio API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API}). Contains the {@link CB_AudioFile_API.WAAPI} class.
* @author Joan Alba Maldonado <workindalian@gmail.com>
* @license Creative Commons Attribution 4.0 International. See more at {@link https://crossbrowdy.com/about#what_is_the_crossbrowdy_copyright_and_license}.
*/
//var CB_AudioFile_WAAPI_filePathsLoading = []; //Stores the file paths which are being loaded.
//var CB_AudioFile_WAAPI_BuffersCache = {}; //Cache of buffers for every file path.
//var CB_AudioFile_WAAPI_BuffersCacheMessage = {}; //Cache of buffers for every file path.
//var CB_AudioFile_WAAPI_CheckedCache = {}; //Cache of results of checkPlaying method for every file path.
//We need a limit to prevent out of memory error when many calls to play() are performed:
var CB_AudioFile_API_WAAPI_beingLoading = 0; //Counts how many objects are loading.
var CB_AudioFile_API_WAAPI_maximumLoading = 3; //Maximum of objects that can be loading at the same time.
var CB_AudioFile_API_WAAPI_beingChecking = 0; //Counts how many objects are loading.
var CB_AudioFile_API_WAAPI_maximumChecking = 75; //Maximum of objects that can be loading at the same time.
//Class to manage an audio file with WAAPI (Web Audio API):
if (typeof(CB_AudioFile_API) === "undefined") { var CB_AudioFile_API = {}; }
/**
* The constructor is recommended to be called through a user-driven event (as onClick, onTouch, etc.) if the "autoPlay" option is set to true, as some web clients may need this at least the first time in order to be able to play the audio.
* @class CB_AudioFile_API.WAAPI
* @memberof! <global>
* @classdesc Class to manage an audio file using "WAAPI" ([HTML5 Web Audio API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API}). Used by the {@link CB_AudioFile} class internally and it shares most of its properties and methods. Recommended for internal usage only. Uses [Base64Binary]{@link https://gist.github.com/htchaan/108b7aa6b71eb03e38019e64450ea095} internally. Some old clients can use this audio API thanks to [AudioContext-MonkeyPatch]{@link https://github.com/cwilso/AudioContext-MonkeyPatch} and [WAAPISim]{@link https://github.com/g200kg/WAAPISim}.
* @param {string} filePath - The path of the audio file or a data URI. NOTE: Only some clients with some audio APIs will support data URIs.
* @param {string} [audioId='CB_AUDIOFILE_WAAPI_' + CB_AudioFile_API.WAAPI._idUnique++] - Desired identifier for the audio object. If not provided, an automatic unique ID will be calculated. Note that it is not case sensitive and it should be unique for each object.
* @param {CB_AudioFile_API.WAAPI.OPTIONS} [options=CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS] - Object with the desired options.
* @param {function} [callbackOk] - Function with no parameters to be called when the audio has been loaded successfully, being "this" the {@link CB_AudioFile_API.WAAPI} object itself.
* @param {function} [callbackError] - Function to be called if the audio has not been loaded successfully. The first and unique parameter will be a string describing the error found (if could be determined), being "this" the {@link CB_AudioFile_API.WAAPI} object itself.
* @returns {CB_AudioFile_API.WAAPI} Returns a new {@link CB_AudioFile_API.WAAPI} object.
* @todo Do not allow to create one object with an "id" which has already been used (unless the value is undefined, null...). Note that the "id" is not case sensitive and it should be unique for each object.
* @todo Method getCopy and static method filterProperties (similar to the ones from {@link CB_GraphicSprites} and {@link CB_GraphicSpritesScene}).
*/
CB_AudioFile_API["WAAPI"] = function(filePath, audioId, options, callbackOk, callbackError)
{
//Creates an instance of this object and returns it in the case that it is being called from an unexpected context:
if (this === window || !(this instanceof CB_AudioFile_API["WAAPI"])) { return new CB_AudioFile_API["WAAPI"](filePath, audioId, options, callbackOk, callbackError); }
//Constants:
/**
* Keeps the default volume. If the {@link CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_DEFAULT} property is true, this will keep the result of calling the {@link CB_Speaker.getVolume} function. Otherwise, it will use the value of the {@link CB_Configuration.CrossBase.CB_Speaker_DEFAULT_VOLUME} variable.
* @constant CB_AudioFile_API.WAAPI#DEFAULT_VOLUME
* @type {number}
* @default CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_DEFAULT ? CB_Speaker.getVolume() : CB_Configuration.CrossBase.CB_Speaker_DEFAULT_VOLUME
*/
CB_AudioFile_API["WAAPI"].prototype.DEFAULT_VOLUME = CB_Configuration[CB_BASE_NAME].CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_DEFAULT ? CB_Speaker.getVolume() : CB_Configuration[CB_BASE_NAME].CB_Speaker_DEFAULT_VOLUME;
/**
* Keeps the default options when an object is created. Format: { autoLoad: boolean, autoPlay: boolean, loop: boolean, volume: number }.
* @constant CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS
* @type {CB_AudioFile_API.WAAPI.OPTIONS}
* @default { autoLoad: true, autoPlay: false, loop: false, volume: [CB_AudioFile_API.WAAPI.prototype.DEFAULT_VOLUME]{@link CB_AudioFile_API.WAAPI#DEFAULT_VOLUME} }
*/
CB_AudioFile_API["WAAPI"].prototype.DEFAULT_OPTIONS = { autoLoad: true, autoPlay: false, loop: false, volume: CB_AudioFile_API["WAAPI"].prototype.DEFAULT_VOLUME, useXHR: true, useCache: true }; //Default options when the file is created.
//Properties and variables:
/**
* Tells whether the file is unloaded ({@link CB_AudioFile.UNLOADED}), loading ({@link CB_AudioFile.LOADING}), unchecked ({@link CB_AudioFile.UNCHECKED}), checking ({@link CB_AudioFile.CHECKING}), loaded ({@link CB_AudioFile.LOADED}), failed ({@link CB_AudioFile.FAILED}) or aborted ({@link CB_AudioFile.ABORTED}).
* @var CB_AudioFile_API.WAAPI#status
* @readonly
* @type {integer}
* @default {@link CB_AudioFile.UNLOADED}
*/
this.status = CB_AudioFile.UNLOADED;
/**
* Defines whether the file loops by default when the audio is played or not. Its value will be modified automatically whenever the {@link CB_AudioFile_API.WAAPI#play} method is called, getting the value from the "loop" parameter (but only if contains a boolean).
* @var CB_AudioFile_API.WAAPI#loop
* @readonly
* @type {boolean}
* @default [CB_AudioFile_API.WAAPI.prototype.DEFAULT_OPTIONS]{@link CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS}.loop
*/
this.loop = CB_AudioFile_API["WAAPI"].prototype.DEFAULT_OPTIONS.loop;
/**
* Stores the volume of this audio. Accepted values go from 0 to MAX_VOLUME, where MAX_VOLUME is 100 if the {@link CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM} property is false or otherwise MAX_VOLUME is the returning value of the {@link CB_Speaker.getVolume} function.
* @var CB_AudioFile_API.WAAPI#volume
* @readonly
* @type {number}
* @default [CB_AudioFile_API.WAAPI.prototype.DEFAULT_OPTIONS]{@link CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS}.volume
*/
this.volume = CB_AudioFile_API["WAAPI"].prototype.DEFAULT_OPTIONS.volume;
/**
* Stores the volume of this audio before it was muted (to restore it later). Valid values go from 0 to MAX_VOLUME, where MAX_VOLUME is 100 if the {@link CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM} property is false or otherwise MAX_VOLUME is the returning value of the {@link CB_Speaker.getVolume} function.
* @var CB_AudioFile_API.WAAPI#volumeBeforeMute
* @readonly
* @type {number}
* @default {@link CB_AudioFile_API.WAAPI#volume}
*/
this.volumeBeforeMute = this.volume;
/**
* Stores the identifier for the audio file.
* @var CB_AudioFile_API.WAAPI#id
* @readonly
* @type {string}
* @default 'CB_AUDIOFILE_WAAPI_' + CB_AudioFile_API.WAAPI._idUnique++
*/
this.id = "";
/**
* Stores the path of the audio file or the data URI. NOTE: Only some clients with some audio APIs will support data URIs.
* @var CB_AudioFile_API.WAAPI#filePath
* @readonly
* @type {string}
* @default
*/
this.filePath = "";
/**
* Tells whether the audio is paused or not.
* @var CB_AudioFile_API.WAAPI#paused
* @readonly
* @type {boolean}
* @default false
*/
this.paused = false;
/**
* Stores the time (in milliseconds) when the audio has been paused.
* @var CB_AudioFile_API.WAAPI#pauseTime
* @readonly
* @type {number}
* @default
*/
this.pauseTime = 0;
/**
* Tells whether the audio is stopped or not.
* @var CB_AudioFile_API.WAAPI#stopped
* @readonly
* @type {boolean}
* @default true
*/
this.stopped = true;
/**
* Function to call when the audio stops.
* @var CB_AudioFile_API.WAAPI#onStopFunction
* @readonly
* @type {function}
* @default
*/
this.onStopFunction = null;
/**
* Stores the last "startAt" parameter value used by the {@link CB_AudioFile_API.WAAPI#play} or the {@link CB_AudioFile_API.WAAPI#resume} method.
* @var CB_AudioFile_API.WAAPI#lastStartAt
* @readonly
* @type {number}
* @default
*/
this.lastStartAt = null;
/**
* Stores the last "stopAt" parameter value used by the {@link CB_AudioFile_API.WAAPI#play} or the {@link CB_AudioFile_API.WAAPI#resume} method.
* @var CB_AudioFile_API.WAAPI#lastStopAt
* @readonly
* @type {number}
* @default
*/
this.lastStopAt = null;
/**
* Stores the "source" ([AudioBufferSourceNode]{@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode} object) of the audio, used by the "WAAPI" ([HTML5 Web Audio API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API}).
* @var CB_AudioFile_API.WAAPI#source
* @readonly
* @type {AudioBufferSourceNode}
* @default
*/
this.source = null;
/**
* Stores the "buffer" ([AudioBuffer]{@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/buffer} object) of the audio, used by the "WAAPI" ([HTML5 Web Audio API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API}).
* @var CB_AudioFile_API.WAAPI#buffer
* @readonly
* @type {AudioBuffer}
* @default
*/
this.buffer = null;
/**
* Stores the "gain node" ([GainNode]{@link https://developer.mozilla.org/en-US/docs/Web/API/GainNode} object created with the [createGain]{@link https://developer.mozilla.org/en-US/docs/Web/API/BaseAudioContext/createGain} method) of the audio, used by the "WAAPI" ([HTML5 Web Audio API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API}).
* @var CB_AudioFile_API.WAAPI#gainNode
* @readonly
* @type {GainNode}
* @default
*/
this.gainNode = null;
/**
* Progress of the loading process (or downloading through [XHR]{@link https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest}) the audio data, used by the "WAAPI" ([HTML5 Web Audio API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API}). Internal usage only recommended (use the {@link CB_AudioFile_API.WAAPI#getProgress} method instead to know the progress).
* @var CB_AudioFile_API.WAAPI#progressDownloading
* @readonly
* @type {number}
* @default 0
*/
this.progressDownloading = 0;
//Internal properties:
this._startTime = 0; //Stores the time when the play starts (used for WAAPI).
this._timeoutWhenStop = null; //Keeps the timeout that is executed when the audio has finished playing (to either stop or loop).
this._id_internal = null; //Internal id.
this._recursiveCallTimeout = null;
this._checkCurrentTimeChangesTimeout = null;
this._callbackFunctionOkTimeout = null;
this._loadingCounterIncreased = false;
this._checkPlayingFinishingTimeout = null;
this._recursiveCallCheckingTimeout = null;
this._checkingCounterIncreased = false;
this._lastDuration = null;
//Calls the constructor of the object when creates an instance:
return this._init(filePath, audioId, options, callbackOk, callbackError);
}
/**
* Object with the options for an audio file. The format is the following one: { autoLoad: boolean, autoPlay: boolean, loop: boolean, volume: number }.
* @memberof CB_AudioFile_API.WAAPI
* @typedef {Object} CB_AudioFile_API.WAAPI.OPTIONS
* @property {boolean} [autoLoad={@link CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS}.autoLoad] - If set to false, it will not call the {@link CB_AudioFile_API.WAAPI#load} method internally when the constructor is called (not recommended).
* @property {boolean} [autoPlay={@link CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS}.autoPlay] - Value which will be used as the "autoPlay" parameter when calling the {@link CB_AudioFile_API.WAAPI#load} method internally, only when the "autoLoad" is set to true (when the constructor is called).
* @property {boolean} [loop={@link CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS}.loop] - Value that will be used for the {@link CB_AudioFile_API.WAAPI#loop} property.
* @property {number} [volume={@link CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS}.volume] - The desired volume (from 0 to the maximum value, where the maximum value will be the returning value of calling the {@link CB_Speaker.getVolume} function if the {@link CB_Configuration.CrossBase.CB_AudioFile_AudioFileCache_USE_SPEAKER_VOLUME_AS_MAXIMUM} property is set to true or it will be 100 otherwise) that will be used for the {@link CB_AudioFile_API.WAAPI#volume} property.
*/
//Static properties:
CB_AudioFile_API["WAAPI"]._counter = 0; //Internal counter.
CB_AudioFile_API["WAAPI"]._idUnique = 0; //Counter to make the id unique.
CB_AudioFile_API["WAAPI"]._cache = [];
CB_AudioFile_API["WAAPI"].audioContext = null;
//Constructor:
CB_AudioFile_API["WAAPI"].prototype._init = function(filePath, audioId, options, callbackOk, callbackError)
{
//If not given, defines the default parameters:
if (typeof(audioId) === "undefined" || audioId === null) { audioId = "CB_AUDIOFILE_WAAPI_" + CB_AudioFile_API["WAAPI"]._idUnique++; } //Uses the file path as default id.
if (typeof(options) === "undefined" || options === null) { options = this.DEFAULT_OPTIONS; }
else
{
if (typeof(options.loop) === "undefined" || options.loop === null) { options.loop = this.DEFAULT_OPTIONS.loop; }
if (typeof(options.autoLoad) === "undefined" || options.autoLoad === null) { options.autoLoad = this.DEFAULT_OPTIONS.autoLoad; }
if (typeof(options.autoPlay) === "undefined" || options.autoPlay === null) { options.autoPlay = this.DEFAULT_OPTIONS.autoPlay; }
if (typeof(options.volume) === "undefined" || options.volume === null) { options.volume = this.DEFAULT_OPTIONS.volume; }
if (typeof(options.useXHR) === "undefined" || options.useXHR === null) { options.useXHR = this.DEFAULT_OPTIONS.useXHR; }
if (typeof(options.useCache) === "undefined" || options.useCache === null) { options.useCache = this.DEFAULT_OPTIONS.useCache; }
}
//Sets the audio ID:
this.id = CB_trim(audioId).toUpperCase();
//Sets the internal id:
if (typeof(this._id_internal) === "undefined" || this._id_internal === null) { this._id_internal = CB_AudioFile_API["WAAPI"]._counter++; }
//Sets the file path:
this.filePath = filePath;
//Proceeds according to the options sent:
this.loop = options.loop;
this.volume = options.volume;
this.volumeBeforeMute = this.volume;
if (options.autoLoad)
{
var that = this;
setTimeout
(
function()
{
that.load(that.filePath, options.autoPlay, callbackOk, callbackError, null, options.useXHR, options.useCache);
},
10
);
}
//Returns the object:
return this;
}
/**
* Destroys the audio file object and frees memory. Sets its current {@link CB_AudioFile_API.WAAPI#status} property to ABORTED ({@link CB_AudioFile.ABORTED} value).
* @function CB_AudioFile_API.WAAPI#destructor
* @param {boolean} [stopSound=false] - If set to true, it will also call the {@link CB_AudioFile_API.WAAPI#stop} method.
* @param {boolean} [keepStoppedUnaltered=false] - Used internally as the "keepStoppedUnaltered" parameter to call the {@link CB_AudioFile_API.WAAPI#stop} method. If the "stopSound" parameter is not set to true, this parameter will be ignored as the "stop" method will not be called.
* @param {boolean} [avoidOnStop=false] - Used internally as the "avoidOnStop" parameter to call the {@link CB_AudioFile_API.WAAPI#stop} method. If the "stopSound" parameter is not set to true, this parameter will be ignored as the "stop" method will not be called.
* @param {boolean} [forceOnStop=false] - Used internally as the "forceOnStop" parameter to call the {@link CB_AudioFile_API.WAAPI#stop} method. If the "stopSound" parameter is not set to true, this parameter will be ignored as the "stop" method will not be called.
*/
CB_AudioFile_API["WAAPI"].prototype.destructor = function(stopSound, keepStoppedUnaltered, avoidOnStop, forceOnStop)
{
this._lastDuration = null;
//if (typeof(this.audioObject) === "undefined" || this.audioObject === null) { this.status = CB_AudioFile.ABORTED; return; }
if (stopSound) { this.stop(keepStoppedUnaltered, avoidOnStop, forceOnStop); }
CB_Elements.remove(this.source);
CB_Elements.remove(this.buffer);
CB_Elements.remove(this.gainNode);
//CB_Elements.remove(this.audioObject);
//if (this.status === CB_AudioFile.LOADING)
if (this._loadingCounterIncreased)
{
this._loadingCounterIncreased = false;
CB_AudioFile_API_WAAPI_beingLoading--; //Decreases the counter of the objects which are loading.
if (CB_AudioFile_API_WAAPI_beingLoading < 0) { CB_AudioFile_API_WAAPI_beingLoading = 0; }
}
if (this._checkingCounterIncreased)
{
this._checkingCounterIncreased = false;
CB_AudioFile_API_WAAPI_beingChecking--; //Decreases the counter of the objects which are checking.
if (CB_AudioFile_API_WAAPI_beingChecking < 0) { CB_AudioFile_API_WAAPI_beingChecking = 0; }
}
this.status = CB_AudioFile.ABORTED;
}
//Returns index of the cache of a given filepath or creates a new slot for it:
CB_AudioFile_API["WAAPI"].prototype._getCacheIndex = function(filePath)
{
var index = -1;
var cacheLength = CB_AudioFile_API["WAAPI"]._cache.length;
for (var x = 0; x < cacheLength; x++)
{
if (CB_AudioFile_API["WAAPI"]._cache[x].filePath === filePath)
{
index = x;
break;
}
}
if (index === -1)
{
index = CB_AudioFile_API["WAAPI"]._cache.length;
CB_AudioFile_API["WAAPI"]._cache[index] = [];
CB_AudioFile_API["WAAPI"]._cache[index].filePath = filePath;
CB_AudioFile_API["WAAPI"]._cache[index].loading = false;
CB_AudioFile_API["WAAPI"]._cache[index].buffer = null;
CB_AudioFile_API["WAAPI"]._cache[index].error = null;
CB_AudioFile_API["WAAPI"]._cache[index].checkResult = null;
}
return index;
}
/**
* Loads the desired audio file with the desired options. Recommended to be called through a user-driven event (as onClick, onTouch, etc.), as some web clients may need this at least the first time in order to be able to play the audio. Uses [Base64Binary]{@link https://gist.github.com/htchaan/108b7aa6b71eb03e38019e64450ea095} internally. This method will be called automatically by the constructor if the "autoLoad" option was set to true in its given "options" parameter.
* When this method is called, if the {@link CB_AudioFile_API.WAAPI#status} property already has the "LOADED" status (defined in the {@link CB_AudioFile.LOADED} constant) and the "forceReload" parameter is not set to true, it will exit calling the given "callbackOk" function (if any) immediately. Otherwise, regardless the status, the status will be set to "LOADING" (defined in the {@link CB_AudioFile.LOADING} constant). After it, it will reach the "UNCHECKED" (defined in the {@link CB_AudioFile.UNCHECKED} constant). If the "autoPlay" parameter is not set to true, this will be the final status (and it will be necessary to call the {@link CB_AudioFile_API.WAAPI#checkPlaying} method after it). After it and only if the "autoPlay" is set to true, as the {@link CB_AudioFile_API.WAAPI#checkPlaying} method will be called internally, it will have the "CHECKING" status (defined in the {@link CB_AudioFile.CHECKING} constant) and finally the "LOADED" status (defined in the {@link CB_AudioFile.LOADED} constant) if all goes well.
* @function CB_AudioFile_API.WAAPI#load
* @param {string} [filePath={@link CB_AudioFile_API.WAAPI#filePath}] - The path of the audio file or a data URI. NOTE: Only some clients with some audio APIs will support data URIs.
* @param {string} [autoPlay=false] - If set to true, it will start playing the audio automatically (by calling the {@link CB_AudioFile_API.WAAPI#play} method internally). If set to true and the {@link CB_AudioFile_API.WAAPI#status} property reaches the "UNCHECKED" status (defined in the {@link CB_AudioFile.UNCHECKED} constant), it will also call internally the {@link CB_AudioFile_API.WAAPI#checkPlaying} method.
* @param {function} [callbackOk] - Function with no parameters to be called when the audio has been loaded successfully, being "this" the {@link CB_AudioFile_API.WAAPI} object itself.
* @param {function} [callbackError] - Function to be called if the audio has not been loaded successfully. The first and unique parameter will be a string describing the error found (if it could be determined), being "this" the {@link CB_AudioFile_API.WAAPI} object itself.
* @param {boolean} [forceReload=false] - If set to false, the "filePath" has not been changed from the previously used and the {@link CB_AudioFile_API.WAAPI#status} property belongs to the "LOADED" status (defined in the {@link CB_AudioFile.LOADED} constant), it will exit the method without loading the audio file again (calling the "callbackOk" function, if any).
* @param {boolean} [useXHR=[CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS]{@link CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS}.useXHR] - Defines whether to use or not [XHR]{@link https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/XMLHttpRequest} ([AJAX]{@link https://en.wikipedia.org/wiki/Ajax_(programming)}) to load the audio file.
* @param {boolean} [useCache=[CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS]{@link CB_AudioFile_API.WAAPI#DEFAULT_OPTIONS}.useCache] - Defines whether to try to use or not a cache for performance purposes. If set to true and the audio file was loaded before, it will try to use the cache (if possible) to accelerate the loading process.
* @returns {CB_AudioFile_API.WAAPI|null} Returns the audio API object (if it was possible to create) or null otherwise.
*/
CB_AudioFile_API["WAAPI"].prototype.load = function(filePath, autoPlay, callbackOk, callbackError, forceReload, useXHR, useCache)
{
clearTimeout(this._checkCurrentTimeChangesTimeout);
clearTimeout(this._callbackFunctionOkTimeout);
clearTimeout(this._recursiveCallTimeout);
clearTimeout(this._checkPlayingFinishingTimeout);
filePath = filePath || this.filePath;
//If the status is LOADED and the file path give is the same as the current one, just exits:
if (!forceReload && this.status === CB_AudioFile.LOADED && this.filePath === filePath)
{
if (typeof(callbackOk) === "function") { callbackOk.call(this); }
return this;
}
this.status = CB_AudioFile.LOADING; //The file is loading.
var that = this;
if (typeof(useCache) === "undefined" || useCache === null) { useCache = this.DEFAULT_OPTIONS.useCache; }
var filePathIndex = this._getCacheIndex(filePath);
//If we do not use cache the maximum of objects loading is reached or we use cache but the file path is loading, calls the function again after some time and exits:
//if (!useCache && CB_AudioFile_API_WAAPI_beingLoading >= CB_AudioFile_API_WAAPI_maximumLoading || useCache && typeof(CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading) !== "undefined" && CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading)
if (autoPlay && !useCache && CB_AudioFile_API_WAAPI_beingLoading >= CB_AudioFile_API_WAAPI_maximumLoading || useCache && typeof(CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading) !== "undefined" && CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading)
{
this._recursiveCallTimeout = setTimeout(function() { that.load(filePath, autoPlay, callbackOk, callbackError, forceReload, useXHR, useCache); }, 100);
return this;
}
//If the buffer for this file path is still not in the cache, other files will have to wait until it loads:
if (typeof(CB_AudioFile_API["WAAPI"]._cache[filePathIndex].buffer) === "undefined" || CB_AudioFile_API["WAAPI"]._cache[filePathIndex].buffer === null)
{
CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading = true; //The file path is loading.
}
if (typeof(useXHR) === "undefined" || useXHR === null) { useXHR = this.DEFAULT_OPTIONS.useXHR; }
//Destroys previous object (if any):
this.destructor(true, false, true); //Also stops the sound (if any) and prevents firing onStop.
this.status = CB_AudioFile.LOADING; //The file is loading.
if (!this._loadingCounterIncreased)
{
this._loadingCounterIncreased = true;
CB_AudioFile_API_WAAPI_beingLoading++; //Increases the counter of the objects which are loading (destructor has decreased 1).
}
this.filePath = filePath;
//Callback wrapper function when an error happens:
var callbackFunctionError =
function(error, failedChecking, avoidRegisteringError)
{
if (that.status === CB_AudioFile.ABORTED) { return; } //If it is has been aborted, we exit.
if (filePath.substring(0, 5).toLowerCase() === "data:") { filePath = filePath.substring(0, 15) + "[...]" + filePath.substring(filePath.length - 2); }
if (typeof(error) === "undefined" || error === null) { error = "Unknown error for " + filePath + " file"; }
else if (typeof(error.status) !== "undefined") { error = "XHR request for " + filePath + " file returned " + error.status; }
else { error = "Error message for " + filePath + " file: " + error; }
//Stores as failed (-1) in the cache (for the next time if any CB_AudioFile_API["WAAPI"] object wants to use cache for the same file path):
if (!failedChecking) //We do not store in the cache as it has failed if it has failed checking (because maybe the file is fine but just failed checking).
{
if (!avoidRegisteringError) { CB_AudioFile_API["WAAPI"]._cache[filePathIndex].error = error; }
CB_AudioFile_API["WAAPI"]._cache[filePathIndex].buffer = -1;
}
if (that._loadingCounterIncreased)
{
that._loadingCounterIncreased = false;
CB_AudioFile_API_WAAPI_beingLoading--; //Decreases the counter of the objects which are loading.
if (CB_AudioFile_API_WAAPI_beingLoading < 0) { CB_AudioFile_API_WAAPI_beingLoading = 0; }
}
CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading = false; //The file path is not loading anymore.
that.status = CB_AudioFile.FAILED; //File failed to load.
autoPlay = false;
//var fileName = filePath;
if (typeof(callbackError) === "function") { callbackError.call(that, error); } //Calls the Error function back.
};
//Callback wrapper function when all goes well:
var callbackFunctionOk =
function()
{
//Function to execute when all is OK:
var allIsFine =
function()
{
if (that.status === CB_AudioFile.ABORTED) { return; } //If it is has been aborted, we exit.
//Stores the buffer in the cache (for the next time if any CB_AudioFile_API["WAAPI"] object wants to use cache for the same file path):
CB_AudioFile_API["WAAPI"]._cache[filePathIndex].buffer = that.buffer;
if (that._loadingCounterIncreased)
{
that._loadingCounterIncreased = false;
CB_AudioFile_API_WAAPI_beingLoading--; //Decreases the counter of the objects which are loading.
if (CB_AudioFile_API_WAAPI_beingLoading < 0) { CB_AudioFile_API_WAAPI_beingLoading = 0; }
}
CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading = false; //The file path is not loading anymore.
if (typeof(callbackOk) === "function") { callbackOk.call(that); } //Calls the OK function back.
//Plays automatically if we want to:
if (autoPlay) { that.play(); }
};
that.status = CB_AudioFile.UNCHECKED; //The file is still unchecked.
//If we want to play automatically, checks if the currentTime changes (some web clients cannot play if the user did not fire an event to call the play function):
if (autoPlay)
{
that.checkPlaying(function() { allIsFine(); }, function(error) { callbackFunctionError(error, true); }, false, false, useCache);
}
else
{
//Starts playing and stops immediately the sound (needed for some web clients, as Edge, to be able to play the sound later from the first attempt):
try
{
that.source = CB_AudioFile_API["WAAPI"].audioContext.createBufferSource();
var source = that.source;
source.buffer = that.buffer;
that.gainNode = CB_AudioFile_API["WAAPI"].audioContext.createGain();
that.source.connect(that.gainNode);
that.gainNode.connect(CB_AudioFile_API["WAAPI"].audioContext.destination);
var previousVolume = that.volume;
if (CB_Configuration[CB_BASE_NAME].CB_AudioFile_AudioFileCache_MUTE_ON_LOAD_AND_CHECKING)
{
that.setVolume(0);
}
source.loop = false;
source.start(0, 0);
that.source.stop(0);
that.setVolume(previousVolume);
} catch(E) {}
//Calls the final function:
allIsFine();
}
}
try
{
//Function that decodes the binary data:
var callbackFunctionDecode =
function(binaryData)
{
that.progressDownloading = 100; //The file must have been downloaded since we want to decode it now.
that.decodeAudioData(binaryData, callbackFunctionOk, callbackFunctionError);
};
if (typeof(window.AudioContext) === "undefined" && typeof(window.webkitAudioContext) === "undefined")
{
callbackFunctionError("Web Audio API not found");
CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading = false; //The file path is not loading.
return null;
}
//Just creates an audio context:
if (typeof(CB_AudioFile_API["WAAPI"].audioContext) === "undefined" || CB_AudioFile_API["WAAPI"].audioContext === null)
{
CB_AudioFile_API["WAAPI"].audioContext = new (window.AudioContext || window.webkitAudioContext)();
//Hack (source: https://stackoverflow.com/questions/56768576/safari-audiocontext-suspended-even-with-onclick-creation/56770254#56770254):
try { CB_AudioFile_API["WAAPI"].audioContext.createGain(); } catch (createGainError) { CB_console("Error creating a GainNode for the AudioContext: " + createGainError); }
try { CB_AudioFile_API["WAAPI"].audioContext.resume(); } catch (audioContextResumeError) { CB_console("Error resuming AudioContext: " + audioContextResumeError); }
if (!CB_AudioFile_API["WAAPI"].audioContext)
{
callbackFunctionError("AudioContext/webkitAudioContext object could not be created! Value returned: " + CB_AudioFile_API["WAAPI"].audioContext);
CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading = false; //The file path is not loading.
return null;
}
}
if (CB_AudioFile_API["WAAPI"].audioContext && CB_AudioFile_API["WAAPI"].audioContext.state === "suspended")
{
CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading = false; //The file path is not loading.
try
{
var readStateHack = CB_AudioFile_API["WAAPI"].audioContext.state; //Hack. Source: https://stackoverflow.com/questions/56768576/safari-audiocontext-suspended-even-with-onclick-creation/56770254#56770254
CB_AudioFile_API["WAAPI"].audioContext.resume();
//CB_AudioFile_API["WAAPI"].audioContext.onstatechange = function()
CB_Events.on
(
CB_AudioFile_API["WAAPI"].audioContext,
"statechange",
function()
{
if (CB_AudioFile_API["WAAPI"].audioContext.state === "running")
{
that.load(filePath, autoPlay, callbackOk, callbackError, forceReload, useXHR, useCache);
}
},
false, //useCapture.
true, //keepOldEventFunction.
true //erasable.
);
} catch (resumeOrOnStateChangeError) { CB_console("Error resuming or managing 'onStateChange' event: " + resumeOrOnStateChangeError); }
return this;
}
//If we want to use the cache and the file has already been loaded before, gets the buffer from the cache:
if (useCache && typeof(CB_AudioFile_API["WAAPI"]._cache[filePathIndex].buffer) !== "undefined" && CB_AudioFile_API["WAAPI"]._cache[filePathIndex].buffer !== null)
{
this.buffer = CB_AudioFile_API["WAAPI"]._cache[filePathIndex].buffer;
this.progressDownloading = 100;
this._callbackFunctionOkTimeout =
setTimeout
(
(this.buffer === -1)
? function() { callbackFunctionError("File path from the cache already failed before. Previous message: " + CB_AudioFile_API["WAAPI"]._cache[filePathIndex].error, false, true); }
: callbackFunctionOk,
10
);
}
//If we have received a data URI (base64), we don't need to use AJAX (XHR):
else if (filePath.substring(0, 5).toLowerCase() === "data:")
{
if (filePath.indexOf(";base64") !== -1)
{
//Note: Base64Binary needs Uint8Array and ArrayBuffer support. But the web client will support it if the Web Audio API is supported.
var base64Data = filePath.substring(filePath.indexOf(",") + 1); //We just need the data.
this.progressDownloading = 100;
var byteArray = Base64Binary.decodeArrayBuffer(base64Data);
callbackFunctionDecode(byteArray);
}
else { callbackFunctionError("Data URI does not contain the ';base64' string"); }
}
//...otherwise, we use AJAX (XHR) to load the file given:
else if (useXHR)
{
//When the file is loaded, calls the function to set it as ready and load the buffer too:
var XHR = CB_Net.XHR.callBinary(filePath, null, null, "arraybuffer", null, function(XHR) { callbackFunctionDecode(XHR.response); }, callbackFunctionError, [200, 206]); //Allows partial content (206 XHR status).
this.progressDownloading = 0;
XHR.onprogress =
function updateProgress (event)
{
if (event.lengthComputable)
{
that.progressDownloading = event.loaded / event.total * 100;
}
};
}
//...otherwise, we use WAAPI from an Audio object:
else
{
this.progressDownloading = 0;
//Function that processes the Audio element:
var processAudioElement =
function()
{
if (typeof(audioFileObject) !== "undefined" && typeof(audioFileObject.audioObject) !== "undefined" && audioFileObject.audioObject !== null)
{
try
{
var source = CB_AudioFile_API["WAAPI"].audioContext.createMediaElementSource(audioFileObject.audioObject);
var gainNode = CB_AudioFile_API["WAAPI"].audioContext.createGain();
/////source.connect(gainNode);
/////gainNode.connect(CB_AudioFile_API["WAAPI"].audioContext.destination);
analyser = CB_AudioFile_API["WAAPI"].audioContext.createAnalyser();
source.connect(analyser);
analyser.connect(CB_AudioFile_API["WAAPI"].audioContext.destination);
//source.start(0, 0);
callbackFunctionOk(); //Calls the OK function back.
}
catch (error) { callbackFunctionError(error); }
}
else { callbackFunctionError("Audio element is undefined or null"); }
};
//Creates an Audio object with AAPI:
var audioFileObject = new CB_AudioFile_API["AAPI"](filePath, "CB_media_" + this.id, { autoLoad: true, autoPlay: false, loop: false }, processAudioElement, callbackFunctionError);
}
}
catch(E)
{
callbackFunctionError(E);
CB_AudioFile_API["WAAPI"]._cache[filePathIndex].loading = false; //The file path is not loading.
return null;
}
//Plays automatically if we want to:
//if (autoPlay) { this.play(); }
//if (autoPlay) { setTimeout(function() { that.play(); }, 5000); }
return this;
}
/**
* Decodes binary audio data given. Internal usage only recommended.
* @function CB_AudioFile_API.WAAPI#decodeAudioData
* @param {ArrayBuffer} binaryData - [ArrayBuffer]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer} with the audio data to be decoded.
* @param {function} [callbackOk] - Function with no parameters to be called when the audio data has been decoded successfully, being "this" the {@link CB_AudioFile_API.WAAPI} object itself.
* @param {function} [callbackError] - Function to be called if the audio data has not been decoded successfully. The first and unique parameter will be a string describing the error found (if it could be determined), being "this" the {@link CB_AudioFile_API.WAAPI} object itself.
* @returns {undefined|Promise} Returns the returning value of calling the [BaseAudioContext.decodeAudioData]{@link https://developer.mozilla.org/en-US/docs/Web/API/BaseAudioContext/decodeAudioData} function, which returns void (undefined) or a [Promise]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise} (whose methods "then" and "catch" will have already been used internally by this function).
*/
CB_AudioFile_API["WAAPI"].prototype.decodeAudioData = function(binaryData, callbackOk, callbackError)
{
var that = this;
var callbackCalled = false;
var callbackDecodedOk =
function(buffer)
{
if (callbackCalled) { return; }
callbackCalled = true;
//In case of error:
//if (typeof(buffer) === "undefined" || buffer === null || !buffer)
if (!buffer)
{
if (typeof(callbackError) === "function")
{
callbackError.call(that, "Buffer is not defined or null or empty");
}
}
//...otherwise, the sound has been loaded correctly:
else
{
that.buffer = buffer; //Stores the buffer in this object.
if (typeof(callbackOk) === "function") { callbackOk.call(that); } //Calls the OK function back.
}
};
var callbackDecodedError =
function(error) //In case of error:
{
if (callbackCalled) { return; }
callbackCalled = true;
if (typeof(callbackError) === "function") { callbackError.call(that, error); }
};
var returningValue = CB_AudioFile_API["WAAPI"].audioContext.decodeAudioData(binaryData, callbackDecodedOk, callbackDecodedError);
if (typeof(returningValue) !== "undefined" && returningValue !== null && typeof(returningValue.then) === "function")
{
returningValue.then(callbackDecodedOk)["catch"](callbackDecodedError);
}
return returningValue;
}
/**
* Checks whether the audio can be played or not. Recommended to be called through a user-driven event (as onClick, onTouch, etc.), as some web clients may need this at least the first time in order to be able to play the audio. Also recommended to use before calling the {@link CB_AudioFile_API.WAAPI#play} method the first time. The checking action will only be performed if the value of the {@link CB_AudioFile_API.WAAPI#status} property belongs to the {@link CB_AudioFile.UNCHECKED} or to the {@link CB_AudioFile.CHECKING} value. After checking, if the audio can be played, the {@link CB_AudioFile_API.WAAPI#status} of the object will get the value of {@link CB_Audi