_BSP_User_Manual: AUDIO_OUT_Exported_Functions

Sends n-Bytes on the I2S interface.

Parameters:

pData,:	pointer on data address
Size,:	number of data to be written

Return values:

None

Definition at line 263 of file stm3210c_eval_audio.c.

References hAudioOutI2s.

Manages the DMA FIFO error event.

Return values:

None

Definition at line 488 of file stm3210c_eval_audio.c.

Referenced by HAL_I2S_ErrorCallback().

Manages the DMA Half Transfer complete event.

Return values:

None

Definition at line 480 of file stm3210c_eval_audio.c.

Referenced by HAL_I2S_TxHalfCpltCallback().

Configure the audio peripherals.

Parameters:

OutputDevice,:	OUTPUT_DEVICE_SPEAKER, OUTPUT_DEVICE_HEADPHONE, OUTPUT_DEVICE_BOTH or OUTPUT_DEVICE_AUTO .
Volume,:	Initial volume level (from 0 (Mute) to 100 (Max))
AudioFreq,:	Audio frequency used to play the audio stream.

Return values:

0	if correct communication, else wrong communication

Definition at line 205 of file stm3210c_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, I2SOUT_Init(), and pAudioDrv.

This function Pauses the audio file stream.

In case of using DMA, the DMA Pause feature is used.

Note:

When calling BSP_AUDIO_OUT_Pause() function for pause, only BSP_AUDIO_OUT_Resume() function should be called for resume (use of BSP_AUDIO_OUT_Play() function for resume could lead to unexpected behavior).

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 276 of file stm3210c_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, hAudioOutI2s, and pAudioDrv.

Starts playing audio stream from a data buffer for a determined size.

Parameters:

pBuffer,:	Pointer to the buffer
Size,:	Number of audio data BYTES.

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 241 of file stm3210c_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, DMA_MAX, hAudioOutI2s, and pAudioDrv.

This function Resumes the audio file stream.

Note:

When calling BSP_AUDIO_OUT_Pause() function for pause, only BSP_AUDIO_OUT_Resume() function should be called for resume (use of BSP_AUDIO_OUT_Play() function for resume could lead to unexpected behavior).

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 300 of file stm3210c_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, hAudioOutI2s, and pAudioDrv.

Update the audio frequency.

Parameters:

AudioFreq,:

Audio frequency used to play the audio stream.

Return values:

None

Note:

This API should be called after the BSP_AUDIO_OUT_Init() to adjust the audio frequency.

Definition at line 418 of file stm3210c_eval_audio.c.

References I2SOUT_Init().

Enables or disables the MUTE mode by software.

Parameters:

Cmd,:

could be AUDIO_MUTE_ON to mute sound or AUDIO_MUTE_OFF to unmute the codec and restore previous volume level.

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 375 of file stm3210c_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, and pAudioDrv.

Switch dynamically (while audio file is played) the output target (speaker or headphone).

Note:

This function modifies a global variable of the audio codec driver: OutputDev.

Parameters:

Output,:

specifies the audio output target: OUTPUT_DEVICE_SPEAKER, OUTPUT_DEVICE_HEADPHONE, OUTPUT_DEVICE_BOTH or OUTPUT_DEVICE_AUTO

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 397 of file stm3210c_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, and pAudioDrv.

Controls the current audio volume level.

Parameters:

Volume,:

Volume level to be set in percentage from 0% to 100% (0 for Mute and 100 for Max volume level).

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 355 of file stm3210c_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, and pAudioDrv.

Stops audio playing and Power down the Audio Codec.

Parameters:

Option,:

could be one of the following parameters CODEC_PDWN_HW: completely shut down the codec (physically). Then need to reconfigure the Codec after power on.

Return values:

AUDIO_OK

if correct communication, else wrong communication

Definition at line 323 of file stm3210c_eval_audio.c.

References AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, AUDIO_RESET_PIN, BSP_IO_WritePin(), hAudioOutI2s, and pAudioDrv.

Manages the DMA full Transfer complete event.

Return values:

None

Definition at line 472 of file stm3210c_eval_audio.c.

Referenced by HAL_I2S_TxCpltCallback().

I2S error callbacks.

Parameters:

hi2s,:

I2S handle

Return values:

None

Definition at line 458 of file stm3210c_eval_audio.c.

References BSP_AUDIO_OUT_Error_CallBack(), and I2SOUT.

Tx Transfer completed callbacks.

Parameters:

hi2s,:

I2S handle

Return values:

None

Definition at line 429 of file stm3210c_eval_audio.c.

References BSP_AUDIO_OUT_TransferComplete_CallBack(), and I2SOUT.

Tx Transfer Half completed callbacks.

Parameters:

hi2s,:

I2S handle

Return values:

None

Definition at line 443 of file stm3210c_eval_audio.c.

References BSP_AUDIO_OUT_HalfTransfer_CallBack(), and I2SOUT.

Initializes the Audio Codec audio interface (I2S)

Parameters:

AudioFreq,:

Audio frequency to be configured for the I2S peripheral.

Definition at line 564 of file stm3210c_eval_audio.c.

References hAudioOutI2s, I2SOUT, and I2SOUT_MspInit().

Referenced by BSP_AUDIO_OUT_Init(), and BSP_AUDIO_OUT_SetFrequency().

AUDIO OUT I2S MSP Init.

Return values:

None

Definition at line 500 of file stm3210c_eval_audio.c.

References AUDIO_OUT_IRQ_PREPRIO, hAudioOutI2s, I2SOUT, I2SOUT_CLK_ENABLE, I2SOUT_DMAx_CHANNEL, I2SOUT_DMAx_CLK_ENABLE, I2SOUT_DMAx_IRQ, I2SOUT_DMAx_MEM_DATA_SIZE, I2SOUT_DMAx_PERIPH_DATA_SIZE, I2SOUT_MCK_CLK_ENABLE, I2SOUT_MCK_GPIO_PORT, I2SOUT_MCK_PIN, I2SOUT_SCK_PIN, I2SOUT_SCK_SD_CLK_ENABLE, I2SOUT_SCK_SD_GPIO_PORT, I2SOUT_SD_PIN, I2SOUT_WS_CLK_ENABLE, I2SOUT_WS_GPIO_PORT, and I2SOUT_WS_PIN.

Referenced by I2SOUT_Init().