Audio Class Reference

#include <Audio.h>

Public Member Functions
	Audio ()
void	Initialize ()
void	CreateResources ()
void	ReleaseResources ()
void	Start ()
void	Render ()
void	SetEngineExperiencedCriticalError ()
var	SetEngineExperiencedCriticalError ()
local	SetEngineExperiencedCriticalError ()
bool	HasEngineExperiencedCriticalError ()
void	PlayBackgroundMusic (const char *pszFilePath, bool bLoop)
void	StopBackgroundMusic (bool bReleaseData)
void	PauseBackgroundMusic ()
void	ResumeBackgroundMusic ()
void	RewindBackgroundMusic ()
bool	IsBackgroundMusicPlaying ()
void	SetBackgroundVolume (float volume)
float	GetBackgroundVolume ()
void	SetSoundEffectVolume (float volume)
float	GetSoundEffectVolume ()
void	PlaySoundEffect (const char *pszFilePath, bool bLoop, unsigned int &sound, bool isMusic=false)
local	PlaySoundEffect ( local pszFilePath, local bLoop, local sound, local false)
void	PlaySoundEffect (unsigned int sound)
bool	IsSoundEffectStarted (unsigned int sound)
void	StopSoundEffect (unsigned int sound)
var	StopSoundEffect ( var sound)
local	StopSoundEffect ( local sound)
void	PauseSoundEffect (unsigned int sound)
void	ResumeSoundEffect (unsigned int sound)
var	ResumeSoundEffect ( var sound)
local	ResumeSoundEffect ( local sound)
void	RewindSoundEffect (unsigned int sound)
void	PauseAllSoundEffects ()
void	ResumeAllSoundEffects ()
void	StopAllSoundEffects ()
void	PreloadSoundEffect (const char *pszFilePath, bool isMusic=false)
var	PreloadSoundEffect ( var pszFilePath, var false)
local	PreloadSoundEffect ( local pszFilePath, local false)
void	UnloadSoundEffect (const char *pszFilePath)
void	UnloadSoundEffect (unsigned int sound)
	Audio ()
