STKEffect Class Reference

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:

Collaboration diagram for STKEffect:

Public Member Functions
	STKEffect (stk::Effect &stkEffect)
virtual bool	active ()
	determines if the effect is active
virtual AudioEffect *	clone ()=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

Copyright

GPLv3

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

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

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:

• src/AudioTools/AudioLibs/AudioSTK.h