arduino-audio-tools
All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Macros Modules Pages
Public Member Functions | Public Attributes | List of all members
ConfigEqualizer3Bands Struct Reference

Configuration for 3 Band Equalizer. More...

#include <Equalizer.h>

Inheritance diagram for ConfigEqualizer3Bands:
AudioInfo

Public Member Functions

virtual void clear ()
 
void copyFrom (AudioInfo info)
 Same as set.
 
bool equals (AudioInfo alt)
 Returns true if alt values are the same like the current values.
 
bool equalsExSampleRate (AudioInfo alt)
 Checks if only the sample rate is different.
 
virtual void logInfo (const char *source="")
 
 operator bool ()
 Returns true if all components are defined (no component is 0)
 
bool operator!= (AudioInfo alt)
 Returns true if alt values are the different from the current values.
 
bool operator== (AudioInfo alt)
 Returns true if alt values are the same like the current values.
 
void set (AudioInfo info)
 Copies the values from info.
 
void setAudioInfo (AudioInfo info)
 Same as set.
 

Public Attributes

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE
 Number of bits per sample (int16_t = 16 bits)
 
uint16_t channels = DEFAULT_CHANNELS
 Number of channels: 2=stereo, 1=mono.
 
int freq_high = 5000
 High-pass filter cutoff frequency in Hz. Frequencies above this are considered "high".
 
int freq_low = 880
 Low-pass filter cutoff frequency in Hz. Frequencies below this are considered "low".
 
float gain_high = 1.0
 Gain multiplier for high frequencies (0.0-2.0, where 1.0 = unity gain)
 
float gain_low = 1.0
 Gain multiplier for low frequencies (0.0-2.0, where 1.0 = unity gain)
 
float gain_medium = 1.0
 Gain multiplier for medium frequencies (0.0-2.0, where 1.0 = unity gain)
 
sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE
 Sample Rate: e.g 44100.
 

Detailed Description

Configuration for 3 Band Equalizer.

Configure the basic audio parameters (channels, bits_per_sample, sample_rate) and the equalizer settings. The frequency and gain parameters apply to all channels identically in the basic Equalizer3Bands class.

Frequency bands:

Gain values should typically range from 0.0 to 2.0:

Author
pschatzmann

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