Function esp_idf_svc::hal::sys::i2s_driver_install

source ยท
pub unsafe extern "C" fn i2s_driver_install(
    i2s_num: u32,
    i2s_config: *const i2s_driver_config_t,
    queue_size: i32,
    i2s_queue: *mut c_void,
) -> i32
Expand description

@brief Install and start I2S driver.

@param i2s_num I2S port number

@param i2s_config I2S configurations - see i2s_config_t struct

@param queue_size I2S event queue size/depth.

@param i2s_queue I2S event queue handle, if set NULL, driver will not use an event queue.

This function must be called before any I2S driver read/write operations.

@return - ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error - ESP_ERR_NO_MEM Out of memory - ESP_ERR_INVALID_STATE Current I2S port is in use