Configuration for ESP32 i2s for IDF > 5.0. More...
#include <I2SConfigESP32V1.h>
Inheritance diagram for I2SConfigESP32V1:
Public Member Functions | |
| I2SConfigESP32V1 () | |
| 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.
- Copyright
- GPLv3
Constructor & Destructor Documentation
◆ I2SConfigESP32V1() [1/3]
|
inline |
◆ I2SConfigESP32V1() [2/3]
|
default |
Default Copy Constructor.
◆ I2SConfigESP32V1() [3/3]
|
inline |
Constructor.
Member Function Documentation
◆ clear()
◆ copyFrom()
◆ equals()
Returns true if alt values are the same like the current values.
◆ equalsExSampleRate()
Checks if only the sample rate is different.
◆ logInfo()
◆ operator bool()
◆ operator!=()
Returns true if alt values are the different from the current values.
◆ operator==()
Returns true if alt values are the same like the current values.
◆ set()
◆ setAudioInfo()
Member Data Documentation
◆ auto_clear
| bool auto_clear = I2S_AUTO_CLEAR |
◆ bits_per_sample
|
inherited |
Number of bits per sample (int16_t = 16 bits)
◆ buffer_count
| int buffer_count = I2S_BUFFER_COUNT |
not used any more
◆ buffer_size
| int buffer_size = I2S_BUFFER_SIZE |
not used any more
◆ channel_format
| I2SChannelSelect channel_format = I2SChannelSelect::Default |
Select left or right channel when channels == 1.
◆ channels
|
inherited |
Number of channels: 2=stereo, 1=mono.
◆ i2s_format
| I2SFormat i2s_format = I2S_STD_FORMAT |
◆ is_master
◆ mclk_multiple
| int mclk_multiple = -1 |
masterclock multiple (-1 = use default)
◆ pin_bck
| int pin_bck = PIN_I2S_BCK |
◆ pin_data
| int pin_data = -1 |
◆ pin_data_rx
| int pin_data_rx = -1 |
◆ pin_mck
| int pin_mck = -1 |
◆ pin_ws
| int pin_ws = PIN_I2S_WS |
◆ port_no
| int port_no = 0 |
◆ rx_tx_mode
◆ sample_rate
|
inherited |
Sample Rate: e.g 44100.
◆ signal_type
| I2SSignalType signal_type = Digital |
◆ use_apll
| bool use_apll = I2S_USE_APLL |
The documentation for this class was generated from the following file:
- src/AudioTools/CoreAudio/AudioI2S/I2SConfigESP32V1.h
