cAudio  2.3.0
3d Audio Engine
IAudioPlugin.h
1 // Copyright (c) 2008-2011 Raynaldo (Wildicv) Rivera, Joshua (Dark_Kilauea) Jones, Murat (wolfmanfx) Sari
2 // This file is part of the "cAudio Engine"
3 // For conditions of distribution and use, see copyright notice in cAudio.h
4 
5 #pragma once
6 
7 #include "IRefCounted.h"
8 #include "IAudioManager.h"
9 #include "IAudioCapture.h"
10 #include "ILogger.h"
11 
12 namespace cAudio
13 {
15  class IAudioPlugin : public IRefCounted
16  {
17  public:
18  IAudioPlugin() { }
19  ~IAudioPlugin() { }
20 
22 
25  virtual bool installPlugin(ILogger* logger) = 0;
26 
28 
30  virtual const char* getPluginName() = 0;
31 
33  virtual void uninstallPlugin() = 0;
34 
36 
38  virtual void onCreateAudioManager(IAudioManager* manager) { }
39 
41 
43  virtual void onCreateAudioCapture(IAudioCapture* capture) { }
44 
46 
48  virtual void onDestroyAudioManager(IAudioManager* manager) { }
49 
51 
53  virtual void onDestoryAudioCapture(IAudioCapture* capture) { }
54  };
55 };
cAudio::IAudioPlugin::installPlugin
virtual bool installPlugin(ILogger *logger)=0
Called to initialize the plugin. Use this for any initial setup that needs to be done.
cAudio::IRefCounted
Applies reference counting to certain cAudio objects.
Definition: IRefCounted.h:12
cAudio::IAudioPlugin
Interface for all plugins in cAudio.
Definition: IAudioPlugin.h:15
cAudio::IAudioCapture
Interface for capturing operations in the cAudio Engine.
Definition: IAudioCapture.h:17
cAudio::IAudioPlugin::onCreateAudioCapture
virtual void onCreateAudioCapture(IAudioCapture *capture)
Called on creation of an Audio Capture Manager.
Definition: IAudioPlugin.h:43
cAudio::IAudioPlugin::onDestroyAudioManager
virtual void onDestroyAudioManager(IAudioManager *manager)
Called on destruction of an Audio Playback Manager.
Definition: IAudioPlugin.h:48
cAudio
Main namespace for the entire cAudio library.
Definition: cAudioCapture.h:15
cAudio::ILogger
Interface for all logging operations in cAudio.
Definition: ILogger.h:13
cAudio::IAudioManager
Interface for the playback capabilities of cAudio.
Definition: IAudioManager.h:24
cAudio::IAudioPlugin::onCreateAudioManager
virtual void onCreateAudioManager(IAudioManager *manager)
Called on creation of an Audio Playback Manager.
Definition: IAudioPlugin.h:38
cAudio::IAudioPlugin::onDestoryAudioCapture
virtual void onDestoryAudioCapture(IAudioCapture *capture)
Called on destruction of an Audio Capture Manager.
Definition: IAudioPlugin.h:53
cAudio::IAudioPlugin::uninstallPlugin
virtual void uninstallPlugin()=0
Called to shutdown the plugin and do any final cleanup. This is the last function call cAudio will gi...
cAudio::IAudioPlugin::getPluginName
virtual const char * getPluginName()=0
Called to retrieve a name to register this plugin under if the user didn't specify one (or the plugin...