Class: AudioCordovaImpl

Methods

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.