STSW-STLKT01
|
Functions | |
uint8_t | BSP_AUDIO_IN_Init (uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr) |
Initializes audio acquisition. More... | |
uint8_t | BSP_AUDIO_IN_DeInit (void) |
DeInitializes the audio peripheral. More... | |
__weak uint8_t | BSP_AUDIO_IN_ClockConfig (uint32_t AudioFreq, void *Params) |
Clock Config. More... | |
uint8_t | BSP_AUDIO_IN_Record (uint16_t *pbuf, uint32_t size) |
Starts audio recording. More... | |
uint8_t | BSP_AUDIO_IN_Stop (void) |
Stops audio recording. More... | |
uint8_t | BSP_AUDIO_IN_Pause (void) |
Pauses the audio file stream. More... | |
uint8_t | BSP_AUDIO_IN_Resume (void) |
Resumes the audio file stream. More... | |
uint8_t | BSP_AUDIO_IN_SetVolume (uint8_t Volume) |
Controls the audio in volume level. More... | |
__weak void | BSP_AUDIO_IN_Error_Callback (void) |
Audio IN Error callback function. More... | |
void | BSP_AUDIO_IN_TransferComplete_CallBack (void) |
User callback when record buffer is filled. More... | |
void | BSP_AUDIO_IN_HalfTransfer_CallBack (void) |
User callback when record buffer is half filled. More... | |
Detailed Description
Function Documentation
◆ BSP_AUDIO_IN_ClockConfig()
uint8_t BSP_AUDIO_IN_ClockConfig | ( | uint32_t | AudioFreq, |
void * | Params | ||
) |
Clock Config.
- Parameters
-
Params additional parameters where required AudioFreq Audio frequency used to play the audio stream.
- Note
- This API is called by BSP_AUDIO_IN_Init() Being __weak it can be overwritten by the application
- Return values
-
AUDIO_OK if no problem during execution, AUDIO_ERROR otherwise
Definition at line 178 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_DeInit()
uint8_t BSP_AUDIO_IN_DeInit | ( | void | ) |
DeInitializes the audio peripheral.
- Return values
-
None
Definition at line 164 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_Error_Callback()
void BSP_AUDIO_IN_Error_Callback | ( | void | ) |
Audio IN Error callback function.
- Parameters
-
None
- Return values
-
None
Definition at line 306 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_HalfTransfer_CallBack()
void BSP_AUDIO_IN_HalfTransfer_CallBack | ( | void | ) |
User callback when record buffer is half filled.
- Parameters
-
None
- Return values
-
None User callback when record buffer is half filled.
- Parameters
-
None
- Return values
-
None
Definition at line 921 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_Init()
uint8_t BSP_AUDIO_IN_Init | ( | uint32_t | AudioFreq, |
uint32_t | BitRes, | ||
uint32_t | ChnlNbr | ||
) |
Initializes audio acquisition.
- Parameters
-
AudioFreq Audio frequency to be configured for the peripherals. Possible values are 8000, 16000, 32000, 48000 OR 96000 Hz BitRes Not used in this release. ChnlNbr Number of channel to be configured.
- Note
- if ChnlNbr == 1, the onboard microphone is acquired if ChnlNbr == 2, two external microphones connected to "GPIO2" are acquired if ChnlNbr == 4, four external microphones connected to "GPIO2" and "GPIO3" are acquired
- Return values
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 146 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_Pause()
uint8_t BSP_AUDIO_IN_Pause | ( | void | ) |
Pauses the audio file stream.
- Parameters
-
None
- Return values
-
AUDIO_OK in case of success, AUDIO_ERROR otherwise
Definition at line 251 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_Record()
uint8_t BSP_AUDIO_IN_Record | ( | uint16_t * | pbuf, |
uint32_t | size | ||
) |
Starts audio recording.
- Parameters
-
* pbuf: Buffer that will contain 1 ms of PCM for each microphone. Its dimension must be equal to (in uint16_t words): ((PCM sampling frequency)/1000 * Channels) size Not used in this driver.
- Return values
-
AUDIO_OK in case of success, AUDIO_ERROR otherwise
Definition at line 209 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_Resume()
uint8_t BSP_AUDIO_IN_Resume | ( | void | ) |
Resumes the audio file stream.
- Parameters
-
None
- Return values
-
AUDIO_OK in case of success, AUDIO_ERROR otherwise
Definition at line 270 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_SetVolume()
uint8_t BSP_AUDIO_IN_SetVolume | ( | uint8_t | Volume | ) |
Controls the audio in volume level.
- Parameters
-
Volume Volume level to be set. This value has the same behaviour of the Volume parameter of the PDM to PCM software decimation library. Other strategies are possible in order to control the volume, for example to act on the right bit shift amount of the DFSDM peripheral Values must be in the range from 0 to 64
- Return values
-
AUDIO_OK in case of success, AUDIO_ERROR otherwise
Definition at line 295 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_Stop()
uint8_t BSP_AUDIO_IN_Stop | ( | void | ) |
Stops audio recording.
- Parameters
-
None
- Return values
-
AUDIO_OK in case of success, AUDIO_ERROR otherwise
Definition at line 231 of file SensorTile_audio_in.c.
◆ BSP_AUDIO_IN_TransferComplete_CallBack()
void BSP_AUDIO_IN_TransferComplete_CallBack | ( | void | ) |
User callback when record buffer is filled.
- Parameters
-
None
- Return values
-
None User callback when record buffer is filled.
- Parameters
-
None
- Return values
-
None
Definition at line 910 of file SensorTile_audio_in.c.
Generated by 1.8.13