 |
AIROC™ BTSDK v4.7 - Documentation | |||
|
AIROC™ BTSDK v4.7 - Documentation | |||
Data Structures | |
| struct | wiced_bt_audio_config_buffer_t |
| Audio buffer configuration structure Please refer wiced_audio_buffer_initialize API documentation for recommended size. More... | |
| struct | wiced_bt_a2dp_statistics_t |
| A2DP statistics structure. More... | |
Typedefs | |
| typedef void(* | wiced_audio_suspend_complete_cback_t )(void) |
| Audio suspend complete callback. | |
| typedef void(* | wiced_audio_buffer_empty_cback_t )(uint32_t total_intr_count, uint32_t total_empty_count, uint32_t consecutive_empty_count) |
| Audio buffer empty callback. More... | |
Enumerations | |
| enum | wiced_audio_route_t { AUDIO_ROUTE_I2S = 0x00, AUDIO_ROUTE_UART = 0x01, AUDIO_ROUTE_SINE = 0x02, AUDIO_ROUTE_COMPRESSED_TRANSPORT = 0x04 } |
| wiced audio routes More... | |
| enum | wiced_device_role_t { WICED_AUDIO_SOURCE_ROLE = 1 << 1, WICED_AUDIO_SINK_ROLE = 1 << 2, WICED_HF_ROLE = 1 << 3 } |
| wiced device roles More... | |
Functions | |
| wiced_result_t | wiced_audio_buffer_initialize (wiced_bt_audio_config_buffer_t wiced_audio_cfg_pool) |
| Function wiced_audio_buffer_initialize. More... | |
| void | wiced_audio_start (int is_master, int audio_route, uint16_t lcid, wiced_bt_a2d_sbc_cie_t *pSbc) |
| Function wiced_audio_start. More... | |
| void | wiced_audio_stop (uint16_t lcid) |
| Function wiced_audio_stop. More... | |
| void | wiced_audio_suspend (uint16_t lcid, wiced_audio_suspend_complete_cback_t p_cback) |
| Function wiced_audio_suspend. More... | |
| void | wiced_audio_register_buffer_empty_cback (wiced_audio_buffer_empty_cback_t p_cback) |
| Function wiced_audio_register_buffer_empty_cback. More... | |
| void | wiced_audio_use_sw_timing (int enable) |
| Function wiced_audio_use_sw_timing. More... | |
| void | wiced_audio_set_sinwave (int16_t *pIn) |
| Function wiced_audio_set_sinwave. More... | |
| void | wiced_audio_get_statistics (wiced_bt_a2dp_statistics_t *buffer_stat) |
| Function wiced_audio_get_statistics. More... | |
| typedef void( * wiced_audio_buffer_empty_cback_t)(uint32_t total_intr_count, uint32_t total_empty_count, uint32_t consecutive_empty_count) |
Audio buffer empty callback.
Callback invoked on audio buffer empty event. Registered using wiced_audio_register_buffer_empty_cback()
| total_intr_count | : Total number of i2s interrupts |
| total_empty_count | : Total number of times the audio buffer is empty |
| consecutive_empty_count | : Number of consecutive times the audio buffer is empty, resets on receiving audio data |
| enum wiced_audio_route_t |
wiced audio routes
| enum wiced_device_role_t |
| wiced_result_t wiced_audio_buffer_initialize | ( | wiced_bt_audio_config_buffer_t | wiced_audio_cfg_pool | ) |
Function wiced_audio_buffer_initialize.
Audio buffer initialization. Allocates the audio buffer and returns pointer to the audio buffer
| [in] | wiced_audio_cfg_pool | : Size of the audio tx buffer and codec buffer to be allocated |
NOTE : Recommended audio_tx_buffer_size : If the application includes A2DP source profile, the transport buffer size shall be set to at least 8KB. In case of A2DP sink profile, set the transport buffer size (recommended size 0x1c00) if required to send the encoded/decoded data over the transport.
Recommended audio_codec_buffer_size:
| USE CASE | Recommended size | |-------------------------------------------------------------------------------—| | A2DP Source (SBC Encode) | 8KB | | A2DP Sink(SBC Decode)* | 11KB (300ms jitter buffer) + 8KB for codec | | | Total 19KB |
TODO : Provide formula for calculating Jitter Buffer
In case of multiple profiles used by application simultaneously, example A2DP sink and HFP device profiles, size specified should be the maximum of the recommended value for each profile supported.
| void wiced_audio_get_statistics | ( | wiced_bt_a2dp_statistics_t * | buffer_stat | ) |
Function wiced_audio_get_statistics.
Used by the A2DP source to read A2DP streaming statistics
| [out] | buffer_stat | : pointer to fill statistics. |
Note : This API is not available for 20706A2.
| void wiced_audio_register_buffer_empty_cback | ( | wiced_audio_buffer_empty_cback_t | p_cback | ) |
Function wiced_audio_register_buffer_empty_cback.
Register the callback function to be invoked on audio buffer empty event
| [in] | p_cback | : callback function to be invoked on audio buffer empty event |
| void wiced_audio_set_sinwave | ( | int16_t * | pIn | ) |
Function wiced_audio_set_sinwave.
Used by the A2DP source to set the sine audio samples to be used in audio streaming when the audio route is set to sine.
| [in] | pOut | : sine audio samples |
| void wiced_audio_start | ( | int | is_master, |
| int | audio_route, | ||
| uint16_t | lcid, | ||
| wiced_bt_a2d_sbc_cie_t * | pSbc | ||
| ) |
Function wiced_audio_start.
To start the audio streaming
| [in] | is_master | : If the I2S has to configured as master |
| [in] | audio_route | : Audio route to be configured. Configure as AUDIO_ROUTE_I2S if the audio source is I2S Configure as AUDIO_ROUTE_UART if the audio source is FILE Configure as AUDIO_ROUTE_SINE if the audio source is the stored sine wave |
| [in] | lcid | : lcid |
| [in] | pSbc | : SBC codec info |
| void wiced_audio_stop | ( | uint16_t | lcid | ) |
Function wiced_audio_stop.
To stop the audio streaming
| [in] | lcid | : lcid |
| void wiced_audio_suspend | ( | uint16_t | lcid, |
| wiced_audio_suspend_complete_cback_t | p_cback | ||
| ) |
Function wiced_audio_suspend.
To suspend the audio streaming
| [in] | lcid | : lcid |
| void wiced_audio_use_sw_timing | ( | int | enable | ) |
Function wiced_audio_use_sw_timing.
Used by the A2DP source to time the audio data using software timer. Sofware timer internally uses slot timer to time the audio data. Period of the software timer is determined based on the chosen audio codec sampling frequency and the number of samples. Note: I2S interrupts are used for timing the audio data by default. Software timer can also be used for timing the audio data which can be enabled by using the API wiced_audio_use_sw_timing. Enable the software timer before invoking wiced_audio_start.
| [in] | enable | : enables the sw timer |
