Offers a interface to play audio. More...
Public Types | |
enum | AudioState |
AudioState enum,all possible states of an audio instance. More... | |
Static Public Member Functions | |
static void | end () |
Release objects relating to AudioEngine. More... | |
local | endToLua () |
Release objects relating to AudioEngine. More... | |
static AudioProfile * | getDefaultProfile () |
Gets the default profile of audio instances. More... | |
local | getDefaultProfile () |
Gets the default profile of audio instances. More... | |
static int | play2d (const std::string &filePath, bool loop=false, float volume=1.0f, const AudioProfile *profile=nullptr) |
Play 2d sound. More... | |
local | play2d ( local filePath, local false, local 0f, local nullptr) |
Play 2d sound. More... | |
static void | setLoop (int audioID, bool loop) |
Sets whether an audio instance loop or not. More... | |
local | setLoop ( local audioID, local loop) |
Sets whether an audio instance loop or not. More... | |
static bool | isLoop (int audioID) |
Checks whether an audio instance is loop. More... | |
local | isLoop ( local audioID) |
Checks whether an audio instance is loop. More... | |
static void | setVolume (int audioID, float volume) |
Sets volume for an audio instance. More... | |
local | setVolume ( local audioID, local volume) |
Sets volume for an audio instance. More... | |
static float | getVolume (int audioID) |
Gets the volume value of an audio instance. More... | |
static void | pause (int audioID) |
Pause an audio instance. More... | |
local | pause ( local audioID) |
Pause an audio instance. More... | |
static void | pauseAll () |
Pause all playing audio instances. More... | |
local | pauseAll () |
Pause all playing audio instances. More... | |
static void | resume (int audioID) |
Resume an audio instance. More... | |
local | resume ( local audioID) |
Resume an audio instance. More... | |
static void | resumeAll () |
Resume all suspended audio instances. More... | |
local | resumeAll () |
Resume all suspended audio instances. More... | |
static void | stop (int audioID) |
Stop an audio instance. More... | |
static void | stopAll () |
Stop all audio instances. More... | |
static bool | setCurrentTime (int audioID, float sec) |
Sets the current playback position of an audio instance. More... | |
static float | getCurrentTime (int audioID) |
Gets the current playback position of an audio instance. More... | |
static float | getDuration (int audioID) |
Gets the duration of an audio instance. More... | |
static AudioState | getState (int audioID) |
Returns the state of an audio instance. More... | |
local | getState ( local audioID) |
Returns the state of an audio instance. More... | |
static void | setFinishCallback (int audioID, const std::function< void(int, const std::string &)> &callback) |
Register a callback to be invoked when an audio instance has completed playing. More... | |
local | setFinishCallback ( local audioID, local int, local callback) |
Register a callback to be invoked when an audio instance has completed playing. More... | |
static int | getMaxAudioInstance () |
Gets the maximum number of simultaneous audio instance of AudioEngine. | |
static bool | setMaxAudioInstance (int maxInstances) |
Sets the maximum number of simultaneous audio instance for AudioEngine. More... | |
local | setMaxAudioInstance ( local maxInstances) |
Sets the maximum number of simultaneous audio instance for AudioEngine. More... | |
static void | uncache (const std::string &filePath) |
Uncache the audio data from internal buffer. More... | |
static void | uncacheAll () |
Uncache all audio data from internal buffer. More... | |
local | uncacheAll () |
Uncache all audio data from internal buffer. More... | |
static AudioProfile * | getProfile (int audioID) |
Gets the audio profile by id of audio instance. More... | |
static AudioProfile * | getProfile (const std::string &profileName) |
Gets an audio profile by name. More... | |
static void | preload (const std::string &filePath) |
Preload audio file. More... | |
local | preload ( local filePath) |
Preload audio file. More... | |
static void | preload (const std::string &filePath, std::function< void(bool isSuccess)> callback) |
Preload audio file. More... | |
local | preload ( local filePath, local callback) |
Preload audio file. More... | |
static int | getPlayingAudioCount () |
Gets playing audio count. | |
local | getPlayingAudioCount () |
Gets playing audio count. | |
static void | setEnabled (bool isEnabled) |
Whether to enable playing audios. More... | |
local | setEnabled ( local isEnabled) |
Whether to enable playing audios. More... | |
static bool | isEnabled () |
Check whether AudioEngine is enabled. | |
local | isEnabled () |
Check whether AudioEngine is enabled. | |
Offers a interface to play audio.
|
static |
Release objects relating to AudioEngine.
|
static |
Release objects relating to AudioEngine.
|
static |
Gets the default profile of audio instances.
|
static |
Gets the default profile of audio instances.
|
static |
Play 2d sound.
filePath | The path of an audio file. |
loop | Whether audio instance loop or not. |
volume | Volume value (range from 0.0 to 1.0). |
profile | A profile for audio instance. When profile is not specified, default profile will be used. |
AudioProfile
|
static |
Play 2d sound.
filePath | The path of an audio file. |
loop | Whether audio instance loop or not. |
volume | Volume value (range from 0.0 to 1.0). |
profile | A profile for audio instance. When profile is not specified, default profile will be used. |
AudioProfile
|
static |
Sets whether an audio instance loop or not.
audioID | An audioID returned by the play2d function. |
loop | Whether audio instance loop or not. |
|
static |
Sets whether an audio instance loop or not.
audioID | An audioID returned by the play2d function. |
loop | Whether audio instance loop or not. |
|
static |
Checks whether an audio instance is loop.
audioID | An audioID returned by the play2d function. |
|
static |
Checks whether an audio instance is loop.
audioID | An audioID returned by the play2d function. |
|
static |
Sets volume for an audio instance.
audioID | An audioID returned by the play2d function. |
volume | Volume value (range from 0.0 to 1.0). |
|
static |
Sets volume for an audio instance.
audioID | An audioID returned by the play2d function. |
volume | Volume value (range from 0.0 to 1.0). |
|
static |
Gets the volume value of an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Gets the volume value of an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Pause an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Pause an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Pause all playing audio instances.
|
static |
Pause all playing audio instances.
|
static |
Resume an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Resume an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Resume all suspended audio instances.
|
static |
Resume all suspended audio instances.
|
static |
Stop an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Stop an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Stop all audio instances.
|
static |
Stop all audio instances.
|
static |
Sets the current playback position of an audio instance.
audioID | An audioID returned by the play2d function. |
sec | The offset in seconds from the start to seek to. |
|
static |
Sets the current playback position of an audio instance.
audioID | An audioID returned by the play2d function. |
sec | The offset in seconds from the start to seek to. |
|
static |
Gets the current playback position of an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Gets the current playback position of an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Gets the duration of an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Gets the duration of an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Returns the state of an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Returns the state of an audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Register a callback to be invoked when an audio instance has completed playing.
audioID | An audioID returned by the play2d function. |
callback |
|
static |
Register a callback to be invoked when an audio instance has completed playing.
audioID | An audioID returned by the play2d function. |
callback |
|
static |
Sets the maximum number of simultaneous audio instance for AudioEngine.
maxInstances | The maximum number of simultaneous audio instance. |
|
static |
Sets the maximum number of simultaneous audio instance for AudioEngine.
maxInstances | The maximum number of simultaneous audio instance. |
|
static |
Uncache the audio data from internal buffer.
AudioEngine cache audio data on ios,mac, and win32 platform.
filePath | Audio file path. |
|
static |
Uncache the audio data from internal buffer.
AudioEngine cache audio data on ios,mac, and win32 platform.
filePath | Audio file path. |
|
static |
Uncache all audio data from internal buffer.
|
static |
Uncache all audio data from internal buffer.
|
static |
Gets the audio profile by id of audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Gets the audio profile by id of audio instance.
audioID | An audioID returned by the play2d function. |
|
static |
Gets an audio profile by name.
profileName | A name of audio profile. |
|
static |
Gets an audio profile by name.
profileName | A name of audio profile. |
|
inlinestatic |
Preload audio file.
filePath | The file path of an audio. |
|
inlinestatic |
Preload audio file.
filePath | The file path of an audio. |
|
static |
Preload audio file.
filePath | The file path of an audio. |
callback | A callback which will be called after loading is finished. |
|
static |
Preload audio file.
filePath | The file path of an audio. |
callback | A callback which will be called after loading is finished. |
|
static |
Whether to enable playing audios.
|
static |
Whether to enable playing audios.