AutomaticGainControlStreamConfig Struct Reference

Configuration for AutomaticGainControlStream. More...

#include <AutomaticGainControlStream.h>

Inheritance diagram for AutomaticGainControlStreamConfig:

Collaboration diagram for AutomaticGainControlStreamConfig:

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
float	attack_seconds = 0.25f
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.
float	max_gain_db = 6.0f
float	min_gain_db = -24.0f
float	peak_headroom_db = -1.0f
float	release_seconds = 3.0f
bool	reset_on_audio_change = true
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
float	silence_db = -55.0f
float	target_db = -18.0f

Detailed Description

Configuration for AutomaticGainControlStream.

This structure extends AudioInfo to include parameters for automatic gain control. It defines the target loudness, gain limits, attack/release times, and other settings that control how the stream adjusts audio levels.

Author

pschatzmann

Member Function Documentation

clear()

virtual void clear ( )

inlinevirtualinherited

copyFrom()

void copyFrom ( AudioInfo  info )

inlineinherited

Same as set.

equals()

bool equals ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

equalsExSampleRate()

bool equalsExSampleRate ( AudioInfo  alt )

inlineinherited

Checks if only the sample rate is different.

logInfo()

virtual void logInfo ( const char *  source = "" )

inlinevirtualinherited

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, I2SConfigStd, and I2SConfigZephyr.

operator bool()

operator bool ( )

inlineinherited

Returns true if all components are defined (no component is 0)

operator!=()

bool operator!= ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the different from the current values.

operator==()

bool operator== ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

set()

void set ( AudioInfo  info )

inlineinherited

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineinherited

Same as set.

Member Data Documentation

attack_seconds

float attack_seconds = 0.25f

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

Number of channels: 2=stereo, 1=mono.

max_gain_db

float max_gain_db = 6.0f

min_gain_db

float min_gain_db = -24.0f

peak_headroom_db

float peak_headroom_db = -1.0f

release_seconds

float release_seconds = 3.0f

reset_on_audio_change

bool reset_on_audio_change = true

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

silence_db

float silence_db = -55.0f

target_db

float target_db = -18.0f

---

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

• src/AudioTools/CoreAudio/Analysis/AutomaticGainControlStream.h