Chapter 2. API Reference
i2s_bits_per_sample_t bits_per_sample
I2S sample bits in one channel
i2s_channel_fmt_t channel_format
I2S channel format.
i2s_comm_format_t communication_format
I2S communication format
int intr_alloc_flags
Flags used to allocate the interrupt. One or multiple (ORred) ESP_INTR_FLAG_* values. See
esp_intr_alloc.h for more info
int dma_buf_count
I2S DMA Buffer Count
int dma_buf_len
I2S DMA Buffer Length
bool use_apll
I2S using APLL as main I2S clock, enable it to get accurate clock
bool tx_desc_auto_clear
I2S auto clear tx descriptor if there is underflow condition (helps in avoiding noise in case of data un-
availability)
int fixed_mclk
I2S using fixed MCLK output. If use_apll = true and fixed_mclk > 0, then the clock output for i2s is
fixed and equal to the fixed_mclk value. If fixed_mclk set, mclk_multiple won’t take effect
i2s_mclk_multiple_t mclk_multiple
The multiple of I2S master clock(MCLK) to sample rate
i2s_bits_per_chan_t bits_per_chan
I2S total bits in one channel，only take effect when larger than‘bits_per_sample’, default‘0’means
equal to ‘bits_per_sample’
struct i2s_event_t
Event structure used in I2S event queue.
Public Members
i2s_event_type_t type
I2S event type
size_t size
I2S data size for I2S_DATA event
Macros
I2S_PIN_NO_CHANGE
Use in i2s_pin_config_t for pins which should not be changed
Type Definitions
typedef i2s_driver_config_t i2s_config_t
typedef intr_handle_t i2s_isr_handle_t
Enumerations
enum i2s_port_t
I2S port number, the max port number is (I2S_NUM_MAX -1).
Values:
Espressif Systems 303
Submit Document Feedback
Release v4.4
To Next Page
Loading...