CordovaAudioPlugin Class
Play sounds using Cordova Media plugin, which will work with a Cordova app and tools that utilize Cordova such as PhoneGap or Ionic. This plugin is not used by default, and must be registered manually in Sound using the registerPlugins method. This plugin is recommended when building a Cordova based app, but is not required.
NOTE the Cordova Media plugin is required
cordova plugin add org.apache.cordova.mediaKnown Issues
Audio Position- Audio position is calculated asynchronusly by Media. The SoundJS solution to this problem is two-fold:
- Provide getCurrentPosition that maps directly to media.getCurrentPosition.
- Provide a best guess position based on elapsed time since playback started, which is synchronized with actual position when the audio is paused or stopped. Testing showed this to be fairly reliable within 200ms.
- See the Cordova Media Docs for various known OS issues.
Constructor
CordovaAudioPlugin
()
Item Index
Methods
Properties
- _audioSources
- _capabilities static
- _volume
- buildDate static
- playWhenScreenLocked static
- version static
Methods
_generateCapabilities
()
private
static
Determine the capabilities of the plugin. Used internally. Please see the Sound API capabilities method for an overview of plugin capabilities.
_handlePreloadComplete
-
event
Handles internal preload completion.
Parameters:
-
eventObject
_updateVolume
()
protected
Set the gain value for master audio. Should not be called externally.
create
-
src -
startTime -
duration
Create a sound instance. If the sound has not been preloaded, it is internally preloaded here.
Parameters:
Returns:
A sound instance for playback and control.
getSrcDuration
-
src
Get the duration for a src. Intended for internal use by CordovaAudioSoundInstance.
Parameters:
-
srcObject
Returns:
The duration of the src or null if it does not exist
getVolume
()
Number
Get the master volume of the plugin, which affects all SoundInstances.
Returns:
The volume level, between 0 and 1.
isPreloadComplete
-
src
Checks if preloading has finished for a specific source.
Parameters:
-
srcStringThe sound URI to load.
Returns:
isPreloadStarted
-
src
Checks if preloading has started for a specific source. If the source is found, we can assume it is loading, or has already finished loading.
Parameters:
-
srcStringThe sound URI to check.
Returns:
isSupported
()
Boolean
static
Determine if the plugin can be used in the current browser/OS. Note that HTML audio is available in most modern browsers, but is disabled in iOS because of its limitations.
Returns:
If the plugin can be initialized.
preload
-
loader
Internally preload a sound.
Parameters:
-
loaderLoaderThe sound URI to load.
register
-
loadItem
Pre-register a sound for preloading and setup. This is called by Sound.
Note all plugins provide a Loader instance, which PreloadJS
can use to assist with preloading.
Parameters:
-
loadItemStringAn Object containing the source of the audio Note that not every plugin will manage this value.
Returns:
A result object, containing a "tag" for preloading purposes.
removeAllSounds
-
src
Remove all sounds added using WebAudioPlugin/register. Note this does not cancel a preload.
Parameters:
-
srcStringThe sound URI to unload.
removeSound
-
src
Remove a sound added using WebAudioPlugin/register. Note this does not cancel a preload.
Parameters:
-
srcStringThe sound URI to unload.
Properties
_audioSources
Object
protected
Object hash indexed by the source URI of each file to indicate if an audio source has begun loading, is currently loading, or has completed loading. Can be used to store non boolean data after loading is complete (for example arrayBuffers for web audio).
_capabilities
Object
private
static
The capabilities of the plugin. This is generated via the _generateCapabilities method. Please see the Sound capabilities method for an overview of all of the available properties.
playWhenScreenLocked
Boolean
static
Sets a default playAudioWhenScreenIsLocked property for play calls on iOS devices. Individual SoundInstances can alter the default with CordovaAudioSoundInstance/playWhenScreenLocked.