Base Class for Effects. More...

#include <AudioEffectsSuite.h>

Inheritance diagram for EffectSuiteBase:

Public Member Functions
virtual bool	active ()
	determines if the effect is active

virtual AudioEffect *	clone ()=0

int	id ()
	Allows to identify an effect.

virtual void	setActive (bool value)
	sets the effect active/inactive

void	setId (int id)
	Allows to identify an effect.

Protected Member Functions
int16_t	clip (int32_t in, int16_t clipLimit=32767, int16_t resultLimit=32767)
	generic clipping method

void	copyParent (AudioEffect *copy)

Protected Attributes
bool	active_flag = true

int	id_value = -1

Detailed Description

Base Class for Effects.

Member Function Documentation

◆ active()

virtual bool active ( )

inlinevirtualinherited

determines if the effect is active

◆ clip()

int16_t clip	(	int32_t	in,
		int16_t	clipLimit = `32767`,
		int16_t	resultLimit = `32767`
	)

inlineprotectedinherited

generic clipping method

◆ clone()

virtual AudioEffect * clone ( )

pure virtualinherited

Implemented in SimpleLPF, Boost, Distortion, Fuzz, Tremolo, Delay, ADSRGain, PitchShift, Compressor, SimpleChorus, FilteredDelay, SimpleDelay, SimpleFlanger, STKChorus, STKEcho, STKFreeVerb, STKChowningReverb, STKNReverb, STKPerryReverb, STKLentPitShift, and STKPitShift.

◆ copyParent()

void copyParent ( AudioEffect * copy )

inlineprotectedinherited

◆ id()

int id ( )

inlineinherited

Allows to identify an effect.

◆ setActive()

virtual void setActive ( bool value )

inlinevirtualinherited

sets the effect active/inactive

◆ setId()

void setId ( int id )

inlineinherited

Allows to identify an effect.

Member Data Documentation

◆ active_flag

bool active_flag = true

protectedinherited

◆ id_value

int id_value = -1