deAudioSystem Class Reference

Audio System. More...

#include <deAudioSystem.h>

Inheritance diagram for deAudioSystem:

Public Member Functions
Constructors and Destructors
	deAudioSystem (deEngine *engine)
	Create new audio system linked to the given engine. More...
virtual	~deAudioSystem ()
	Clean up audio system. More...
Management
deBaseAudioModule *	GetActiveModule () const
	Activated audio module. More...
deMicrophone *	GetActiveMicrophone () const
	Active microphone. More...
void	SetActiveMicrophone (deMicrophone *microphone)
	Set active microphone or NULL to unset it. More...
Runtime Functions
Run-Time functions can only be called if the audio system is running. Otherwise those functions cause an exception.
void	ProcessAudio ()
	Process audio. More...
void	LoadWorld (deWorld *world)
	Create peer object for the given world using the active module and assigns it. More...
void	LoadSound (deSound *sound)
	Create peer object for the given sound using the active module and assigns it. More...
void	LoadSpeaker (deSpeaker *speaker)
	Create peer object for the given speaker using the active module and assigns it. More...
void	LoadMicrophone (deMicrophone *microphone)
	Create peer object for the given microphone using the active module and assigns it. More...
void	LoadComponent (deComponent *component)
	Create peer object for the given component using the active module and assigns it. More...
void	LoadModel (deModel *model)
	Create peer object for the given model using the active module and assigns it. More...
void	LoadSkin (deSkin *skin)
	Create peer object for the given skin using the active module and assigns it. More...
void	LoadDecal (deDecal *decal)
	Create peer object for the given decal using the active module and assigns it. More...
void	LoadSoundLevelMeter (deSoundLevelMeter *meter)
	Create deSoundLevelMeter peer using active module and assigns it. More...
void	LoadVideoPlayer (deVideoPlayer *videoPlayer)
	Create peer for the video player using the active module and assigns it. More...
void	LoadSynthesizerInstance (deSynthesizerInstance *instance)
	Create peer for the synthesizer instance using the active module and assigns it. More...
void	LoadHeightTerrain (deHeightTerrain &heightTerrain)
	Create peer for the height terrain using the active module and assigns it. More...
Public Member Functions inherited from deBaseSystem
	deBaseSystem (deEngine *engine, const char *systemName, int requiredModuleType)
	Create new base system linked to the given engine. More...
virtual	~deBaseSystem ()
	Clean up base system. More...
deEngine *	GetEngine () const
	Linked game engine. More...
deLoadableModule *	GetActiveLoadableModule () const
	Active loadable module. More...
bool	GetIsRunning () const
	System is running. More...
bool	GetHasFailed () const
	System has failed during runtime. More...
const decString &	GetSystemName () const
	System name. More...
virtual bool	CanStart ()
void	SetHasFailed (bool hasFailed)
	Set if system has failed. More...
virtual void	Start ()
	Start system and the active loadable module. More...
virtual void	Stop ()
	Stop system and the active loadable module. More...
void	CheckAndActivateFirst (deModuleSystem::eModuleTypes type)
	Check if at least one module is working and select the first one. More...
void	LogInfo (const char *message)
	Output information message on the console. More...
void	LogInfoFormat (const char *message,...)
	Output formated information message on the console. More...
void	LogInfoFormatUsing (const char *message, va_list args)
	Output formated information message on the console. More...
void	LogWarn (const char *message)
	Output warning message on the console. More...
void	LogWarnFormat (const char *message,...)
	Output formated warning message on the console. More...
void	LogWarnFormatUsing (const char *message, va_list args)
	Output formated warning message on the console. More...
void	LogError (const char *message)
	Output error message on the console. More...
void	LogErrorFormat (const char *message,...)
	Output formated error message on the console. More...
void	LogErrorFormatUsing (const char *message, va_list args)
	Output formated error message on the console. More...
void	LogException (const deException &exception)
	Output exception as error message on the console. More...

