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

Distortion AudioEffect. More...

#include <AudioEffect.h>

Inheritance diagram for audio_tools::Distortion:
audio_tools::AudioEffect

Public Member Functions

 Distortion (const Distortion &copy)=default
 
 Distortion (int16_t clipThreashold=4990, int16_t maxInput=6500)
 Distortion Constructor: e.g. use clipThreashold 4990 and maxInput=6500.
 
int16_t clipThreashold ()
 
Distortionclone ()
 
int16_t maxInput ()
 
effect_t process (effect_t input)
 calculates the effect output from the input More...
 
void setClipThreashold (int16_t th)
 
void setMaxInput (int16_t maxInput)
 
- Public Member Functions inherited from audio_tools::AudioEffect
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)=0
 calculates the effect output from the input More...
 
virtual void setActive (bool value)
 sets the effect active/inactive
 
void setId (int id)
 Allows to identify an effect.
 

Protected Attributes

int16_t max_input
 
int16_t p_clip_threashold
 
- Protected Attributes inherited from audio_tools::AudioEffect
bool active_flag = true
 
int id_value = -1
 

Additional Inherited Members

- Protected Member Functions inherited from audio_tools::AudioEffect
int16_t clip (int32_t in, int16_t clipLimit=32767, int16_t resultLimit=32767)
 generic clipping method
 
void copyParent (AudioEffect *copy)
 

Detailed Description

Distortion AudioEffect.

Author
Phil Schatzmann

Member Function Documentation

◆ clone()

Distortion * audio_tools::Distortion::clone ( )
inlinevirtual

◆ process()

effect_t audio_tools::Distortion::process ( effect_t  in)
inlinevirtual

calculates the effect output from the input

Implements audio_tools::AudioEffect.


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