void	Initialize ()
var	Initialize ()
local	Initialize ()
void	CreateResources ()
var	CreateResources ()
local	CreateResources ()
void	ReleaseResources ()
var	ReleaseResources ()
local	ReleaseResources ()
void	Start ()
var	Start ()
local	Start ()
void	Render ()
var	Render ()
local	Render ()
void	SetEngineExperiencedCriticalError ()
var	SetEngineExperiencedCriticalError ()
local	SetEngineExperiencedCriticalError ()
bool	HasEngineExperiencedCriticalError ()
var	HasEngineExperiencedCriticalError ()
local	HasEngineExperiencedCriticalError ()
void	PlayBackgroundMusic (const char *pszFilePath, bool bLoop)
var	PlayBackgroundMusic ( var pszFilePath, var bLoop)
local	PlayBackgroundMusic ( local pszFilePath, local bLoop)
void	StopBackgroundMusic (bool bReleaseData)
var	StopBackgroundMusic ( var bReleaseData)
local	StopBackgroundMusic ( local bReleaseData)
void	PauseBackgroundMusic ()
void	ResumeBackgroundMusic ()
var	ResumeBackgroundMusic ()
local	ResumeBackgroundMusic ()
void	RewindBackgroundMusic ()
var	RewindBackgroundMusic ()
local	RewindBackgroundMusic ()
bool	IsBackgroundMusicPlaying ()
var	IsBackgroundMusicPlaying ()
local	IsBackgroundMusicPlaying ()
void	SetBackgroundVolume (float volume)
var	SetBackgroundVolume ( var volume)
local	SetBackgroundVolume ( local volume)
float	GetBackgroundVolume ()
var	GetBackgroundVolume ()
local	GetBackgroundVolume ()
void	SetSoundEffectVolume (float volume)
var	SetSoundEffectVolume ( var volume)
local	SetSoundEffectVolume ( local volume)
float	GetSoundEffectVolume ()
var	GetSoundEffectVolume ()
local	GetSoundEffectVolume ()
void	PlaySoundEffect (const char *pszFilePath, bool bLoop, unsigned int &sound, bool isMusic=false)
var	PlaySoundEffect ( var pszFilePath, var bLoop, var sound, var false)
local	PlaySoundEffect ( local pszFilePath, local bLoop, local sound, local false)
void	PlaySoundEffect (unsigned int sound)
var	PlaySoundEffect ( var sound)
local	PlaySoundEffect ( local sound)
bool	IsSoundEffectStarted (unsigned int sound)
var	IsSoundEffectStarted ( var sound)
local	IsSoundEffectStarted ( local sound)
void	StopSoundEffect (unsigned int sound)
var	StopSoundEffect ( var sound)
local	StopSoundEffect ( local sound)
void	PauseSoundEffect (unsigned int sound)
var	PauseSoundEffect ( var sound)
local	PauseSoundEffect ( local sound)
void	ResumeSoundEffect (unsigned int sound)
var	ResumeSoundEffect ( var sound)
local	ResumeSoundEffect ( local sound)
void	RewindSoundEffect (unsigned int sound)
var	RewindSoundEffect ( var sound)
local	RewindSoundEffect ( local sound)
void	PauseAllSoundEffects ()
var	PauseAllSoundEffects ()
local	PauseAllSoundEffects ()
void	ResumeAllSoundEffects ()
var	ResumeAllSoundEffects ()
local	ResumeAllSoundEffects ()
void	StopAllSoundEffects ()
var	StopAllSoundEffects ()
local	StopAllSoundEffects ()
void	PreloadSoundEffect (const char *pszFilePath, bool isMusic=false)
var	PreloadSoundEffect ( var pszFilePath, var false)
local	PreloadSoundEffect ( local pszFilePath, local false)
void	UnloadSoundEffect (const char *pszFilePath)
var	UnloadSoundEffect ( var pszFilePath)
local	UnloadSoundEffect ( local pszFilePath)
void	UnloadSoundEffect (unsigned int sound)
var	UnloadSoundEffect ( var sound)
local	UnloadSoundEffect ( local sound)

Constructor & Destructor Documentation

Audio

(

)

var Audio

(

)

local Audio

(

)

Audio

(

)

var Audio

(

)

local Audio

(

)

Member Function Documentation

void CreateResources

(

)

var CreateResources

(

)

local CreateResources

(

)

void CreateResources

(

)

var CreateResources

(

)

local CreateResources

(

)

float GetBackgroundVolume

(

)

var GetBackgroundVolume

(

)

local GetBackgroundVolume

(

)

float GetBackgroundVolume

(

)

var GetBackgroundVolume

(

)

local GetBackgroundVolume

(

)

float GetSoundEffectVolume

(

)

var GetSoundEffectVolume

(

)

local GetSoundEffectVolume

(

)

float GetSoundEffectVolume

(

)

var GetSoundEffectVolume

(

)

local GetSoundEffectVolume

(

)

bool HasEngineExperiencedCriticalError ( )

inline

var HasEngineExperiencedCriticalError ( )

inline

local HasEngineExperiencedCriticalError ( )

inline

bool HasEngineExperiencedCriticalError ( )

inline

var HasEngineExperiencedCriticalError ( )

inline

local HasEngineExperiencedCriticalError ( )

inline

void Initialize

(

)

var Initialize

(

)

local Initialize

(

)

void Initialize

(

)

var Initialize

(

)

local Initialize

(

)

bool IsBackgroundMusicPlaying

(

)

var IsBackgroundMusicPlaying

(

)

local IsBackgroundMusicPlaying

(

)

bool IsBackgroundMusicPlaying

(

)

var IsBackgroundMusicPlaying

(

)

local IsBackgroundMusicPlaying

(

)

bool IsSoundEffectStarted

(

unsigned int

sound)

var IsSoundEffectStarted

(

var

sound)

local IsSoundEffectStarted