Overloadables
virtual void	SetActiveModule (deLoadableModule *module)
	Set active loadable module. More...
virtual void	ClearPermanents ()
	Clearcross references and links that could lead to memory leaks. More...
virtual void	PostStart ()
	Carry out here actions right after the system started up. More...
virtual void	PreStop ()
	Carry out here actions right before the system shuts down. More...

Detailed Description

Audio System.

The Audio System is a single type system providing the output functions of the engine in the audio direction.

Constructor & Destructor Documentation

deAudioSystem()

deAudioSystem::deAudioSystem

(

deEngine *

engine

)

Create new audio system linked to the given engine.

~deAudioSystem()

virtual deAudioSystem::~deAudioSystem ( )

virtual

Clean up audio system.

Member Function Documentation

ClearPermanents()

virtual void deAudioSystem::ClearPermanents ( )

virtual

Clearcross references and links that could lead to memory leaks.

Do not forget to call the super function.

Reimplemented from deBaseSystem.

GetActiveMicrophone()

deMicrophone* deAudioSystem::GetActiveMicrophone ( ) const

inline

Active microphone.

GetActiveModule()

deBaseAudioModule* deAudioSystem::GetActiveModule ( ) const

inline

Activated audio module.

LoadComponent()

void deAudioSystem::LoadComponent

(

deComponent *

component

)

Create peer object for the given component using the active module and assigns it.

LoadDecal()

void deAudioSystem::LoadDecal

(

deDecal *

decal

)

Create peer object for the given decal using the active module and assigns it.

LoadHeightTerrain()

void deAudioSystem::LoadHeightTerrain

(

deHeightTerrain &

heightTerrain

)

Create peer for the height terrain using the active module and assigns it.

LoadMicrophone()

void deAudioSystem::LoadMicrophone

(

deMicrophone *

microphone

)

Create peer object for the given microphone using the active module and assigns it.

LoadModel()

void deAudioSystem::LoadModel

(

deModel *

model

)

Create peer object for the given model using the active module and assigns it.

LoadSkin()

void deAudioSystem::LoadSkin

(

deSkin *

skin

)

Create peer object for the given skin using the active module and assigns it.

LoadSound()

void deAudioSystem::LoadSound

(

deSound *

sound

)

Create peer object for the given sound using the active module and assigns it.

LoadSoundLevelMeter()

void deAudioSystem::LoadSoundLevelMeter

(

deSoundLevelMeter *

meter

)

Create deSoundLevelMeter peer using active module and assigns it.

LoadSpeaker()

void deAudioSystem::LoadSpeaker

(

deSpeaker *

speaker

)

Create peer object for the given speaker using the active module and assigns it.

LoadSynthesizerInstance()

void deAudioSystem::LoadSynthesizerInstance

(

deSynthesizerInstance *

instance

)

Create peer for the synthesizer instance using the active module and assigns it.

LoadVideoPlayer()

void deAudioSystem::LoadVideoPlayer

(

deVideoPlayer *

videoPlayer

)

Create peer for the video player using the active module and assigns it.

LoadWorld()

void deAudioSystem::LoadWorld

(

deWorld *

world

)

Create peer object for the given world using the active module and assigns it.

PostStart()

virtual void deAudioSystem::PostStart ( )

virtual

Carry out here actions right after the system started up.

Reimplemented from deBaseSystem.

PreStop()

virtual void deAudioSystem::PreStop ( )

virtual

Carry out here actions right before the system shuts down.

Reimplemented from deBaseSystem.

ProcessAudio()

void deAudioSystem::ProcessAudio

(

)

Process audio.

SetActiveMicrophone()

void deAudioSystem::SetActiveMicrophone

(

deMicrophone *

microphone

)

Set active microphone or NULL to unset it.

SetActiveModule()

virtual void deAudioSystem::SetActiveModule ( deLoadableModule *  module )

virtual

Set active loadable module.

Do not forget to call the super function.

Reimplemented from deBaseSystem.

---

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

• deAudioSystem.h