Distortion Class Reference

Distortion AudioEffect. More...

#include <AudioEffect.h>

Inheritance diagram for Distortion:

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.
virtual bool	active ()
	determines if the effect is active
int16_t	clipThreashold ()
Distortion *	clone ()
int	id ()
	Allows to identify an effect.
int16_t	maxInput ()
effect_t	process (effect_t input)
	calculates the effect output from the input
virtual void	setActive (bool value)
	sets the effect active/inactive
void	setClipThreashold (int16_t th)
void	setId (int id)
	Allows to identify an effect.
void	setMaxInput (int16_t maxInput)

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
int16_t	max_input
int16_t	p_clip_threashold

Detailed Description

Distortion AudioEffect.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

Distortion() [1/2]

Distortion ( int16_t clipThreashold = 4990, int16_t maxInput = 6500 )

inline

Distortion Constructor: e.g. use clipThreashold 4990 and maxInput=6500.

Distortion() [2/2]

Distortion ( const Distortion & 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

clipThreashold()

int16_t clipThreashold ( )

inline

clone()

Distortion * clone ( )

inlinevirtual

Implements AudioEffect.

copyParent()

void copyParent ( AudioEffect * copy )

inlineprotectedinherited

id()

int id ( )

inlineinherited

Allows to identify an effect.

maxInput()

int16_t maxInput ( )

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

setClipThreashold()

void setClipThreashold ( int16_t th )

inline

setId()

void setId ( int id )

inlineinherited

Allows to identify an effect.

setMaxInput()

void setMaxInput ( int16_t maxInput )

inline

Member Data Documentation

active_flag

bool active_flag = true

protectedinherited

id_value

int id_value = -1

protectedinherited

max_input

int16_t max_input

protected

p_clip_threashold

int16_t p_clip_threashold

protected

---

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

• src/AudioTools/CoreAudio/AudioEffects/AudioEffect.h