Offers a interface to play audio. More...

#include <AudioEngine.h>

Classes
struct	AudioInfo

struct	ProfileHelper

Public Types
enum	AudioState { ERROR = -1, INITIALZING, PLAYING, PAUSED }
	AudioState enum,all possible states of an audio instance. More...

Static Public Member Functions
static bool	lazyInit ()
static void	end ()
	Release objects relating to AudioEngine. More...

local	end ()
	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...

static bool	isLoop (int 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...

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...

static void	stop (int audioID)
	Stop an audio instance. More...

local	stop ( local audioID)
	Stop an audio instance. More...

static void	stopAll ()
	Stop all audio instances. More...

static bool	setCurrentTime (int audioID, float time)
	Sets the current playback position of an audio instance. More...

local	setCurrentTime ( local audioID, local time)
	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...

local	getDuration ( local 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. More...

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...

static AudioProfile *	getProfile (int audioID)
	Gets the audio profile by id of audio instance. More...

local	getProfile ( local 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...

local	getProfile ( local profileName)
	Gets an audio profile by name. More...

Static Public Attributes
static const int	INVALID_AUDIO_ID
local	INVALID_AUDIO_ID
static const float	TIME_UNKNOWN

Static Protected Member Functions
static void	remove (int audioID)

Static Protected Attributes
static std::unordered_map< int, AudioInfo >	_audioIDInfoMap
static std::unordered_map < std::string, std::list< int > >	_audioPathIDMap
static std::unordered_map < std::string, ProfileHelper >	_audioPathProfileHelperMap
static unsigned int	_maxInstances
static ProfileHelper *	_defaultProfileHelper
local	_defaultProfileHelper
static AudioEngineImpl *	_audioEngineImpl
local	_audioEngineImpl

Friends
class	AudioEngineImpl

Detailed Description

Offers a interface to play audio.

Note: Make sure to call AudioEngine::end() when the audio engine is not needed anymore to release resources.

Member Function Documentation

static void end ( )

static

Release objects relating to AudioEngine.

Warning: It must be called before the application exit.

local end ( )

static

Release objects relating to AudioEngine.

Warning: It must be called before the application exit.

static float getCurrentTime ( int audioID )

static

Gets the current playback position of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: The current playback position of an audio instance.

local getCurrentTime ( local audioID )

static

Gets the current playback position of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: The current playback position of an audio instance.

static AudioProfile*
getDefaultProfile ( )

static

Gets the default profile of audio instances.

Returns: The default profile of audio instances.

local getDefaultProfile ( )

static

Gets the default profile of audio instances.

Returns: The default profile of audio instances.

static float getDuration ( int audioID )

static

Gets the duration of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: The duration of an audio instance.

local getDuration ( local audioID )

static

Gets the duration of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: The duration of an audio instance.

static int getMaxAudioInstance ( )

inlinestatic

Gets the maximum number of simultaneous audio instance of AudioEngine.

local getMaxAudioInstance ( )

inlinestatic

Gets the maximum number of simultaneous audio instance of AudioEngine.

static AudioProfile* getProfile ( int audioID )

static

Gets the audio profile by id of audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: The audio profile.

local getProfile ( local audioID )

static

Gets the audio profile by id of audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: The audio profile.

static AudioProfile* getProfile ( const std::string & profileName )

static

Gets an audio profile by name.

Parameters

profileName A name of audio profile.

Returns: The audio profile.

local getProfile ( local profileName )

static

Gets an audio profile by name.

Parameters

profileName A name of audio profile.

Returns: The audio profile.

static AudioState getState ( int audioID )

static

Returns the state of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: The status of an audio instance.

local getState ( local audioID )

static

Returns the state of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: The status of an audio instance.

static float getVolume ( int audioID )

static

Gets the volume value of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: Volume value (range from 0.0 to 1.0).

local getVolume ( local audioID )

static

Gets the volume value of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns: Volume value (range from 0.0 to 1.0).

static bool isLoop ( int audioID )

static

Checks whether an audio instance is loop.

Parameters

audioID An audioID returned by the play2d function.

Returns: Whether or not an audio instance is loop.

local isLoop ( local audioID )

static

Checks whether an audio instance is loop.

Parameters

audioID An audioID returned by the play2d function.

Returns: Whether or not an audio instance is loop.

static bool lazyInit ( )

static

local lazyInit ( )

static

static void pause ( int audioID )

static

Pause an audio instance.

Parameters

audioID An audioID returned by the play2d function.

local pause ( local audioID )

static

Pause an audio instance.

Parameters

audioID An audioID returned by the play2d function.

static void pauseAll ( )

static

Pause all playing audio instances.

local pauseAll ( )

static

Pause all playing audio instances.

static int play2d	(	const std::string &	filePath,
		bool	loop = `false`,
		float	volume = `1.0f`,
		const AudioProfile *	profile = `nullptr`
	)

static

Play 2d sound.

Parameters

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.

Returns: An audio ID. It allows you to dynamically change the behavior of an audio instance on the fly.

See also: AudioProfile

local play2d	(	local	filePath,
		local	loop = `false`,
		local	volume = `1.0f`,
		local	profile = `nullptr`
	)

static

Play 2d sound.

Parameters

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.

Returns: An audio ID. It allows you to dynamically change the behavior of an audio instance on the fly.

See also: AudioProfile

static void remove ( int audioID )

staticprotected

local remove ( local audioID )

staticprotected

static void resume ( int audioID )

static

Resume an audio instance.

Parameters

audioID An audioID returned by the play2d function.

local resume ( local audioID )

static

Resume an audio instance.

Parameters

audioID An audioID returned by the play2d function.

static void resumeAll ( )

static

Resume all suspended audio instances.

local resumeAll ( )

static

Resume all suspended audio instances.

static bool setCurrentTime	(	int	audioID,
		float	time
	)

static

Sets the current playback position of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns

local setCurrentTime	(	local	audioID,
		local	time
	)

static

Sets the current playback position of an audio instance.

Parameters

audioID An audioID returned by the play2d function.

Returns

static void setFinishCallback	(	int	audioID,
		const std::function< void(int, const std::string &)> &	callback
	)

static

Register a callback to be invoked when an audio instance has completed playing.

Parameters

audioID	An audioID returned by the play2d function.
callback

local setFinishCallback	(	local	audioID,
		local	callback
	)

static

Register a callback to be invoked when an audio instance has completed playing.

Parameters

audioID	An audioID returned by the play2d function.
callback

static void setLoop	(	int	audioID,
		bool	loop
	)

static

Sets whether an audio instance loop or not.

Parameters

audioID	An audioID returned by the play2d function.
loop	Whether audio instance loop or not.

local setLoop	(	local	audioID,
		local	loop
	)

static

Sets whether an audio instance loop or not.

Parameters

audioID	An audioID returned by the play2d function.
loop	Whether audio instance loop or not.

static bool setMaxAudioInstance ( int maxInstances )

static

Sets the maximum number of simultaneous audio instance for AudioEngine.

Parameters

maxInstances The maximum number of simultaneous audio instance.

local setMaxAudioInstance ( local maxInstances )

static

Sets the maximum number of simultaneous audio instance for AudioEngine.

Parameters

maxInstances The maximum number of simultaneous audio instance.

static void setVolume	(	int	audioID,
		float	volume
	)

static

Sets volume for an audio instance.

Parameters

audioID	An audioID returned by the play2d function.
volume	Volume value (range from 0.0 to 1.0).

local setVolume	(	local	audioID,
		local	volume
	)

static

Sets volume for an audio instance.

Parameters

audioID	An audioID returned by the play2d function.
volume	Volume value (range from 0.0 to 1.0).

static void stop ( int audioID )

static

Stop an audio instance.

Parameters

audioID An audioID returned by the play2d function.

local stop ( local audioID )

static

Stop an audio instance.

Parameters

audioID An audioID returned by the play2d function.

static void stopAll ( )

static

Stop all audio instances.

local stopAll ( )

static

Stop all audio instances.

static void uncache ( const std::string & filePath )

static

Uncache the audio data from internal buffer.

AudioEngine cache audio data on ios,mac, and win32 platform.

Warning: This can lead to stop related audio first.

Parameters

filePath Audio file path.

local uncache ( local filePath )

static

Uncache the audio data from internal buffer.

AudioEngine cache audio data on ios,mac, and win32 platform.

Warning: This can lead to stop related audio first.

Parameters

filePath Audio file path.

static void uncacheAll ( )

static

Uncache all audio data from internal buffer.

Warning: All audio will be stopped first.

local uncacheAll ( )

static

Uncache all audio data from internal buffer.

Warning: All audio will be stopped first.

Friends And Related Function Documentation

friend class AudioEngineImpl

friend

local AudioEngineImpl

friend

Member Data Documentation

AudioEngineImpl* _audioEngineImpl

staticprotected

local _audioEngineImpl

staticprotected

std::unordered_map<int,
AudioInfo> _audioIDInfoMap

staticprotected

local _audioIDInfoMap

staticprotected

std::unordered_map<std::string,std::list
<int> > _audioPathIDMap

staticprotected

local _audioPathIDMap

staticprotected

std::unordered_map<std::string,
ProfileHelper>
_audioPathProfileHelperMap

staticprotected

local _audioPathProfileHelperMap

staticprotected

ProfileHelper*
_defaultProfileHelper

staticprotected

local _defaultProfileHelper

staticprotected

unsigned int _maxInstances

staticprotected

local _maxInstances

staticprotected

const int INVALID_AUDIO_ID

static

local INVALID_AUDIO_ID

static

const float TIME_UNKNOWN

static

local TIME_UNKNOWN

static

The documentation for this class was generated from the following file:

/Users/minggo/SourceCode/cocos2d-x/cocos/audio/include/AudioEngine.h

Classes

Public Types

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Static Protected Attributes

Friends

Detailed Description

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation