ComAudio Class Reference

#include <CCComAudio.h>

Inheritance diagram for ComAudio:

Public Member Functions
	ComAudio (void)
virtual	~ComAudio (void)
virtual bool	init () override
virtual void	onEnter () override
virtual void	onExit () override
virtual bool	isEnabled () const override
local	isEnabled ()
virtual void	setEnabled (bool b) override
var	setEnabled ( var b)
local	setEnabled ( local b)
virtual bool	serialize (void *r) override
local	serialize ( local r)
void	end ()
void	preloadBackgroundMusic (const char *pszFilePath)
var	preloadBackgroundMusic ( var pszFilePath)
local	preloadBackgroundMusic ( local pszFilePath)
void	playBackgroundMusic (const char *pszFilePath, bool bLoop)
void	playBackgroundMusic (const char *pszFilePath)
void	playBackgroundMusic ()
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)
var	playEffect ( var pszFilePath, var bLoop)
local	playEffect ( local pszFilePath, local bLoop)
unsigned int	playEffect (const char *pszFilePath)
unsigned int	playEffect ()
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)
local	update ( local delta)
const std::string &	getName () const
void	setName (const std::string &name)
local	setName ( local name)
void	setOwner (Node *pOwner)
var	setOwner ( var pOwner)
local	setOwner ( local pOwner)
Node *	getOwner () const
var	getOwner ()
local	getOwner ()
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()

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

Additional Inherited Members
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...
Protected Attributes inherited from Component
Node *	_owner
std::string	_name
var	_name
local	_name
bool	_enabled
var	_enabled
local	_enabled
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...
var	_referenceCount
	count of references More...
local	_referenceCount
	count of references More...

Constructor & Destructor Documentation

ComAudio

(

void

)

var ctor

(

)

local ComAudio

(

)

virtual ~ComAudio ( void  )

virtual

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 ( )

overridevirtual

Reimplemented from Component.

var init ( )

overridevirtual

Reimplemented from Component.

local init ( )

overridevirtual

Reimplemented from Component.

bool isBackgroundMusicPlaying

(

)

var isBackgroundMusicPlaying

(

)

local isBackgroundMusicPlaying

(

)

virtual bool isEnabled ( ) const

overridevirtual

Reimplemented from Component.

var isEnabled ( )

overridevirtual

Reimplemented from Component.

local isEnabled ( )

overridevirtual

Reimplemented from Component.

bool isLoop

(

)

var isLoop

(

)

local isLoop

(

)

virtual void onEnter ( )

overridevirtual

Reimplemented from Component.

virtual void onExit ( )

overridevirtual

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

)

void playBackgroundMusic

(

)

var playBackgroundMusic

(

)

local playBackgroundMusic

(

)

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

)

unsigned int playEffect

(

)

var playEffect

(

)

local playEffect

(

)

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

(

)

virtual bool serialize ( void *  r )

overridevirtual

Reimplemented from Component.

var serialize ( var  r )

overridevirtual

Reimplemented from Component.

local serialize ( local  r )

overridevirtual

Reimplemented from Component.

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 )

overridevirtual

Reimplemented from Component.

var setEnabled ( var  b )

overridevirtual

Reimplemented from Component.

local setEnabled ( local  b )

overridevirtual

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/huabingxu/work/cocos2d-x/cocos/editor-support/cocostudio/CCComAudio.h