Drag[en]gine Game Engine  1.0
deBaseAudioModule Class Referenceabstract

Base audio module. More...

#include <deBaseAudioModule.h>

Inheritance diagram for deBaseAudioModule:
deBaseModule

Public Member Functions

Constructors and Destructors
 deBaseAudioModule (deLoadableModule &loadableModule)
 Create module. More...
 
virtual ~deBaseAudioModule ()
 Clean up module. More...
 
Module Management
virtual bool Init (deMicrophone *activeMic)=0
 Init module and prepare for audio processing. More...
 
virtual void CleanUp ()=0
 Clean up module. More...
 
virtual void ProcessAudio ()=0
 Process audio. More...
 
virtual void SetActiveMicrophone (deMicrophone *microphone)=0
 Set active microphone or NULL. More...
 
Audio Management
virtual deBaseAudioWorldCreateWorld (deWorld *world)=0
 Creat peer for world. More...
 
virtual deBaseAudioSoundCreateSound (deSound *sound)=0
 Create peer for sound. More...
 
virtual deBaseAudioSpeakerCreateSpeaker (deSpeaker *speaker)=0
 Create peer for speaker. More...
 
virtual deBaseAudioMicrophoneCreateMicrophone (deMicrophone *microphone)=0
 Create peer for microphone. More...
 
virtual deBaseAudioComponentCreateComponent (deComponent *component)=0
 Create peer for component. More...
 
virtual deBaseAudioSkinCreateSkin (deSkin *skin)=0
 Create peer for skin. More...
 
virtual deBaseAudioModelCreateModel (deModel *model)=0
 Create peer for model. More...
 
virtual deBaseAudioDecalCreateDecal (deDecal *decal)=0
 Create peer for decal. More...
 
- Public Member Functions inherited from deBaseModule
 deBaseModule (deLoadableModule &loadableModule)
 Creates a new base module. More...
 
virtual ~deBaseModule ()
 Cleans up the base module. More...
 
virtual int GetParameterCount () const
 Retrieves the count of parameters. More...
 
virtual void GetParameterInfo (int index, deModuleParameter *parameter) const
 Retrieves the informations about the given indexec parameter. More...
 
virtual int FindParameter (const char *name) const
 Retrieves the index of the parameter with the given name or -1 if not found. More...
 
virtual float GetParameterValue (int index) const
 Retrieves the value of the parameter at the given index. More...
 
virtual void SetParameterValue (int index, float value)
 Sets the parameter of the parameter at the given index. More...
 
virtual void SendCommand (const decUnicodeArgumentList &command, decUnicodeString &answer)
 Sends a command to the module and retrieves an answer from it. More...
 
void LogInfo (const char *message)
 Outputs an information message on the console. More...
 
void LogInfoFormat (const char *message,...)
 Outputs a formated information message on the console. More...
 
void LogInfoFormatUsing (const char *message, va_list args)
 Outputs a formated information message on the console. More...
 
void LogWarn (const char *message)
 Outputs a warning message on the console. More...
 
void LogWarnFormat (const char *message,...)
 Outputs a formated warning message on the console. More...
 
void LogWarnFormatUsing (const char *message, va_list args)
 Outputs a formated warning message on the console. More...
 
void LogError (const char *message)
 Outputs an error message on the console. More...
 
void LogErrorFormat (const char *message,...)
 Outputs a formated error message on the console. More...
 
void LogErrorFormatUsing (const char *message, va_list args)
 Outputs a formated error message on the console. More...
 
void LogException (const deException &exception)
 Outputs an exception as error message on the console. More...
 
deEngineGetGameEngine () const
 Retrieves the game engine object. More...
 
deLoadableModuleGetLoadableModule () const
 Retrieves the loadable module. More...
 
deOSGetOS () const
 Retrieves the os object from the game engine. More...
 
deVirtualFileSystemGetVFS () const
 Retrieves the module virtual file system. More...
 
deErrorTracePointSetErrorTrace (const char *error, const char *sourceFunc, int sourceLine)
 Adds a new trace point and sets the error if the trace is empty. More...
 
deErrorTracePointSetErrorTrace (const deException &exception)
 Adds a new trace point and sets the error if the trace is empty. More...
 
deErrorTracePointAddErrorTracePoint (const char *sourceFunc, int sourceLine)
 Adds a new trace point to the engine error trace with an empty error. More...
 

Detailed Description

Base audio module.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Constructor & Destructor Documentation

◆ deBaseAudioModule()

deBaseAudioModule::deBaseAudioModule ( deLoadableModule loadableModule)

Create module.

◆ ~deBaseAudioModule()

virtual deBaseAudioModule::~deBaseAudioModule ( )
virtual

Clean up module.

Member Function Documentation

◆ CleanUp()

virtual void deBaseAudioModule::CleanUp ( )
pure virtual

Clean up module.

All resources have to be freed and running threads stopped or killed if needed.

◆ CreateComponent()

virtual deBaseAudioComponent* deBaseAudioModule::CreateComponent ( deComponent component)
pure virtual

Create peer for component.

◆ CreateDecal()

virtual deBaseAudioDecal* deBaseAudioModule::CreateDecal ( deDecal decal)
pure virtual

Create peer for decal.

◆ CreateMicrophone()

virtual deBaseAudioMicrophone* deBaseAudioModule::CreateMicrophone ( deMicrophone microphone)
pure virtual

Create peer for microphone.

◆ CreateModel()

virtual deBaseAudioModel* deBaseAudioModule::CreateModel ( deModel model)
pure virtual

Create peer for model.

◆ CreateSkin()

virtual deBaseAudioSkin* deBaseAudioModule::CreateSkin ( deSkin skin)
pure virtual

Create peer for skin.

◆ CreateSound()

virtual deBaseAudioSound* deBaseAudioModule::CreateSound ( deSound sound)
pure virtual

Create peer for sound.

◆ CreateSpeaker()

virtual deBaseAudioSpeaker* deBaseAudioModule::CreateSpeaker ( deSpeaker speaker)
pure virtual

Create peer for speaker.

◆ CreateWorld()

virtual deBaseAudioWorld* deBaseAudioModule::CreateWorld ( deWorld world)
pure virtual

Creat peer for world.

◆ Init()

virtual bool deBaseAudioModule::Init ( deMicrophone activeMic)
pure virtual

Init module and prepare for audio processing.

Parameters
[in]activeMicInitial active microphone or NULL.
Note
To access the os of the engine use the GetOS function.
Returns
true on success or false on failure.

◆ ProcessAudio()

virtual void deBaseAudioModule::ProcessAudio ( )
pure virtual

Process audio.

◆ SetActiveMicrophone()

virtual void deBaseAudioModule::SetActiveMicrophone ( deMicrophone microphone)
pure virtual

Set active microphone or NULL.


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