SourceVu will show references to i2s_channel_read() from the following samples and libraries:
Symbols ![]()
loading...
Files ![]()
loading...
i2s_channel_read() function
I2S read data
Syntax
esp_err_t i2s_channel_read(i2s_chan_handle_t handle,
void *dest,
size_t size,
size_t *bytes_read,
uint32_t timeout_ms);
Implemented in ![]()
i2s_common.c:1318
Return value
- ESP_OK Read successfully - ESP_ERR_INVALID_ARG NULL pointer or this handle is not RX handle - ESP_ERR_TIMEOUT Reading timeout, no reading event received from ISR within ticks_to_wait - ESP_ERR_INVALID_STATE I2S is not ready to read
Notes
Only allowed to be called when the channel state is RUNNING but the RUNNING only stands for the software state, it doesn't mean there is no the signal transporting on line.
Related Functions
Found 47 other functions taking a ![]()
i2s_channel_obj_t
argument:
Function
Description
Check gpio validity and attach to corresponding signal
Enable the I2S channel
Allocate new I2S channel(s)
Disable the I2S channel
Delete the I2S channel
I2S write data
Initialize I2S channel to standard mode
Free I2S DMA descriptor and DMA buffer
Revoke the GPIO that configured as I2S output signal
Initialize I2S DMA interrupt
Reserve the GPIO that configured as I2S output signal
Get DMA buffer size
Allocate memory for I2S DMA descriptor and DMA buffer
Preload the data into TX DMA buffer
Reconfigure the I2S clock for standard mode
Reconfigure the I2S slot for standard mode
Attach data out signal and data in signal to a same gpio
Check gpio validity and output mclk signal
Initialize I2S channel to PDM RX mode
Initialize I2S channel to PDM TX mode
Set event callbacks for I2S channel
Get I2S channel information
Reconfigure the I2S GPIO for standard mode
Reconfigure the I2S clock for PDM RX mode
Reconfigure the I2S GPIO for PDM TX mode
Reconfigure the I2S clock for PDM TX mode
Reconfigure the I2S slot for PDM TX mode
Reconfigure the I2S GPIO for PDM RX mode
Reconfigure the I2S slot for PDM RX mode
Examples
Code
Location
Call Tree
from 0/4 examplesi2s_channel_read() calls 5 functions:
Data Use
from 0/4 examplesi2s_channel_read() reads 16 variables and writes 1 variable: