CDAudioManager.h File Reference

#import "CocosDenshion.h"
#import "CDXMacOSXSupport.h"

Classes
class	CDAsynchInitialiser
protocol	<CDLongAudioSourceDelegate>
class	CDLongAudioSource
	CDLongAudioSource represents an audio source that has a long duration which makes it costly to load into memory for playback as an effect using CDSoundEngine. More...
class	CDAudioManager
	CDAudioManager manages audio requirements for a game. More...
class	CDLongAudioSourceFader
	Fader for long audio source objects. More...
class	CDBufferManager
	Allows buffers to be associated with file names. More...

Enumerations
enum	tAudioManagerMode {   kAMM_FxOnly, kAMM_FxPlusMusic, kAMM_FxPlusMusicIfNoOtherAudio, kAMM_MediaPlayback,   kAMM_PlayAndRecord, kAMM_FxOnly, kAMM_FxPlusMusic, kAMM_FxPlusMusicIfNoOtherAudio,   kAMM_MediaPlayback, kAMM_PlayAndRecord }
	Different modes of the engine. More...
enum	tAudioManagerState {   kAMStateUninitialised, kAMStateInitialising, kAMStateInitialised, kAMStateUninitialised,   kAMStateInitialising, kAMStateInitialised }
	Possible states of the engine. More...
enum	tAudioManagerResignBehavior {   kAMRBDoNothing, kAMRBStopPlay, kAMRBStop, kAMRBDoNothing,   kAMRBStopPlay, kAMRBStop }
enum	tAudioSourceChannel { kASC_Left = 0, kASC_Right = 1, kASC_Left = 0, kASC_Right = 1 }
	CDAudioManager supports two long audio source channels called left and right. More...
enum	tLongAudioSourceState {   kLAS_Init, kLAS_Loaded, kLAS_Playing, kLAS_Paused,   kLAS_Stopped, kLAS_Init, kLAS_Loaded, kLAS_Playing,   kLAS_Paused, kLAS_Stopped }

Variables
NSString *const	kCDN_AudioManagerInitialised
	Notifications. More...
var	kCDN_AudioManagerInitialised
	Notifications. More...
local	kCDN_AudioManagerInitialised
	Notifications. More...

Enumeration Type Documentation

enum tAudioManagerMode

Different modes of the engine.

Enumerator
kAMM_FxOnly
kAMM_FxPlusMusic	Other apps will be able to play audio.
kAMM_FxPlusMusicIfNoOtherAudio	Only this app will play audio.
kAMM_MediaPlayback	If another app is playing audio at start up then allow it to continue and don't play music.
kAMM_PlayAndRecord	This app takes over audio e.g music player app. App takes over audio and has input and output
kAMM_FxOnly
kAMM_FxPlusMusic	Other apps will be able to play audio.
kAMM_FxPlusMusicIfNoOtherAudio	Only this app will play audio.
kAMM_MediaPlayback	If another app is playing audio at start up then allow it to continue and don't play music.
kAMM_PlayAndRecord	This app takes over audio e.g music player app. App takes over audio and has input and output

var tAudioManagerMode

Different modes of the engine.

Enumerator
kAMM_FxOnly
kAMM_FxPlusMusic	Other apps will be able to play audio.
kAMM_FxPlusMusicIfNoOtherAudio	Only this app will play audio.
kAMM_MediaPlayback	If another app is playing audio at start up then allow it to continue and don't play music.
kAMM_PlayAndRecord	This app takes over audio e.g music player app. App takes over audio and has input and output
kAMM_FxOnly
kAMM_FxPlusMusic	Other apps will be able to play audio.
kAMM_FxPlusMusicIfNoOtherAudio	Only this app will play audio.
kAMM_MediaPlayback	If another app is playing audio at start up then allow it to continue and don't play music.
kAMM_PlayAndRecord	This app takes over audio e.g music player app. App takes over audio and has input and output

local tAudioManagerMode

Different modes of the engine.

Enumerator
kAMM_FxOnly
kAMM_FxPlusMusic	Other apps will be able to play audio.
kAMM_FxPlusMusicIfNoOtherAudio	Only this app will play audio.
kAMM_MediaPlayback	If another app is playing audio at start up then allow it to continue and don't play music.
kAMM_PlayAndRecord	This app takes over audio e.g music player app. App takes over audio and has input and output
kAMM_FxOnly
kAMM_FxPlusMusic	Other apps will be able to play audio.
kAMM_FxPlusMusicIfNoOtherAudio	Only this app will play audio.
kAMM_MediaPlayback	If another app is playing audio at start up then allow it to continue and don't play music.
kAMM_PlayAndRecord	This app takes over audio e.g music player app. App takes over audio and has input and output

enum tAudioManagerResignBehavior

Enumerator
kAMRBDoNothing
kAMRBStopPlay
kAMRBStop
kAMRBDoNothing
kAMRBStopPlay
kAMRBStop

var tAudioManagerResignBehavior

Enumerator
kAMRBDoNothing
kAMRBStopPlay
kAMRBStop
kAMRBDoNothing
kAMRBStopPlay
kAMRBStop

local tAudioManagerResignBehavior

Enumerator
kAMRBDoNothing
kAMRBStopPlay
kAMRBStop
kAMRBDoNothing
kAMRBStopPlay
kAMRBStop

enum tAudioManagerState

Possible states of the engine.

Enumerator
kAMStateUninitialised
kAMStateInitialising	Audio manager has not been initialised - do not use.
kAMStateInitialised	Audio manager is in the process of initialising - do not use. Audio manager is initialised - safe to use
kAMStateUninitialised
kAMStateInitialising	Audio manager has not been initialised - do not use.
kAMStateInitialised	Audio manager is in the process of initialising - do not use. Audio manager is initialised - safe to use

var tAudioManagerState

Possible states of the engine.

Enumerator
kAMStateUninitialised
kAMStateInitialising	Audio manager has not been initialised - do not use.
kAMStateInitialised	Audio manager is in the process of initialising - do not use. Audio manager is initialised - safe to use
kAMStateUninitialised
kAMStateInitialising	Audio manager has not been initialised - do not use.
kAMStateInitialised	Audio manager is in the process of initialising - do not use. Audio manager is initialised - safe to use

local tAudioManagerState

Possible states of the engine.

Enumerator
kAMStateUninitialised
kAMStateInitialising	Audio manager has not been initialised - do not use.
kAMStateInitialised	Audio manager is in the process of initialising - do not use. Audio manager is initialised - safe to use
kAMStateUninitialised
kAMStateInitialising	Audio manager has not been initialised - do not use.
kAMStateInitialised	Audio manager is in the process of initialising - do not use. Audio manager is initialised - safe to use

enum tAudioSourceChannel

CDAudioManager supports two long audio source channels called left and right.

Enumerator
kASC_Left
kASC_Right
kASC_Left
kASC_Right

var tAudioSourceChannel

CDAudioManager supports two long audio source channels called left and right.

Enumerator
kASC_Left
kASC_Right
kASC_Left
kASC_Right

local tAudioSourceChannel

CDAudioManager supports two long audio source channels called left and right.

Enumerator
kASC_Left
kASC_Right
kASC_Left
kASC_Right

enum tLongAudioSourceState

Enumerator
kLAS_Init
kLAS_Loaded
kLAS_Playing
kLAS_Paused
kLAS_Stopped
kLAS_Init
kLAS_Loaded
kLAS_Playing
kLAS_Paused
kLAS_Stopped

var tLongAudioSourceState

Enumerator
kLAS_Init
kLAS_Loaded
kLAS_Playing
kLAS_Paused
kLAS_Stopped
kLAS_Init
kLAS_Loaded
kLAS_Playing
kLAS_Paused
kLAS_Stopped

local tLongAudioSourceState

Enumerator
kLAS_Init
kLAS_Loaded
kLAS_Playing
kLAS_Paused
kLAS_Stopped
kLAS_Init
kLAS_Loaded
kLAS_Playing
kLAS_Paused
kLAS_Stopped

Variable Documentation

NSString* const kCDN_AudioManagerInitialised

Notifications.

var kCDN_AudioManagerInitialised

Notifications.

local kCDN_AudioManagerInitialised

Notifications.