This class is the interface to an output of an AudioDevice. More...
#include <AudioOut.hxx>
Public Member Functions | |
| bool | ConcreteConfigure (const ProcessingConfig &c) throw (ErrProcessingObj) |
| Configuration method interface. | |
| const ProcessingConfig & | GetConfig () const |
| Getter for the configuration of the class. | |
| AudioOut () | |
| Default constructor for the class. | |
| AudioOut (const AudioIOConfig &cfg) | |
| Constructor of the class with an AudioIOConfig object constructed by the user as parameter. | |
| ~AudioOut () | |
| Destructor method of the class. | |
| const char * | GetClassName () const |
| Override it in every subclass and retur the name of that class. | |
| bool | Do (void) |
| Supervised mode of Do method. | |
| bool | Do (const Audio &data) |
| Non supervised mode of Do function. | |
| void | GetDeviceInfo (AudioDevice::TInfo &) const |
| Getter for the Info of Device Object attached to this AudioIn instantiation. | |
| int | GetChannelID () const |
| bool | IsSyncSource () const |
| Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e. | |
Protected Member Functions | |
| bool | ConcreteStart () |
| Processing objects have to redefine this method when starting them implies some internal changes. | |
| bool | ConcreteStop () |
| Processing objects have to redefine this method when stoping them implies some internal changes. | |
Friends | |
| class | AudioManager |
| class | AudioDevice |
This class is the interface to an output of an AudioDevice.
Definition at line 37 of file AudioOut.hxx.
| CLAM::AudioOut::AudioOut | ( | ) |
Default constructor for the class.
Sets the configuration to the default values, calling the base constructor of the AudioIOConfig object
Definition at line 36 of file AudioOut.cxx.
| CLAM::AudioOut::AudioOut | ( | const AudioIOConfig & | cfg | ) |
Constructor of the class with an AudioIOConfig object constructed by the user as parameter.
| c | The concrete AudioIOConfig that will be used for this construction |
Definition at line 43 of file AudioOut.cxx.
| CLAM::AudioOut::~AudioOut | ( | ) |
Destructor method of the class.
Definition at line 50 of file AudioOut.cxx.
| bool CLAM::AudioOut::ConcreteConfigure | ( | const ProcessingConfig & | c | ) | throw (ErrProcessingObj) [virtual] |
Configuration method interface.
The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks. Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.
| The | related ProcessingConfig object |
| A | bad_cast exception if the arguments is not the expected configuration class |
Reimplemented from CLAM::Processing.
Definition at line 61 of file AudioOut.cxx.
| bool CLAM::AudioOut::ConcreteStart | ( | void | ) | [protected, virtual] |
Processing objects have to redefine this method when starting them implies some internal changes.
ie: adquiring resources.
Reimplemented from CLAM::Processing.
Definition at line 97 of file AudioOut.cxx.
| bool CLAM::AudioOut::ConcreteStop | ( | ) | [protected, virtual] |
Processing objects have to redefine this method when stoping them implies some internal changes.
ie: releasing resources.
Reimplemented from CLAM::Processing.
Definition at line 112 of file AudioOut.cxx.
| bool CLAM::AudioOut::Do | ( | const Audio & | data | ) | [inline] |
Non supervised mode of Do function.
The object writes in the device attached for the appropiate channel. Values selected to write are provided for the data chunk passed by parameter. On current implementations Do() will return immediately when not all output channels of the device has been 'filled' yet. If this is last channel to be 'filled', Do() will block, until the device is ready to receive more data. The size of the data chunk passed has restrictions which are dependent on the implementation. Most will require the size to be a power-of-two somewhere in the region of 32 samples to 8192 samples.
| data | The Audio chunk that we want to pass to the selected Device |
Definition at line 92 of file AudioOut.hxx.
References CLAM::Processing::AbleToExecute(), and CLAM::AudioDevice::Write().
| bool CLAM::AudioOut::Do | ( | void | ) | [virtual] |
Supervised mode of Do method.
Calls the non-supervised method with the Audio data chunk attached before as the parameter where data will be written
Implements CLAM::Processing.
Definition at line 126 of file AudioOut.cxx.
| int CLAM::AudioOut::GetChannelID | ( | ) | const [inline] |
Definition at line 105 of file AudioOut.hxx.
| const char* CLAM::AudioOut::GetClassName | ( | ) | const [inline, virtual] |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 76 of file AudioOut.hxx.
| const ProcessingConfig& CLAM::AudioOut::GetConfig | ( | ) | const [inline, virtual] |
Getter for the configuration of the class.
Reimplemented from CLAM::Processing.
Definition at line 60 of file AudioOut.hxx.
Referenced by CLAM::AudioDevice::Register().
| void CLAM::AudioOut::GetDeviceInfo | ( | AudioDevice::TInfo & | info | ) | const |
Getter for the Info of Device Object attached to this AudioIn instantiation.
| info | TInfo object that method will modify with the values of Tinfo internal object |
Definition at line 118 of file AudioOut.cxx.
References CLAM::AudioDevice::Stop().
| bool CLAM::AudioOut::IsSyncSource | ( | ) | const [inline, virtual] |
Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e.
Externalizer)
Reimplemented from CLAM::Processing.
Definition at line 109 of file AudioOut.hxx.
friend class AudioDevice [friend] |
Definition at line 40 of file AudioOut.hxx.
friend class AudioManager [friend] |
Definition at line 39 of file AudioOut.hxx.
1.6.3