ComAudio Class Reference

#include <CCComAudio.h>

Inheritance diagram for ComAudio:

Public Member Functions
virtual bool	init ()
virtual void	onEnter ()
virtual void	onExit ()
virtual bool	isEnabled () const
virtual void	setEnabled (bool b)
local	setEnabled ( local b)
void	end ()
void	preloadBackgroundMusic (const char *pszFilePath)
void	playBackgroundMusic (const char *pszFilePath, bool bLoop)
void	playBackgroundMusic (const char *pszFilePath)
var	playBackgroundMusic ( var pszFilePath)
local	playBackgroundMusic ( local pszFilePath)
void	stopBackgroundMusic (bool bReleaseData)
void	stopBackgroundMusic ()
void	pauseBackgroundMusic ()
void	resumeBackgroundMusic ()
void	rewindBackgroundMusic ()
bool	willPlayBackgroundMusic ()
bool	isBackgroundMusicPlaying ()
float	getBackgroundMusicVolume ()
void	setBackgroundMusicVolume (float volume)
float	getEffectsVolume ()
void	setEffectsVolume (float volume)
unsigned int	playEffect (const char *pszFilePath, bool bLoop)
local	playEffect ( local pszFilePath, local bLoop)
unsigned int	playEffect (const char *pszFilePath)
local	playEffect ( local pszFilePath)
void	pauseEffect (unsigned int nSoundId)
void	pauseAllEffects ()
void	resumeEffect (unsigned int nSoundId)
void	resumeAllEffects ()
void	stopEffect (unsigned int nSoundId)
void	stopAllEffects ()
void	preloadEffect (const char *pszFilePath)
void	unloadEffect (const char *pszFilePath)
void	setFile (const char *pszFilePath)
const char *	getFile ()
void	setLoop (bool bLoop)
bool	isLoop ()
Public Member Functions inherited from Component
virtual	~Component (void)
virtual void	update (float delta)
virtual void	serialize (void *r)
local	serialize ( local r)
const char *	getName () const
void	setName (const char *pName)
void	setOwner (Node *pOwner)
Node *	getOwner () const
Public Member Functions inherited from Object
	Object ()
	Constructor. More...
virtual	~Object ()
void	release ()
	Release the ownership immediately. More...
void	retain ()
	Retains the ownership. More...
Object *	autorelease ()
	Release the ownership sometime soon automatically. More...
bool	isSingleReference () const
	Returns a boolean value that indicates whether there is only one reference to the object. More...
unsigned int	retainCount () const
	Returns the object's current reference count. More...
virtual bool	isEqual (const Object *object)
	Returns a boolean value that indicates whether this object and a given object are equal. More...
virtual void	acceptVisitor (DataVisitor &visitor)

Static Public Member Functions
static ComAudio *	create (void)
var	create ()
Static Public Member Functions inherited from Component
static Component *	create (void)
var	create ()
local	create ()

Protected Member Functions
	ComAudio (void)
virtual	~ComAudio (void)
Protected Member Functions inherited from Component
	Component (void)

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID More...
int	_luaID
	Lua reference id. More...
Protected Attributes inherited from Component
Node *	_owner
std::string	_name
var	_name
local	_name
bool	_enabled

Constructor & Destructor Documentation

ComAudio ( void  )

protected

var ctor (   )

protected

local ComAudio (   )

protected

virtual ~ComAudio ( void  )

protectedvirtual

Member Function Documentation

static ComAudio* create ( void  )

static

var create (   )

static

local create (   )

static

void end

(

)

var end

(

)

local end

(

)

float getBackgroundMusicVolume

(

)

var getBackgroundMusicVolume

(

)

local getBackgroundMusicVolume

(

)

float getEffectsVolume

(

)

var getEffectsVolume

(

)

local getEffectsVolume

(

)

const char* getFile

(

)

var getFile

(

)

local getFile

(

)

virtual bool init ( )

virtual

Reimplemented from Component.

var init ( )

virtual

Reimplemented from Component.

local init ( )

virtual

Reimplemented from Component.

bool isBackgroundMusicPlaying

(

)

var isBackgroundMusicPlaying

(

)

local isBackgroundMusicPlaying

(

)

virtual bool isEnabled ( ) const

