The WAV Player API provides functions for playing the waveform audio file format(*.wav).
Required Header
#include <wav_player.h>
Overview
The WAV Player API allows you to simply play and stop a wav file. To play a certain wav file, call wave_player_start() with a path to the .wav file. When playing a wav file is finished, wav_player_playback_completed_cb() will be invoked.
Typedef Documentation
Called when a WAV file is no longer being played.
This callback is not invoked by calling wav_player_stop().
- Since :
- 2.3.1
- Parameters:
-
[in] | id | The completed wav player ID |
[in] | user_data | The user data passed from the callback registration function |
- See also:
- wav_player_start()
Enumeration Type Documentation
Enumeration of error codes for WAV player.
- Since :
- 2.3.1
- Enumerator:
WAV_PLAYER_ERROR_NONE |
Successful
|
WAV_PLAYER_ERROR_INVALID_PARAMETER |
Invalid parameter
|
WAV_PLAYER_ERROR_INVALID_OPERATION |
Invalid operation
|
WAV_PLAYER_ERROR_FORMAT_NOT_SUPPORTED |
Format not supported
|
Function Documentation
Plays a WAV file.
- Since :
- 2.3.1
- Parameters:
-
[in] | path | The WAV file path to the file to be played |
[in] | type | The sound type |
[in] | callback | The callback function to be invoked when a WAV file is no longer being played |
[in] | user_data | The user data to be passed to the callback function |
[out] | id | The WAV player ID (can be set to NULL ) |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- Postcondition:
- It invokes wav_player_playback_completed_cb() when a WAV file is no longer being played.
- See also:
- wav_player_stop()
-
wav_player_playback_completed_cb()
Stops playing the WAV file.
- Since :
- 2.3.1
- Parameters:
-
[in] | id | The WAV player ID to stop |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- wav_player_start()