Drag[en]gine Game Engine  1.0
deAudioSystem Class Reference

Audio System. More...

#include <deAudioSystem.h>

Inheritance diagram for deAudioSystem:
deBaseSystem

Public Member Functions

Constructors and Destructors
 deAudioSystem (deEngine *engine)
 
virtual ~deAudioSystem ()
 
Management
deBaseAudioModuleGetActiveModule () const
 
deMicrophoneGetActiveMicrophone () const
 
void SetActiveMicrophone (deMicrophone *microphone)
 
Runtime Functions

Run-Time functions can only be called if the audio system is running. Otherwise those functions cause an exception.

void ProcessAudio ()
 
void LoadWorld (deWorld *world)
 
void LoadSound (deSound *sound)
 
void LoadSpeaker (deSpeaker *speaker)
 
void LoadMicrophone (deMicrophone *microphone)
 
void LoadComponent (deComponent *component)
 
void LoadModel (deModel *model)
 
void LoadSkin (deSkin *skin)
 
void LoadDecal (deDecal *decal)
 
Overloadables
virtual void SetActiveModule (deLoadableModule *module)
 
virtual void ClearPermanents ()
 
virtual void PostStart ()
 
virtual void PreStop ()
 
- Public Member Functions inherited from deBaseSystem
 deBaseSystem (deEngine *engine, const char *systemName, int requiredModuleType)
 
virtual ~deBaseSystem ()
 
deEngineGetEngine () const
 
deLoadableModuleGetActiveLoadableModule () const
 
bool GetIsRunning () const
 
bool GetHasFailed () const
 
const char * GetSystemName () const
 
virtual bool CanStart ()
 
void SetHasFailed (bool hasFailed)
 
virtual void Start ()
 
virtual void Stop ()
 
void CheckAndActivateFirst (deModuleSystem::eModuleTypes type)
 
void LogInfo (const char *message)
 
void LogInfoFormat (const char *message,...)
 
void LogInfoFormatUsing (const char *message, va_list args)
 
void LogWarn (const char *message)
 
void LogWarnFormat (const char *message,...)
 
void LogWarnFormatUsing (const char *message, va_list args)
 
void LogError (const char *message)
 
void LogErrorFormat (const char *message,...)
 
void LogErrorFormatUsing (const char *message, va_list args)
 
void LogException (const deException &exception)
 

Detailed Description

Audio System.

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

Author
Pl├╝ss Roland
Version
1.0
Date
2008

Constructor & Destructor Documentation

◆ deAudioSystem()

deAudioSystem::deAudioSystem ( deEngine engine)

Creates a new audio system linked to the given engine.

◆ ~deAudioSystem()

virtual deAudioSystem::~deAudioSystem ( )
virtual

Cleans up the audio system.

Member Function Documentation

◆ ClearPermanents()

virtual void deAudioSystem::ClearPermanents ( )
virtual

Clears cross references and links that could lead to memory leaks. Do not forget to call the super function.

Reimplemented from deBaseSystem.

Referenced by GetActiveMicrophone().

◆ GetActiveMicrophone()

◆ GetActiveModule()

deBaseAudioModule* deAudioSystem::GetActiveModule ( ) const
inline

Retrieves the activated audio module.

◆ LoadComponent()

void deAudioSystem::LoadComponent ( deComponent component)

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

Referenced by GetActiveMicrophone().

◆ LoadDecal()

void deAudioSystem::LoadDecal ( deDecal decal)

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

Referenced by GetActiveMicrophone().

◆ LoadMicrophone()

void deAudioSystem::LoadMicrophone ( deMicrophone microphone)

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

Referenced by GetActiveMicrophone().

◆ LoadModel()

void deAudioSystem::LoadModel ( deModel model)

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

Referenced by GetActiveMicrophone().

◆ LoadSkin()

void deAudioSystem::LoadSkin ( deSkin skin)

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

Referenced by GetActiveMicrophone().

◆ LoadSound()

void deAudioSystem::LoadSound ( deSound sound)

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

Referenced by GetActiveMicrophone().

◆ LoadSpeaker()

void deAudioSystem::LoadSpeaker ( deSpeaker speaker)

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

Referenced by GetActiveMicrophone().

◆ LoadWorld()

void deAudioSystem::LoadWorld ( deWorld world)

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

Referenced by GetActiveMicrophone().

◆ PostStart()

virtual void deAudioSystem::PostStart ( )
virtual

Carry out here actions right after the system started up.

Reimplemented from deBaseSystem.

Referenced by GetActiveMicrophone().

◆ PreStop()

virtual void deAudioSystem::PreStop ( )
virtual

Carry out here actions right before the system shuts down.

Reimplemented from deBaseSystem.

Referenced by GetActiveMicrophone().

◆ ProcessAudio()

void deAudioSystem::ProcessAudio ( )

Process audio.

Referenced by GetActiveMicrophone().

◆ SetActiveMicrophone()

void deAudioSystem::SetActiveMicrophone ( deMicrophone microphone)

Sets the active microphone or NULL to unset it.

Referenced by GetActiveMicrophone().

◆ SetActiveModule()

virtual void deAudioSystem::SetActiveModule ( deLoadableModule module)
virtual

Sets the active loadable module. Do not forget to call the super function.

Reimplemented from deBaseSystem.

Referenced by GetActiveMicrophone().


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