Offers a very simple interface to play background music & sound effects. More...
Public Member Functions | |
virtual void | preloadBackgroundMusic (const char *filePath) |
Preload background music. More... | |
local | preloadMusic ( local filePath) |
Preload background music. More... | |
virtual void | playBackgroundMusic (const char *filePath, bool loop=false) |
Play background music. More... | |
local | playMusic ( local filePath, local false) |
Play background music. More... | |
virtual void | stopBackgroundMusic (bool releaseData=false) |
Stop playing background music. More... | |
virtual void | pauseBackgroundMusic () |
Pause playing background music. | |
virtual void | resumeBackgroundMusic () |
Resume playing background music. | |
var | resumeMusic () |
Resume playing background music. | |
local | resumeMusic () |
Resume playing background music. | |
virtual void | rewindBackgroundMusic () |
Rewind playing background music. | |
local | rewindMusic () |
Rewind playing background music. | |
virtual bool | willPlayBackgroundMusic () |
Indicates whether any background music can be played or not. More... | |
virtual bool | isBackgroundMusicPlaying () |
Indicates whether the background music is playing. More... | |
var | isMusicPlaying () |
Indicates whether the background music is playing. More... | |
local | isMusicPlaying () |
Indicates whether the background music is playing. More... | |
virtual float | getBackgroundMusicVolume () |
The volume of the background music within the range of 0.0 as the minimum and 1.0 as the maximum. | |
virtual void | setBackgroundMusicVolume (float volume) |
Set the volume of background music. More... | |
var | setMusicVolume ( var volume) |
Set the volume of background music. More... | |
local | setMusicVolume ( local volume) |
Set the volume of background music. More... | |
virtual float | getEffectsVolume () |
The volume of the effects within the range of 0.0 as the minimum and 1.0 as the maximum. | |
virtual void | setEffectsVolume (float volume) |
Set the volume of sound effects. More... | |
local | setEffectsVolume ( local volume) |
Set the volume of sound effects. More... | |
virtual unsigned int | playEffect (const char *filePath, bool loop=false, float pitch=1.0f, float pan=0.0f, float gain=1.0f) |
Play sound effect with a file path, pitch, pan and gain. More... | |
var | playEffect ( var filePath, var false, var 0f, var 0f, var 0f) |
Play sound effect with a file path, pitch, pan and gain. More... | |
local | playEffect ( local filePath, local false, local 0f, local 0f, local 0f) |
Play sound effect with a file path, pitch, pan and gain. More... | |
virtual void | pauseEffect (unsigned int soundId) |
Pause playing sound effect. More... | |
virtual void | pauseAllEffects () |
Pause all playing sound effect. | |
virtual void | resumeEffect (unsigned int soundId) |
Resume playing sound effect. More... | |
var | resumeEffect ( var soundId) |
Resume playing sound effect. More... | |
local | resumeEffect ( local soundId) |
Resume playing sound effect. More... | |
virtual void | resumeAllEffects () |
Resume all playing sound effect. | |
virtual void | stopEffect (unsigned int soundId) |
Stop playing sound effect. More... | |
local | stopEffect ( local soundId) |
Stop playing sound effect. More... | |
virtual void | stopAllEffects () |
Stop all playing sound effects. | |
virtual void | preloadEffect (const char *filePath) |
Preload a compressed audio file. More... | |
local | preloadEffect ( local filePath) |
Preload a compressed audio file. More... | |
virtual void | unloadEffect (const char *filePath) |
Unload the preloaded effect from internal buffer. More... | |
Static Public Member Functions | |
static SimpleAudioEngine * | getInstance () |
Returns a shared instance of the SimpleAudioEngine. | |
local | getInstance () |
Returns a shared instance of the SimpleAudioEngine. | |
static SimpleAudioEngine * | sharedEngine () |
static void | end () |
Release the shared Engine object. More... | |
Offers a very simple interface to play background music & sound effects.
|
inlinestatic |
|
static |
Release the shared Engine object.
|
static |
Release the shared Engine object.
|
static |
Release the shared Engine object.
|
virtual |
Preload background music.
filePath | The path of the background music file. |
|
virtual |
Preload background music.
filePath | The path of the background music file. |
|
virtual |
Play background music.
filePath | The path of the background music file,or the FileName of T_SoundResInfo. |
loop | Whether the background music loop or not. |
|
virtual |
Play background music.
filePath | The path of the background music file,or the FileName of T_SoundResInfo. |
loop | Whether the background music loop or not. |
|
virtual |
Play background music.
filePath | The path of the background music file,or the FileName of T_SoundResInfo. |
loop | Whether the background music loop or not. |
|
virtual |
Stop playing background music.
releaseData | If release the background music data or not.As default value is false. |
|
virtual |
Stop playing background music.
releaseData | If release the background music data or not.As default value is false. |
|
virtual |
Stop playing background music.
releaseData | If release the background music data or not.As default value is false. |
|
virtual |
Indicates whether any background music can be played or not.
|
virtual |
Indicates whether any background music can be played or not.
|
virtual |
Indicates whether any background music can be played or not.
|
virtual |
Indicates whether the background music is playing.
|
virtual |
Indicates whether the background music is playing.
|
virtual |
Indicates whether the background music is playing.
|
virtual |
Set the volume of background music.
volume | must be within the range of 0.0 as the minimum and 1.0 as the maximum. |
|
virtual |
Set the volume of background music.
volume | must be within the range of 0.0 as the minimum and 1.0 as the maximum. |
|
virtual |
Set the volume of background music.
volume | must be within the range of 0.0 as the minimum and 1.0 as the maximum. |
|
virtual |
Set the volume of sound effects.
volume | must be within the range of 0.0 as the minimum and 1.0 as the maximum. |
|
virtual |
Set the volume of sound effects.
volume | must be within the range of 0.0 as the minimum and 1.0 as the maximum. |
|
virtual |
Set the volume of sound effects.
volume | must be within the range of 0.0 as the minimum and 1.0 as the maximum. |
|
virtual |
Play sound effect with a file path, pitch, pan and gain.
filePath | The path of the effect file. |
loop | Determines whether to loop the effect playing or not. The default value is false. |
pitch | Frequency, normal value is 1.0. Will also change effect play time. |
pan | Stereo effect, in the range of [-1..1] where -1 enables only left channel. |
gain | Volume, in the range of [0..1]. The normal value is 1. |
|
virtual |
Play sound effect with a file path, pitch, pan and gain.
filePath | The path of the effect file. |
loop | Determines whether to loop the effect playing or not. The default value is false. |
pitch | Frequency, normal value is 1.0. Will also change effect play time. |
pan | Stereo effect, in the range of [-1..1] where -1 enables only left channel. |
gain | Volume, in the range of [0..1]. The normal value is 1. |
|
virtual |
Play sound effect with a file path, pitch, pan and gain.
filePath | The path of the effect file. |
loop | Determines whether to loop the effect playing or not. The default value is false. |
pitch | Frequency, normal value is 1.0. Will also change effect play time. |
pan | Stereo effect, in the range of [-1..1] where -1 enables only left channel. |
gain | Volume, in the range of [0..1]. The normal value is 1. |
|
virtual |
Pause playing sound effect.
soundId | The return value of function playEffect. |
|
virtual |
Pause playing sound effect.
soundId | The return value of function playEffect. |
|
virtual |
Pause playing sound effect.
soundId | The return value of function playEffect. |
|
virtual |
Resume playing sound effect.
soundId | The return value of function playEffect. |
|
virtual |
Resume playing sound effect.
soundId | The return value of function playEffect. |
|
virtual |
Resume playing sound effect.
soundId | The return value of function playEffect. |
|
virtual |
Stop playing sound effect.
soundId | The return value of function playEffect. |
|
virtual |
Stop playing sound effect.
soundId | The return value of function playEffect. |
|
virtual |
Stop playing sound effect.
soundId | The return value of function playEffect. |
|
virtual |
Preload a compressed audio file.
The compressed audio will be decoded to wave, then written into an internal buffer in SimpleAudioEngine.
filePath | The path of the effect file. |
|
virtual |
Preload a compressed audio file.
The compressed audio will be decoded to wave, then written into an internal buffer in SimpleAudioEngine.
filePath | The path of the effect file. |
|
virtual |
Unload the preloaded effect from internal buffer.
filePath | The path of the effect file. |
|
virtual |
Unload the preloaded effect from internal buffer.
filePath | The path of the effect file. |
|
virtual |
Unload the preloaded effect from internal buffer.
filePath | The path of the effect file. |