Base Audio Module. More...
#include <deBaseAudioModule.h>
Public Member Functions | |
Constructors and Destructors | |
| deBaseAudioModule (deLoadableModule *loadableModule) | |
| Creates a new module. | |
| virtual | ~deBaseAudioModule () |
| Cleans up the module. | |
Module Management | |
| virtual bool | Init (deMicrophone *activeMic)=0 |
| Called to init the module and prepare it for audio. | |
| virtual void | CleanUp ()=0 |
| Called to cleanup the module. | |
| virtual void | ProcessAudio ()=0 |
| Process audio. | |
| virtual void | SetActiveMicrophone (deMicrophone *microphone)=0 |
| Sets the active microphone. | |
Audio Management | |
| virtual deBaseAudioWorld * | CreateWorld (deWorld *world)=0 |
| Ccreat a peer for the given world. | |
| virtual deBaseAudioSound * | CreateSound (deSound *sound)=0 |
| Ccreat a peer for the given sound. | |
| virtual deBaseAudioSpeaker * | CreateSpeaker (deSpeaker *speaker)=0 |
| Ccreat a peer for the given speaker. | |
| virtual deBaseAudioMicrophone * | CreateMicrophone (deMicrophone *microphone)=0 |
| Ccreat a peer for the given microphone. | |
| virtual deBaseAudioComponent * | CreateComponent (deComponent *component)=0 |
| Ccreat a peer for the given component. | |
| virtual deBaseAudioSkin * | CreateSkin (deSkin *skin)=0 |
| Ccreat a peer for the given skin. | |
| virtual deBaseAudioModel * | CreateModel (deModel *model)=0 |
| Ccreat a peer for the given model. | |
| virtual deBaseAudioDecal * | CreateDecal (deDecal *decal)=0 |
| Ccreat a peer for the given decal. | |
Notifications | |
| virtual void | TexturePropertyMapChanged () |
| Texture property map changed. | |
Detailed Description
Base Audio Module.
- Version:
- 1.0
- Date:
- 2008
Constructor & Destructor Documentation
| deBaseAudioModule::deBaseAudioModule | ( | deLoadableModule * | loadableModule ) |
Creates a new module.
| virtual deBaseAudioModule::~deBaseAudioModule | ( | ) | [virtual] |
Cleans up the module.
Member Function Documentation
| virtual void deBaseAudioModule::CleanUp | ( | ) | [pure virtual] |
Called to cleanup the module.
All resources have to be freed and running threads stopped or killed if needed.
| virtual deBaseAudioComponent* deBaseAudioModule::CreateComponent | ( | deComponent * | component ) | [pure virtual] |
Ccreat a peer for the given component.
| virtual deBaseAudioDecal* deBaseAudioModule::CreateDecal | ( | deDecal * | decal ) | [pure virtual] |
Ccreat a peer for the given decal.
| virtual deBaseAudioMicrophone* deBaseAudioModule::CreateMicrophone | ( | deMicrophone * | microphone ) | [pure virtual] |
Ccreat a peer for the given microphone.
| virtual deBaseAudioModel* deBaseAudioModule::CreateModel | ( | deModel * | model ) | [pure virtual] |
Ccreat a peer for the given model.
| virtual deBaseAudioSkin* deBaseAudioModule::CreateSkin | ( | deSkin * | skin ) | [pure virtual] |
Ccreat a peer for the given skin.
| virtual deBaseAudioSound* deBaseAudioModule::CreateSound | ( | deSound * | sound ) | [pure virtual] |
Ccreat a peer for the given sound.
| virtual deBaseAudioSpeaker* deBaseAudioModule::CreateSpeaker | ( | deSpeaker * | speaker ) | [pure virtual] |
Ccreat a peer for the given speaker.
| virtual deBaseAudioWorld* deBaseAudioModule::CreateWorld | ( | deWorld * | world ) | [pure virtual] |
Ccreat a peer for the given world.
| virtual bool deBaseAudioModule::Init | ( | deMicrophone * | activeMic ) | [pure virtual] |
Called to init the module and prepare it for audio.
Returns true on success. To access the os of the engine use the GetOS function. The active microphone is passed as parameter and can be NULL if no microphone is active yet.
| virtual void deBaseAudioModule::ProcessAudio | ( | ) | [pure virtual] |
Process audio.
| virtual void deBaseAudioModule::SetActiveMicrophone | ( | deMicrophone * | microphone ) | [pure virtual] |
Sets the active microphone.
Can be NULL to unset the active microphone.
| virtual void deBaseAudioModule::TexturePropertyMapChanged | ( | ) | [virtual] |
Texture property map changed.
The documentation for this class was generated from the following file:
