AnalogConfigESP32 Class Reference

ESP32 specific configuration for i2s input via adc. The default input pin is GPIO34. We always use int16_t values. The default output pins are GPIO25 and GPIO26! More...

#include <AnalogConfigESP32.h>

Inheritance diagram for AnalogConfigESP32:

Collaboration diagram for AnalogConfigESP32:

Public Member Functions
	AnalogConfigESP32 (const AnalogConfigESP32 &cfg)=default
	Copy constructor.
	AnalogConfigESP32 (RxTxMode rxtxMode=TX_MODE)
	Default constructor.
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.
void	logInfo ()
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.
void	setInputPin1 (int pin)
	Defines an alternative input pin (for the left channel)

Public Attributes
int	adc_pin
bool	auto_clear = I2S_AUTO_CLEAR
uint8_t	bits_per_sample = DEFAULT_BITS_PER_SAMPLE
	Number of bits per sample (int16_t = 16 bits)
int	buffer_count = ANALOG_BUFFER_COUNT
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
bool	is_scale_to_16bit = false
	Scale the 12 bit ADC values to the full 16 bit range.
int	mode_internal
int	port_no = I2S_NUM_0
RxTxMode	rx_tx_mode
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
TickType_t	timeout = portMAX_DELAY
bool	uninstall_driver_on_end = true
bool	use_apll = false

Friends
class	AnalogDriverESP32

Detailed Description

ESP32 specific configuration for i2s input via adc. The default input pin is GPIO34. We always use int16_t values. The default output pins are GPIO25 and GPIO26!

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AnalogConfigESP32() [1/2]

AnalogConfigESP32 ( RxTxMode  rxtxMode = TX_MODE )

inline

Default constructor.

AnalogConfigESP32() [2/2]

AnalogConfigESP32 ( const AnalogConfigESP32 &  cfg )

default

Copy constructor.

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() [1/2]

void logInfo ( )

inline

logInfo() [2/2]

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.

setInputPin1()

void setInputPin1 ( int  pin )

inline

Defines an alternative input pin (for the left channel)

Friends And Related Symbol Documentation

AnalogDriverESP32

friend class AnalogDriverESP32

friend

Member Data Documentation

adc_pin

int adc_pin

auto_clear

bool auto_clear = I2S_AUTO_CLEAR

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 = ANALOG_BUFFER_COUNT

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

is_scale_to_16bit

bool is_scale_to_16bit = false

Scale the 12 bit ADC values to the full 16 bit range.

mode_internal

int mode_internal

port_no

int port_no = I2S_NUM_0

rx_tx_mode

RxTxMode rx_tx_mode

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

timeout

TickType_t timeout = portMAX_DELAY

uninstall_driver_on_end

bool uninstall_driver_on_end = true

use_apll

bool use_apll = false

---

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

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