HAL_I2S_Receive() - syntax, references, call tree, description

hi2s

pointer to a I2S_HandleTypeDef structure that contains the configuration information for I2S module

pData

a 16-bit pointer to data buffer.

Size

number of data sample to be sent:

Timeout

Timeout duration

Return value

Notes

When a 16-bit data frame or a 16-bit data frame extended is selected during the I2S configuration phase, the Size parameter means the number of 16-bit data length in the transaction and when a 24-bit data frame or a 32-bit data frame is selected the Size parameter means the number of 24-bit or 32-bit data length. The I2S is kept enabled at the end of transaction to avoid the clock de-synchronization between Master and Slave(example: audio streaming). In I2S Master Receiver mode, just after enabling the peripheral the clock will be generate in continuous way and as the I2S is not disabled at the end of the I2S transaction.

References

Location	Text
stm32f4xx_hal_i2s.c:961	HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef hi2s, uint16_t pData, uint16_t Size, uint32_t Timeout)
stm32f4xx_hal_i2s.h:470	HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef hi2s, uint16_t pData, uint16_t Size, uint32_t Timeout);