i2s_channel_reconfig_pdm_tx_clock() function

Reconfigure the I2S clock for PDM TX mode

Syntax

Show:

Summary

Declaration

Definition

from i2s_pdm.h:411

esp_err_t i2s_channel_reconfig_pdm_tx_clock(i2s_chan_handle_t handle, const i2s_pdm_tx_clk_config_t *clk_cfg);

Implemented in i2s_pdm.c:219

Arguments

Argument

Description

handle

I2S TX channel handler

clk_cfg

PDM TX mode clock configuration, can be generated by `I2S_PDM_TX_CLK_DEFAULT_CONFIG`

Return value

- ESP_OK Set clock successfully - ESP_ERR_INVALID_ARG NULL pointer, invalid configuration or not PDM mode - ESP_ERR_INVALID_STATE This channel is not initialized or not stopped

Notes

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. The input channel handle has to be initialized to PDM TX mode, i.e., `i2s_channel_init_pdm_tx_mode` has been called before reconfiguring