Module flower.audio

Flower Extentions Library for Audio.

This allows the change of the flexible implementation.

Info:

  • Release: V3.0.0
  • Author: Makoto

Functions

init (soundMgr) Initializes the module.
play (sound, volume, looping) Play the sound.
pause (sound) Pause the sound.
stop (sound) Stop the sound.
setVolume (volume) Set the system level volume.
getVolume (volume) Return the system level volume.
getSoundMgr () Return SoundMgr a singleton.

Fields

soundMgr SoundMgr

Classes

BaseSoundMgr BaseSoundMgr Class.
UntzSoundMgr UntzSoundMgr Class.
MockSoundMgr MockSoundMgr Class.


Functions

init (soundMgr)
Initializes the module.

Parameters:

  • soundMgr (option) soundMgr object.
play (sound, volume, looping)
Play the sound.

Parameters:

  • sound file path or object.
  • volume (Optional)volume. Default value is 1.
  • looping (Optional)looping flag. Default value is 'false'.

Returns:

    Sound object
pause (sound)
Pause the sound.

Parameters:

  • sound file path or object.
stop (sound)
Stop the sound.

Parameters:

  • sound file path or object.
setVolume (volume)
Set the system level volume.

Parameters:

  • volume volume(0 <= volume <= 1)
getVolume (volume)
Return the system level volume.

Parameters:

  • volume

Returns:

    volume
getSoundMgr ()
Return SoundMgr a singleton.

Returns:

    soundMgr

Fields

soundMgr
SoundMgr

Classes

BaseSoundMgr
BaseSoundMgr Class.

see also:

UntzSoundMgr
UntzSoundMgr Class.

see also:

MockSoundMgr
MockSoundMgr Class.

see also:

generated by LDoc 1.3