(

local

sound)

bool IsSoundEffectStarted

(

unsigned int

sound)

var IsSoundEffectStarted

(

var

sound)

local IsSoundEffectStarted

(

local

sound)

void PauseAllSoundEffects

(

)

var PauseAllSoundEffects

(

)

local PauseAllSoundEffects

(

)

void PauseAllSoundEffects

(

)

var PauseAllSoundEffects

(

)

local PauseAllSoundEffects

(

)

void PauseBackgroundMusic

(

)

var PauseBackgroundMusic

(

)

local PauseBackgroundMusic

(

)

void PauseBackgroundMusic

(

)

var PauseBackgroundMusic

(

)

local PauseBackgroundMusic

(

)

void PauseSoundEffect

(

unsigned int

sound)

var PauseSoundEffect

(

var

sound)

local PauseSoundEffect

(

local

sound)

void PauseSoundEffect

(

unsigned int

sound)

var PauseSoundEffect

(

var

sound)

local PauseSoundEffect

(

local

sound)

void PlayBackgroundMusic	(	const char *	pszFilePath,
		bool	bLoop
	)

var PlayBackgroundMusic	(	var	pszFilePath,
		var	bLoop
	)

local PlayBackgroundMusic	(	local	pszFilePath,
		local	bLoop
	)

void PlayBackgroundMusic	(	const char *	pszFilePath,
		bool	bLoop
	)

var PlayBackgroundMusic	(	var	pszFilePath,
		var	bLoop
	)

local PlayBackgroundMusic	(	local	pszFilePath,
		local	bLoop
	)

void PlaySoundEffect	(	const char *	pszFilePath,
		bool	bLoop,
		unsigned int &	sound,
		bool	isMusic = false
	)

var PlaySoundEffect	(	var	pszFilePath,
		var	bLoop,
		var	sound,
		var	isMusic = false
	)

local PlaySoundEffect	(	local	pszFilePath,
		local	bLoop,
		local	sound,
		local	isMusic = false
	)

void PlaySoundEffect

(

unsigned int

sound)

var PlaySoundEffect

(

var

sound)

local PlaySoundEffect

(

local

sound)

void PlaySoundEffect	(	const char *	pszFilePath,
		bool	bLoop,
		unsigned int &	sound,
		bool	isMusic = false
	)

var PlaySoundEffect	(	var	pszFilePath,
		var	bLoop,
		var	sound,
		var	isMusic = false
	)

local PlaySoundEffect	(	local	pszFilePath,
		local	bLoop,
		local	sound,
		local	isMusic = false
	)

void PlaySoundEffect

(

unsigned int

sound)

var PlaySoundEffect

(

var

sound)

local PlaySoundEffect

(

local

sound)

void PreloadSoundEffect	(	const char *	pszFilePath,
		bool	isMusic = false
	)

var PreloadSoundEffect	(	var	pszFilePath,
		var	isMusic = false
	)

local PreloadSoundEffect	(	local	pszFilePath,
		local	isMusic = false
	)

void PreloadSoundEffect	(	const char *	pszFilePath,
		bool	isMusic = false
	)

var PreloadSoundEffect	(	var	pszFilePath,
		var	isMusic = false
	)

local PreloadSoundEffect	(	local	pszFilePath,
		local	isMusic = false
	)

void ReleaseResources

(

)

var ReleaseResources

(

)

local ReleaseResources

(

)

void ReleaseResources

(

)

var ReleaseResources

(

)

local ReleaseResources

(

)

void Render

(

)

var Render

(

)

local Render

(

)

void Render

(

)

var Render

(

)

local Render

(

)

void ResumeAllSoundEffects

(

)

var ResumeAllSoundEffects

(

)

local ResumeAllSoundEffects

(

)

void ResumeAllSoundEffects

(

)

var ResumeAllSoundEffects

(

)

local ResumeAllSoundEffects

(

)

void ResumeBackgroundMusic

(

)

var ResumeBackgroundMusic

(

)

