ST STM32F2

HAL I2S Generic Driver
UM1940
322/1371
DocID028236 Rev 2
HAL_I2S_DMAPause
Function name
HAL_StatusTypeDef HAL_I2S_DMAPause
(I2S_HandleTypeDef * hi2s)
Function description
Pauses the audio stream playing from the Media.
Parameters
hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values
HAL: status
HAL_I2S_DMAResume
Function name
HAL_StatusTypeDef HAL_I2S_DMAResume
(I2S_HandleTypeDef * hi2s)
Function description
Resumes the audio stream playing from the Media.
Parameters
hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values
HAL: status
HAL_I2S_DMAStop
Function name
HAL_StatusTypeDef HAL_I2S_DMAStop (I2S_HandleTypeDef
* hi2s)
Function description
Resumes the audio stream playing from the Media.
Parameters
hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values
HAL: status
HAL_I2S_GetState
Function name
HAL_I2S_StateTypeDef HAL_I2S_GetState
(I2S_HandleTypeDef * hi2s)
Function description
Return the I2S state.
Parameters
hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values
HAL: state
HAL_I2S_GetError
Function name
uint32_t HAL_I2S_GetError (I2S_HandleTypeDef * hi2s)
Function description
Return the I2S error code.
Parameters
hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values
I2S: Error Code