Tremolo Class Reference

Tremolo AudioEffect. More...

#include <AudioEffect.h>

Inheritance diagram for Tremolo:

Public Member Functions
	Tremolo (const Tremolo &copy)=default
	Tremolo (int16_t duration_ms=2000, uint8_t depthPercent=50, uint32_t sampleRate=44100)
virtual bool	active ()
	determines if the effect is active
Tremolo *	clone ()
uint8_t	depth ()
int16_t	duration ()
int	id ()
	Allows to identify an effect.
effect_t	process (effect_t input)
	calculates the effect output from the input
virtual void	setActive (bool value)
	sets the effect active/inactive
void	setDepth (uint8_t percent)
void	setDuration (int16_t ms)
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
int32_t	count = 0
int16_t	duration_ms
int	id_value = -1
int16_t	inc = 1
uint8_t	p_percent
int32_t	rate_count_half
uint32_t	sampleRate

Detailed Description

Tremolo AudioEffect.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

Tremolo() [1/2]

Tremolo ( int16_t  duration_ms = 2000, uint8_t  depthPercent = 50, uint32_t  sampleRate = 44100  )

inline

Tremolo constructor - use e.g. duration_ms=2000; depthPercent=50; sampleRate=44100

Tremolo() [2/2]

Tremolo ( const Tremolo &  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()

Tremolo * clone ( )

inlinevirtual

Implements AudioEffect.

copyParent()

void copyParent ( AudioEffect *  copy )

inlineprotectedinherited

depth()

uint8_t depth ( )

inline

duration()

int16_t duration ( )

inline

id()

int id ( )

inlineinherited

Allows to identify an effect.

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

setDepth()

void setDepth ( uint8_t  percent )

inline

setDuration()

void setDuration ( int16_t  ms )

inline

setId()

void setId ( int  id )

inlineinherited

Allows to identify an effect.

Member Data Documentation

active_flag

bool active_flag = true

protectedinherited

count

int32_t count = 0

protected

duration_ms

int16_t duration_ms

protected

id_value

int id_value = -1

protectedinherited

inc

int16_t inc = 1

protected

p_percent

uint8_t p_percent

protected

rate_count_half

int32_t rate_count_half

protected

sampleRate

uint32_t sampleRate

protected

---

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

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