CLAM::AudioAmplifier Class Reference

#include <AudioAmplifier.hxx>

Inheritance diagram for CLAM::AudioAmplifier:

List of all members.

---

Detailed Description

Time-domain audio gain.

Very simple time-domain linear audio amplifier. For lower the volume choose values between 0 and 1. Values over 1 will amplify the audio signal. Gain=1 means no change.

Definition at line 53 of file AudioAmplifier.hxx.

Public Types
typedef AudioAmplifierConfig	Config
Public Member Functions
	AudioAmplifier ()
	~AudioAmplifier ()
bool	Do ()
	Supervised mode execution method (using ports).
bool	Do (const Audio &in, Audio &out)
Protected Member Functions
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	ConcreteConfigure (const ProcessingConfig &config)
	Configuration method interface.

---

Member Typedef Documentation

typedef AudioAmplifierConfig CLAM::AudioAmplifier::Config

Reimplemented from CLAM::Processing.

Definition at line 109 of file AudioAmplifier.hxx.

---

Constructor & Destructor Documentation

CLAM::AudioAmplifier::AudioAmplifier

(

)

[inline]

Definition at line 70 of file AudioAmplifier.hxx.

References CLAM::Processing::Configure().

CLAM::AudioAmplifier::~AudioAmplifier

(

)

[inline]

Definition at line 80 of file AudioAmplifier.hxx.

---

Member Function Documentation

bool CLAM::AudioAmplifier::Do

(

)

[inline, virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 82 of file AudioAmplifier.hxx.

References CLAM::InPort< Token >::Consume(), CLAM::AudioOutPort::GetAudio(), CLAM::AudioInPort::GetAudio(), and CLAM::OutPort< Token >::Produce().

bool CLAM::AudioAmplifier::Do	(	const Audio &	in,
		Audio &	out
	)			[inline]

Definition at line 92 of file AudioAmplifier.hxx.

References CLAM::InControl::GetLastValue(), and CLAM::Audio::GetSize().

const ProcessingConfig& CLAM::AudioAmplifier::GetConfig

(

)

const [inline, protected, 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 114 of file AudioAmplifier.hxx.

bool CLAM::AudioAmplifier::ConcreteConfigure

(

const ProcessingConfig &

)

[inline, protected, 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 116 of file AudioAmplifier.hxx.

References CLAM::Processing::CopyAsConcreteConfig(), CLAM::InControl::DoControl(), CLAM::InControl::SetBounds(), and CLAM::InControl::SetDefaultValue().

---

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

• AudioAmplifier.hxx