arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
EffectSuiteBase< effectsuite_t > Class Template Referenceabstract

Base Class for Effects. More...

#include <AudioEffectsSuite.h>

Inheritance diagram for EffectSuiteBase< effectsuite_t >:
AudioEffect FilterEffectBase< effectsuite_t_default > FilterEffectBase< effectsuite_t > SimpleDelay< effectsuite_t > SimpleFlanger< effectsuite_t > SimpleLPF< effectsuite_t_default > EnvelopeFilter< effectsuite_t > FilteredDelay< effectsuite_t > SimpleLPF< effectsuite_t > SimpleChorus< effectsuite_t >

Public Member Functions

virtual bool active ()
 determines if the effect is active
 
virtual AudioEffectclone ()=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

template<typename effectsuite_t = effectsuite_t_default>
class audio_tools::EffectSuiteBase< effectsuite_t >

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

◆ 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
protectedinherited

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