arduino-audio-tools
Public Member Functions | Public Attributes | List of all members
I2SConfigESP32V1 Class Reference

Configuration for ESP32 i2s for IDF > 5.0. More...

#include <I2SConfigESP32V1.h>

Inheritance diagram for I2SConfigESP32V1:
AudioInfo

Public Member Functions

 I2SConfigESP32V1 (const I2SConfigESP32V1 &cfg)=default
 Default Copy Constructor.
 
 I2SConfigESP32V1 (RxTxMode mode)
 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 (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

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 = I2S_BUFFER_COUNT
 not used any more
 
int buffer_size = I2S_BUFFER_SIZE
 not used any more
 
I2SChannelSelect channel_format = I2SChannelSelect::Default
 Select left or right channel when channels == 1.
 
uint16_t channels = DEFAULT_CHANNELS
 Number of channels: 2=stereo, 1=mono.
 
I2SFormat i2s_format = I2S_STD_FORMAT
 
bool is_master = true
 
int mclk_multiple = -1
 masterclock multiple (-1 = use default)
 
int pin_bck = PIN_I2S_BCK
 
int pin_data = -1
 
int pin_data_rx = -1
 
int pin_mck = -1
 
int pin_ws = PIN_I2S_WS
 
int port_no = 0
 
RxTxMode rx_tx_mode = TX_MODE
 public settings
 
sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE
 Sample Rate: e.g 44100.
 
I2SSignalType signal_type = Digital
 
bool use_apll = I2S_USE_APLL
 

Detailed Description

Configuration for ESP32 i2s for IDF > 5.0.

Author
Phil Schatzmann

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