CLAM::AudioBufferSink Class Reference

#include <AudioBufferSink.hxx>

List of all members.

Classes
class	Config
struct	Port
Public Types
typedef std::vector< Port >	Ports
Public Member Functions
	AudioBufferSink (const ProcessingConfig &config=Config())
	~AudioBufferSink ()
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).
virtual bool	SupportsVariableAudioSize () const
	This method reports whether the processing supports dynamic buffer-size host.
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 12 of file AudioBufferSink.hxx.

---

Member Typedef Documentation

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

Definition at line 34 of file AudioBufferSink.hxx.

---

Constructor & Destructor Documentation

CLAM::AudioBufferSink::AudioBufferSink

(

const ProcessingConfig &

config = Config()

)

[inline]

Definition at line 65 of file AudioBufferSink.hxx.

References CLAM::Processing::Configure().

CLAM::AudioBufferSink::~AudioBufferSink

(

)

[inline]

Definition at line 73 of file AudioBufferSink.hxx.

---

Member Function Documentation

bool CLAM::AudioBufferSink::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 102 of file AudioBufferSink.hxx.

References CLAM::Processing::CopyAsConcreteConfig().

bool CLAM::AudioBufferSink::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 AudioBufferSink.cxx.

const char* CLAM::AudioBufferSink::GetClassName

(

)

const [inline, virtual]

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

Implements CLAM::Processing.

Definition at line 95 of file AudioBufferSink.hxx.

const ProcessingConfig& CLAM::AudioBufferSink::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 97 of file AudioBufferSink.hxx.

Ports& CLAM::AudioBufferSink::GetPorts

(

)

[inline]

Definition at line 112 of file AudioBufferSink.hxx.

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

Definition at line 53 of file AudioBufferSink.cxx.

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

Definition at line 41 of file AudioBufferSink.cxx.

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

Deprecated:

Delegated to SetExternalBuffer

Definition at line 80 of file AudioBufferSink.hxx.

References CLAM_ASSERT.

virtual bool CLAM::AudioBufferSink::SupportsVariableAudioSize

(

)

const [inline, virtual]

This method reports whether the processing supports dynamic buffer-size host.

Reimplemented from CLAM::Processing.

Definition at line 93 of file AudioBufferSink.hxx.

---

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

• AudioBufferSink.hxx
• AudioBufferSink.cxx