CLAM::AudioIn Class Reference

This class is the interface to an input of an AudioDevice. More...

#include <AudioIn.hxx>

Public Member Functions
bool	ConcreteConfigure (const ProcessingConfig &c)
	Configuration method interface.
const ProcessingConfig &	GetConfig () const
	Getter for the configuration of the class.
	AudioIn ()
	Default constructor for the class.
	AudioIn (const AudioIOConfig &c)
	Constructor of the class with an AudioIOConfig object constructed by the user as parameter.
	~AudioIn ()
	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 (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.
Public Attributes
AudioOutPort	mOutput
Protected Member Functions
bool	ConcreteStart (void)
	Processing objects have to redefine this method when starting them implies some internal changes.
Friends
class	AudioManager
class	AudioDevice

Detailed Description

This class is the interface to an input of an AudioDevice.

See also:: Processing, AudioIOConfig, AudioOut, AudioManager, AudioDevice

Definition at line 39 of file AudioIn.hxx.

Constructor & Destructor Documentation

CLAM::AudioIn::AudioIn ( ) [inline]

Default constructor for the class.

Sets the configuration to the default values, calling the base constructor of the AudioIOConfig object

Definition at line 63 of file AudioIn.hxx.

References CLAM::Processing::Configure().

CLAM::AudioIn::AudioIn ( const AudioIOConfig & c ) [inline]

Constructor of the class with an AudioIOConfig object constructed by the user as parameter.

Parameters:

c

The concrete AudioIOConfig that will be used for this construction

Definition at line 68 of file AudioIn.hxx.

References CLAM::Processing::Configure().

CLAM::AudioIn::~AudioIn ( ) [inline]

Destructor method of the class.

Definition at line 70 of file AudioIn.hxx.

References CLAM::AudioDevice::Unregister().

Member Function Documentation

bool CLAM::AudioIn::ConcreteConfigure ( const ProcessingConfig & c ) [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.

Returns:: true if the object has been configured correctly; true otherwise

Parameters:

The

related ProcessingConfig object

Reimplemented from CLAM::Processing.

Definition at line 37 of file AudioIn.cxx.

bool CLAM::AudioIn::ConcreteStart ( void ) [protected, virtual]

Processing objects have to redefine this method when starting them implies some internal changes.

ie: adquiring resources.

Returns:: Whether start changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 72 of file AudioIn.cxx.

bool CLAM::AudioIn::Do ( Audio & data ) [inline]

Non supervised mode of Do function.

The object reads the device attached for the appropiate channel and puts the output in the Audio data chunk passed by parameter

Parameters:

data

The Audio chunk where we want to put the data that object receives of Device

Returns:: true if the method has been executed correctly

Definition at line 82 of file AudioIn.hxx.

References CLAM::Processing::AbleToExecute(), and CLAM::AudioDevice::Read().

bool CLAM::AudioIn::Do ( void ) [virtual]

Supervised mode of Do method.

Calls the non-supervised method with the Audio data chunk attached before as the parameter where the data will be passed

Implements CLAM::Processing.

Definition at line 88 of file AudioIn.cxx.

int CLAM::AudioIn::GetChannelID ( ) const [inline]

Definition at line 95 of file AudioIn.hxx.

const char* CLAM::AudioIn::GetClassName ( ) const [inline, virtual]

Override it in every subclass and retur the name of that class.

Implements CLAM::Processing.

Definition at line 72 of file AudioIn.hxx.

const ProcessingConfig& CLAM::AudioIn::GetConfig ( ) const [inline, virtual]

Getter for the configuration of the class.

Returns:: The ProcessingConfig object attached to this Processing object

Reimplemented from CLAM::Processing.

Definition at line 59 of file AudioIn.hxx.

Referenced by CLAM::AudioDevice::Register().

void CLAM::AudioIn::GetDeviceInfo ( AudioDevice::TInfo & info ) const

Getter for the Info of Device Object attached to this AudioIn instantiation.

Parameters:

info

TInfo object that method will modify with the values of Tinfo internal object

Definition at line 80 of file AudioIn.cxx.

bool CLAM::AudioIn::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 99 of file AudioIn.hxx.

Friends And Related Function Documentation

friend class AudioDevice [friend]

Definition at line 42 of file AudioIn.hxx.

friend class AudioManager [friend]

Definition at line 41 of file AudioIn.hxx.

Member Data Documentation

AudioOutPort CLAM::AudioIn::mOutput

Definition at line 47 of file AudioIn.hxx.

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

CLAM::AudioIn Class Reference

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation