Function esp_idf_sys::i2s_write

source ·
pub unsafe extern "C" fn i2s_write(
    i2s_num: i2s_port_t,
    src: *const c_void,
    size: usize,
    bytes_written: *mut usize,
    ticks_to_wait: TickType_t
) -> esp_err_t
Expand description

@brief Write data to I2S DMA transmit buffer.

@param i2s_num I2S port number

@param src Source address to write from

@param size Size of data in bytes

@param[out] bytes_written Number of bytes written, if timeout, the result will be less than the size passed in.

@param ticks_to_wait TX buffer wait timeout in RTOS ticks. If this many ticks pass without space becoming available in the DMA transmit buffer, then the function will return (note that if the data is written to the DMA buffer in pieces, the overall operation may still take longer than this timeout.) Pass portMAX_DELAY for no timeout.

@return - ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error