Boost Class Reference

Boost AudioEffect. More...

#include <AudioEffect.h>

Inheritance diagram for Boost:

Public Member Functions
	Boost (const Boost &copy)=default
	Boost (float volume=1.0)
virtual bool	active ()
	determines if the effect is active
Boost *	clone ()
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	setId (int id)
	Allows to identify an effect.
bool	setVolume (float volume) override
virtual float	volume ()
	provides the actual volume in the range of 0.0f to 1.0f
virtual float	volume ()
	provides the actual volume in the range of 0.0f to 1.0f

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
float	volume_value = 1.0f

Detailed Description

Boost AudioEffect.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

Boost() [1/2]

Boost ( float volume = 1.0 )

inline

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

Boost() [2/2]

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

Boost * clone ( )

inlinevirtual

Implements AudioEffect.

copyParent()

void copyParent ( AudioEffect * copy )

inlineprotectedinherited

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

setId()

void setId ( int id )

inlineinherited

Allows to identify an effect.

setVolume()

bool setVolume ( float volume )

inlineoverridevirtual

define the actual volume in the range of 0.0f to 1.0f (values > 1.0f boost the signal, capped to q1_14_t's ~1.99994 range when PREFER_FIXEDPOINT is active)

Reimplemented from VolumeSupport.

volume() [1/2]

virtual float volume ( )

inlinevirtualinherited

provides the actual volume in the range of 0.0f to 1.0f

Reimplemented in AudioPlayer, I2SCodecStream, USBAudioStreamBase, VolumeStream, and VS1053Stream.

volume() [2/2]

virtual float volume ( )

inlinevirtualinherited

provides the actual volume in the range of 0.0f to 1.0f

Reimplemented in AudioPlayer, I2SCodecStream, USBAudioStreamBase, VolumeStream, and VS1053Stream.

Member Data Documentation

active_flag

bool active_flag = true

protectedinherited

id_value

int id_value = -1

protectedinherited

volume_value

float volume_value = 1.0f

protectedinherited

---

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

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