Echo Class Reference

#include <Echo.h>

Inherits Effect.

List of all members.

Public Member Functions
	Echo (const int &insertion_, REALTYPE *const efxoutl_, REALTYPE *const efxoutr_)
	~Echo ()
void	out (REALTYPE *const smpsl, REALTYPE *const smpr)
void	setpreset (unsigned char npreset)
void	changepar (const int &npar, const unsigned char &value)
unsigned char	getpar (const int &npar) const
void	cleanup ()
void	setdryonly ()
virtual REALTYPE	getfreqresponse (REALTYPE freq)
Public Attributes
REALTYPE *const	efxoutl
REALTYPE *const	efxoutr
REALTYPE	outvolume
FilterParams *	filterpars
Protected Attributes
const int	insertion

---

Detailed Description

Echo Effect

---

Constructor & Destructor Documentation

Echo::Echo	(	const int &	insertion_,
		REALTYPE *const	efxoutl_,
		REALTYPE *const	efxoutr_
	)

The Constructor For Echo

Parameters:

	insertion_	integer to determine if Echo is an insertion effect or not
	efxoutl_	Effect out Left Channel
	efxoutr_	Effect out Right Channel

Returns:

An initialized Echo Object

Echo::~Echo

(

)

The destructor

---

Member Function Documentation

void Echo::changepar	(	const int &	npar,
		const unsigned char &	value
	)			[virtual]

Sets the value of the chosen variable

The possible parameters are:

1. Volume
2. Panning
3. Delay
4. L/R Delay
5. L/R Crossover
6. Feedback
7. Dampening

   Parameters:

   	npar	number of chosen parameter
   	value	the new value

Todo:

in case of bogus parameter number print error to find depreciated calls

Reimplemented from Effect.

void Echo::cleanup

(

)

[virtual]

Zeros out the state of the Echo

Reimplemented from Effect.

virtual REALTYPE Effect::getfreqresponse

(

REALTYPE

freq

)

[inline, virtual, inherited]

This is only used for EQ (for user interface)

Reimplemented in EQ.

unsigned char Echo::getpar

(

const int &

npar

)

const [virtual]

Gets the specified parameter

The possible parameters are

1. Volume
2. Panning
3. Delay
4. L/R Delay
5. L/R Crossover
6. Feedback
7. Dampening

   Parameters:

   npar

   number of chosen parameter

   Returns:

   value of parameter

   Todo:

   make this method use constant variables by reference Currently doing so results in strange behavior

Reimplemented from Effect.

void Echo::out	(	REALTYPE *const	smpsl,
		REALTYPE *const	smpr
	)			[virtual]

Outputs the echo to efxoutl and efxoutr

Parameters:

	smpsl	Sample from Left channel
	smpsr	Sample from Right channel

Reimplemented from Effect.

void Echo::setdryonly

(

)

Todo:

This function needs to be implemented or the prototype should be removed

void Echo::setpreset

(

unsigned char

npreset

)

[virtual]

Sets the state of Echo to the specified preset

Parameters:

npreset

number of chosen preset

Reimplemented from Effect.

---

Member Data Documentation

REALTYPE* const Effect::efxoutl [inherited]

Effect out Left Channel

REALTYPE* const Effect::efxoutr [inherited]

Effect out Right Channel

FilterParams* Effect::filterpars [inherited]

Parameters for filters used by Effect

const int Effect::insertion [protected, inherited]

If Effect is an insertion effect, insertion=1 otherwise, it should be insertion=0

REALTYPE Effect::outvolume [inherited]

This is the volume of effect and is public because it is needed in system effects. The out volume of such effects are always 1.0, so this setting tells me how is the volume to the Master Output only.

---

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

• Effects/Echo.h
• Effects/Echo.C