virtual

Reimplemented from Component.

var isEnabled ( )

virtual

Reimplemented from Component.

local isEnabled ( )

virtual

Reimplemented from Component.

bool isLoop

(

)

var isLoop

(

)

local isLoop

(

)

virtual void onEnter ( )

virtual

Reimplemented from Component.

virtual void onExit ( )

virtual

Reimplemented from Component.

void pauseAllEffects

(

)

var pauseAllEffects

(

)

local pauseAllEffects

(

)

void pauseBackgroundMusic

(

)

var pauseBackgroundMusic

(

)

local pauseBackgroundMusic

(

)

void pauseEffect

(

unsigned int

nSoundId)

var pauseEffect

(

var

nSoundId)

local pauseEffect

(

local

nSoundId)

void playBackgroundMusic	(	const char *	pszFilePath,
		bool	bLoop
	)

var playBackgroundMusic	(	var	pszFilePath,
		var	bLoop
	)

local playBackgroundMusic	(	local	pszFilePath,
		local	bLoop
	)

void playBackgroundMusic

(

const char *

pszFilePath)

var playBackgroundMusic

(

var

pszFilePath)

local playBackgroundMusic

(

local

pszFilePath)

unsigned int playEffect	(	const char *	pszFilePath,
		bool	bLoop
	)

var playEffect	(	var	pszFilePath,
		var	bLoop
	)

local playEffect	(	local	pszFilePath,
		local	bLoop
	)

unsigned int playEffect

(

const char *

pszFilePath)

var playEffect

(

var

pszFilePath)

local playEffect

(

local

pszFilePath)

void preloadBackgroundMusic

(

const char *

pszFilePath)

var preloadBackgroundMusic

(

var

pszFilePath)

local preloadBackgroundMusic

(

local

pszFilePath)

void preloadEffect

(

const char *

pszFilePath)

var preloadEffect

(

var

pszFilePath)

local preloadEffect

(

local

pszFilePath)

void resumeAllEffects

(

)

var resumeAllEffects

(

)

local resumeAllEffects

(

)

void resumeBackgroundMusic

(

)

var resumeBackgroundMusic

(

)

local resumeBackgroundMusic

(

)

void resumeEffect

(

unsigned int

nSoundId)

var resumeEffect

(

var

nSoundId)

local resumeEffect

(

local

nSoundId)

void rewindBackgroundMusic

(

)

var rewindBackgroundMusic

(

)

local rewindBackgroundMusic

(

)

void setBackgroundMusicVolume

(

float

volume)

var setBackgroundMusicVolume

(

var

volume)

local setBackgroundMusicVolume

(

local

volume)

void setEffectsVolume

(

float

volume)

var setEffectsVolume

(

var

volume)

local setEffectsVolume

(

local

volume)

virtual void setEnabled ( bool  b)

virtual

Reimplemented from Component.

var setEnabled ( var  b)

virtual

Reimplemented from Component.

local setEnabled ( local  b)

virtual

Reimplemented from Component.

void setFile

(

const char *

pszFilePath)

var setFile

(

var

pszFilePath)

local setFile

(

local

pszFilePath)

void setLoop

(

bool

bLoop)

var setLoop

(

var

bLoop)

local setLoop

(

local

bLoop)

void stopAllEffects

(

)

var stopAllEffects

(

)

local stopAllEffects

(

)

void stopBackgroundMusic

(

bool

bReleaseData)

var stopBackgroundMusic

(

var

bReleaseData)

local stopBackgroundMusic

(

local

bReleaseData)

void stopBackgroundMusic

(

)

var stopBackgroundMusic

(

)

local stopBackgroundMusic

(

)

void stopEffect

(

unsigned int

nSoundId)

var stopEffect

(

var

nSoundId)

local stopEffect

(

local

nSoundId)

void unloadEffect

(

const char *

pszFilePath)

var unloadEffect

(

var

pszFilePath)

local unloadEffect

(

local

pszFilePath)

bool willPlayBackgroundMusic

(

)

var willPlayBackgroundMusic

(

)

local willPlayBackgroundMusic

(

)

---

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

• /Users/cocos2d/MyWork/cocos2d-x-develop/extensions/CocoStudio/Components/CCComAudio.h