local ResumeBackgroundMusic

(

)

void ResumeBackgroundMusic

(

)

var ResumeBackgroundMusic

(

)

local ResumeBackgroundMusic

(

)

void ResumeSoundEffect

(

unsigned int

sound)

var ResumeSoundEffect

(

var

sound)

local ResumeSoundEffect

(

local

sound)

void ResumeSoundEffect

(

unsigned int

sound)

var ResumeSoundEffect

(

var

sound)

local ResumeSoundEffect

(

local

sound)

void RewindBackgroundMusic

(

)

var RewindBackgroundMusic

(

)

local RewindBackgroundMusic

(

)

void RewindBackgroundMusic

(

)

var RewindBackgroundMusic

(

)

local RewindBackgroundMusic

(

)

void RewindSoundEffect

(

unsigned int

sound)

var RewindSoundEffect

(

var

sound)

local RewindSoundEffect

(

local

sound)

void RewindSoundEffect

(

unsigned int

sound)

var RewindSoundEffect

(

var

sound)

local RewindSoundEffect

(

local

sound)

void SetBackgroundVolume

(

float

volume)

var SetBackgroundVolume

(

var

volume)

local SetBackgroundVolume

(

local

volume)

void SetBackgroundVolume

(

float

volume)

var SetBackgroundVolume

(

var

volume)

local SetBackgroundVolume

(

local

volume)

void SetEngineExperiencedCriticalError ( )

inline

var SetEngineExperiencedCriticalError ( )

inline

local SetEngineExperiencedCriticalError ( )

inline

void SetEngineExperiencedCriticalError ( )

inline

var SetEngineExperiencedCriticalError ( )

inline

local SetEngineExperiencedCriticalError ( )

inline

void SetSoundEffectVolume

(

float

volume)

var SetSoundEffectVolume

(

var

volume)

local SetSoundEffectVolume

(

local

volume)

void SetSoundEffectVolume

(

float

volume)

var SetSoundEffectVolume

(

var

volume)

local SetSoundEffectVolume

(

local

volume)

void Start

(

)

var Start

(

)

local Start

(

)

void Start

(

)

var Start

(

)

local Start

(

)

void StopAllSoundEffects

(

)

var StopAllSoundEffects

(

)

local StopAllSoundEffects

(

)

void StopAllSoundEffects

(

)

var StopAllSoundEffects

(

)

local StopAllSoundEffects

(

)

void StopBackgroundMusic

(

bool

bReleaseData)

var StopBackgroundMusic

(

var

bReleaseData)

local StopBackgroundMusic

(

local

bReleaseData)

void StopBackgroundMusic

(

bool

bReleaseData)

var StopBackgroundMusic

(

var

bReleaseData)

local StopBackgroundMusic

(

local

bReleaseData)

void StopSoundEffect

(

unsigned int

sound)

var StopSoundEffect

(

var

sound)

local StopSoundEffect

(

local

sound)

void StopSoundEffect

(

unsigned int

sound)

var StopSoundEffect

(

var

sound)

local StopSoundEffect

(

local

sound)

void UnloadSoundEffect

(

const char *

pszFilePath)

var UnloadSoundEffect

(

var

pszFilePath)

local UnloadSoundEffect

(

local

pszFilePath)

void UnloadSoundEffect

(

unsigned int

sound)

var UnloadSoundEffect

(

var

sound)

local UnloadSoundEffect

(

local

sound)

void UnloadSoundEffect

(

const char *

pszFilePath)

var UnloadSoundEffect

(

var

pszFilePath)

local UnloadSoundEffect

(

local

pszFilePath)

void UnloadSoundEffect

(

unsigned int

sound)

var UnloadSoundEffect

(

var

sound)

local UnloadSoundEffect

(

local

sound)

---

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

• /Users/cocos2d/MyWork/cocos2d-x-develop/cocos/audio/winrt/Audio.h
• /Users/cocos2d/MyWork/cocos2d-x-develop/cocos/audio/wp8/Audio.h