CLAM::AudioBufferSource Class Reference

#include <AudioBufferSource.hxx>

List of all members.

Classes
class	Config
struct	Port
Public Types
typedef std::vector< Port >	Ports
Public Member Functions
	AudioBufferSource (const ProcessingConfig &config=Config())
	~AudioBufferSource ()
void	SetFrameAndHopSize (const int val, unsigned index)
void	SetExternalBuffer (const float *buf, unsigned nframes, unsigned index)
void	SetExternalBuffer (const 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 ()
const Ports &	GetPorts () const

---

Detailed Description

Definition at line 13 of file AudioBufferSource.hxx.

---

Member Typedef Documentation

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

Definition at line 33 of file AudioBufferSource.hxx.

---

Constructor & Destructor Documentation

CLAM::AudioBufferSource::AudioBufferSource

(

const ProcessingConfig &

config = Config()

)

[inline]

Definition at line 66 of file AudioBufferSource.hxx.

References CLAM::Processing::Configure().

CLAM::AudioBufferSource::~AudioBufferSource

(

)

[inline]

Definition at line 76 of file AudioBufferSource.hxx.

---

Member Function Documentation

bool CLAM::AudioBufferSource::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 104 of file AudioBufferSource.hxx.

References CLAM::Processing::CopyAsConcreteConfig().

bool CLAM::AudioBufferSource::Do

(

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 20 of file AudioBufferSource.cxx.

const char* CLAM::AudioBufferSource::GetClassName

(

)

const [inline, virtual]

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

Implements CLAM::Processing.

Definition at line 97 of file AudioBufferSource.hxx.

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

const Ports& CLAM::AudioBufferSource::GetPorts

(

)

const [inline]

Definition at line 115 of file AudioBufferSource.hxx.

Ports& CLAM::AudioBufferSource::GetPorts

(

)

[inline]

Definition at line 114 of file AudioBufferSource.hxx.

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

Definition at line 63 of file AudioBufferSource.cxx.

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

Definition at line 51 of file AudioBufferSource.cxx.

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

Definition at line 82 of file AudioBufferSource.hxx.

References CLAM_ASSERT.

virtual bool CLAM::AudioBufferSource::SupportsVariableAudioSize

(

)

const [inline, virtual]

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

Reimplemented from CLAM::Processing.

Definition at line 95 of file AudioBufferSource.hxx.

---

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

• AudioBufferSource.hxx
• AudioBufferSource.cxx