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

Fuzz AudioEffect. More...

#include <AudioEffect.h>

Inheritance diagram for Fuzz:
AudioEffect

Public Member Functions

 Fuzz (const Fuzz &copy)=default
 
 Fuzz (float fuzzEffectValue=6.5, uint16_t maxOut=300)
 Fuzz Constructor: use e.g. effectValue=6.5; maxOut = 300.
 
virtual bool active ()
 determines if the effect is active
 
Fuzzclone ()
 
float fuzzEffectValue ()
 
int id ()
 Allows to identify an effect.
 
uint16_t maxOut ()
 
effect_t process (effect_t input)
 calculates the effect output from the input
 
virtual void setActive (bool value)
 sets the effect active/inactive
 
void setFuzzEffectValue (float v)
 
void setId (int id)
 Allows to identify an effect.
 
void setMaxOut (uint16_t v)
 

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
 
uint16_t max_out
 
float p_effect_value
 

Detailed Description

Fuzz AudioEffect.

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ Fuzz() [1/2]

Fuzz ( float  fuzzEffectValue = 6.5,
uint16_t  maxOut = 300 
)
inline

Fuzz Constructor: use e.g. effectValue=6.5; maxOut = 300.

◆ Fuzz() [2/2]

Fuzz ( const Fuzz copy)
default

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()

Fuzz * clone ( )
inlinevirtual

Implements AudioEffect.

◆ copyParent()

void copyParent ( AudioEffect copy)
inlineprotectedinherited

◆ fuzzEffectValue()

float fuzzEffectValue ( )
inline

◆ id()

int id ( )
inlineinherited

Allows to identify an effect.

◆ maxOut()

uint16_t maxOut ( )
inline

◆ process()

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

◆ setFuzzEffectValue()

void setFuzzEffectValue ( float  v)
inline

◆ setId()

void setId ( int  id)
inlineinherited

Allows to identify an effect.

◆ setMaxOut()

void setMaxOut ( uint16_t  v)
inline

Member Data Documentation

◆ active_flag

bool active_flag = true
protectedinherited

◆ id_value

int id_value = -1
protectedinherited

◆ max_out

uint16_t max_out
protected

◆ p_effect_value

float p_effect_value
protected

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