AnalogConfigStd Class Reference

Generic ADC and DAC configuration. More...

#include <AnalogConfigStd.h>

Inheritance diagram for AnalogConfigStd:

Public Member Functions
	AnalogConfigStd ()=default
	AnalogConfigStd (RxTxMode rxtxMode)
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.
Pins &	pins ()
	Determines the pins (for all channels)
void	set (AudioInfo info)
	Copies the values from info.
void	setAudioInfo (AudioInfo info)
	Same as set.
template<typename T , int N>
void	setPins (T(&a)[N])
	support assignament of int array

Public Attributes
uint8_t	bits_per_sample = DEFAULT_BITS_PER_SAMPLE
	Number of bits per sample (int16_t = 16 bits)
int	buffer_count = 10
int	buffer_size = ANALOG_BUFFER_SIZE
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
bool	is_auto_center_read = true
bool	is_blocking_write = true
int	max_sample_rate = ANALOG_MAX_SAMPLE_RATE
RxTxMode	rx_tx_mode = RX_MODE
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
int	start_pin = -1

Protected Attributes
Pins	pins_data {0}

Friends
class	AnalogAudioArduino

Detailed Description

Generic ADC and DAC configuration.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AnalogConfigStd() [1/2]

AnalogConfigStd ( )

default

AnalogConfigStd() [2/2]

AnalogConfigStd ( RxTxMode  rxtxMode )

inline

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, and I2SConfigStd.

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.

pins()

Pins & pins ( )

inline

Determines the pins (for all channels)

set()

void set ( AudioInfo  info )

inlineinherited

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineinherited

Same as set.

setPins()

template<typename T , int N>

void setPins ( T(&)  a[N] )

inline

support assignament of int array

Friends And Related Symbol Documentation

AnalogAudioArduino

friend class AnalogAudioArduino

friend

Member Data Documentation

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

buffer_count

int buffer_count = 10

buffer_size

int buffer_size = ANALOG_BUFFER_SIZE

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

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

is_auto_center_read

bool is_auto_center_read = true

is_blocking_write

bool is_blocking_write = true

max_sample_rate

int max_sample_rate = ANALOG_MAX_SAMPLE_RATE

pins_data

Pins pins_data {0}

protected

rx_tx_mode

RxTxMode rx_tx_mode = RX_MODE

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

start_pin

int start_pin = -1

---

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

• src/AudioTools/CoreAudio/AudioAnalog/AnalogConfigStd.h