arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
STKEffect Class Referenceabstract

Use any effect from the STK framework: e.g. Chorus, Echo, FreeVerb, JCRev, PitShift... https://github.com/pschatzmann/Arduino-STK. More...

#include <AudioSTK.h>

Inheritance diagram for STKEffect:
AudioEffect

Public Member Functions

 STKEffect (stk::Effect &stkEffect)
 
virtual bool active ()
 determines if the effect is active
 
virtual AudioEffectclone ()=0
 
int id ()
 Allows to identify an effect.
 
virtual effect_t process (effect_t in)
 calculates the effect output from the input
 
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
 
stk::Effect * p_effect = nullptr
 

Detailed Description

Use any effect from the STK framework: e.g. Chorus, Echo, FreeVerb, JCRev, PitShift... https://github.com/pschatzmann/Arduino-STK.

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ STKEffect()

STKEffect ( stk::Effect &  stkEffect)
inline

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.

◆ process()

virtual effect_t process ( effect_t  in)
inlinevirtual

calculates the effect output from the input

Implements AudioEffect.

◆ 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

◆ p_effect

stk::Effect* p_effect = nullptr
protected

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