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

Boost AudioEffect. More...

#include <AudioEffect.h>

Inheritance diagram for audio_tools::Boost:
audio_tools::AudioEffect

Public Member Functions

 Boost (const Boost &copy)=default
 
 Boost (float volume=1.0)
 
Boostclone ()
 
effect_t process (effect_t input)
 calculates the effect output from the input More...
 
void setVolume (float volume)
 
float volume ()
 
- 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

float effect_value
 
- 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

Boost AudioEffect.

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ Boost()

audio_tools::Boost::Boost ( float  volume = 1.0)
inline

Boost Constructor: volume 0.1 - 1.0: decrease result; volume >0: increase result

Member Function Documentation

◆ clone()

Boost * audio_tools::Boost::clone ( )
inlinevirtual

◆ process()

effect_t audio_tools::Boost::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: