CLAM::AudioSink Class Reference

#include <AudioSink.hxx>

List of all members.

Classes
class	Config
struct	Port
Public Types
typedef std::vector< Port >	Ports
Public Member Functions
	AudioSink (const ProcessingConfig &config=Config())
	~AudioSink ()
void	SetFrameAndHopSize (const int val, unsigned index)
void	SetExternalBuffer (float *buf, unsigned nframes, unsigned index)
void	SetExternalBuffer (double *buf, unsigned nframes, unsigned index)
bool	Do ()
	Supervised mode execution method (using ports).
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	ConcreteConfigure (const ProcessingConfig &config)
	Configuration method interface.
Ports &	GetPorts ()

---

Detailed Description

Definition at line 11 of file AudioSink.hxx.

---

Member Typedef Documentation

typedef std::vector<Port> CLAM::AudioSink::Ports

Definition at line 32 of file AudioSink.hxx.

---

Constructor & Destructor Documentation

CLAM::AudioSink::AudioSink

(

const ProcessingConfig &

config = Config()

)

[inline]

Definition at line 63 of file AudioSink.hxx.

References CLAM::Processing::Configure().

CLAM::AudioSink::~AudioSink

(

)

[inline]

Definition at line 71 of file AudioSink.hxx.

---

Member Function Documentation

bool CLAM::AudioSink::ConcreteConfigure

(

const ProcessingConfig &

)

[inline, 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.

Parameters:

Reference

to the configuration object.

Returns:

false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)

true if the processing object is left in a consistent state, and can be executed.

Exceptions:

This

method must throw a bad_cast exception if the argument is not an object of the expected configuration class.

Reimplemented from CLAM::Processing.

Definition at line 98 of file AudioSink.hxx.

References CLAM::Processing::CopyAsConcreteConfig().

bool CLAM::AudioSink::Do

(

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 18 of file AudioSink.cxx.

const char* CLAM::AudioSink::GetClassName

(

)

const [inline, virtual]

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

Implements CLAM::Processing.

Definition at line 91 of file AudioSink.hxx.

const ProcessingConfig& CLAM::AudioSink::GetConfig

(

)

const [inline, virtual]

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:

Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Reimplemented from CLAM::Processing.

Definition at line 93 of file AudioSink.hxx.

Ports& CLAM::AudioSink::GetPorts

(

)

[inline]

Definition at line 108 of file AudioSink.hxx.

void CLAM::AudioSink::SetExternalBuffer	(	double *	buf,
		unsigned	nframes,
		unsigned	index
	)

Definition at line 52 of file AudioSink.cxx.

void CLAM::AudioSink::SetExternalBuffer	(	float *	buf,
		unsigned	nframes,
		unsigned	index
	)

Definition at line 40 of file AudioSink.cxx.

void CLAM::AudioSink::SetFrameAndHopSize	(	const int	val,
		unsigned	index
	)			[inline]

Deprecated:

Delegated to SetExternalBuffer

Definition at line 78 of file AudioSink.hxx.

References CLAM_ASSERT.

---

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

• AudioSink.hxx
• AudioSink.cxx