Function esp_idf_svc::hal::sys::i2s_channel_reconfig_std_slot
source · pub unsafe extern "C" fn i2s_channel_reconfig_std_slot(
handle: *mut i2s_channel_obj_t,
slot_cfg: *const i2s_std_slot_config_t,
) -> i32
Expand description
@brief Reconfigure the I2S slot for standard mode
@note Only allowed to be called when the channel state is READY, i.e., channel has been initialized, but not started
this function won’t change the state. i2s_channel_disable
should be called before calling this function if I2S has started.
@note The input channel handle has to be initialized to standard mode, i.e., i2s_channel_init_std_mode
has been called before reconfiguring
@param[in] handle I2S channel handler
@param[in] slot_cfg Standard mode slot configuration, can be generated by I2S_STD_PHILIPS_SLOT_DEFAULT_CONFIG
,
I2S_STD_PCM_SLOT_DEFAULT_CONFIG
and I2S_STD_MSB_SLOT_DEFAULT_CONFIG
.
@return
- ESP_OK Set clock successfully
- ESP_ERR_NO_MEM No memory for DMA buffer
- ESP_ERR_INVALID_ARG NULL pointer, invalid configuration or not standard mode
- ESP_ERR_INVALID_STATE This channel is not initialized or not stopped