MMIR Framework

Interface: IAudio

IAudio

The Audio abstraction that is returned by mmir.MediaManager#getURLAsAudio.

NOTE: when an audio object is not used anymore, its release method should be called.

Methods

protected_constructor(url, onPlayedCallback, failureCallBack, onLoadedCallBack)

tools/interfaces.js, line 24
The constructor.

NOTE that audio objects are created with a factory, e.g. via mmir.MediaManager#getURLAsAudio.

Name Type Description
url String the URL for the audio file
onPlayedCallback function optional OPTIONAL callback that is triggered when audio did play and has ended
failureCallBack function optional OPTIONAL callback that is triggered when an error occurs (usually during initialization)
NOTE: this argument is positional (i.e. onPlayedCallback must be specified, but may be null)
onLoadedCallBack function optional OPTIONAL callback that is triggered when audio has been initialized and is ready to be played NOTE: this argument is positional (i.e. onPlayedCallback and failureCallBack must be specified, but may be null)
See:
Example
var audio = mmir.MediaManager.getURLAsAudio(url, null, null, function onReady(){
 	audio.play();
 });

protecteddisable()

tools/interfaces.js, line 89
Disable audio (should only be used internally).

protectedenable()

tools/interfaces.js, line 80
Enable audio (should only be used internally).

getDuration(){Number}

tools/interfaces.js, line 126
Get the duration of the audio file
Returns:
Type Description
Number the duration in MS (or -1 if unknown)

isEnabled(){Boolean}

tools/interfaces.js, line 151
Check if audio is currently enabled
Returns:
Type Description
Boolean true if enabled

isPaused(){Boolean}

tools/interfaces.js, line 137
Check if audio is currently paused.

NOTE: the state "paused" is a different status than state "stopped".

Returns:
Type Description
Boolean true if paused, false otherwise

play(){Boolean}

tools/interfaces.js, line 55
Play audio.
Returns:
Type Description
Boolean true, if playing was started immediately. If false, the Audio object may have been disabled, or is still preparing (in which case it is auto-started, when preparing completes)

release()

tools/interfaces.js, line 98
Release audio: should be called when the audio file is not used any more.

NOTE some environments - such as Android - have limited resources available. Not releasing resources may result in not being able to instantiate new (audio) resources.

setVolume(value)

tools/interfaces.js, line 113
Set the volume of this audio file
Name Type Description
value Number the new value for the volume: a number between [0.0, 1.0]

stop(){Boolean}

tools/interfaces.js, line 69
Stop playing audio.
Returns:
Type Description
Boolean true, if stopping was successful.