 |
AIROC™ BTSDK v4.2 - Documentation | |||
|
AIROC™ BTSDK v4.2 - Documentation | |||
Copyright 2016-2023, Cypress Semiconductor Corporation (an Infineon company) or an affiliate of Cypress Semiconductor Corporation. More...
Data Structures | |
| struct | codec_config_t |
| Codec configuration. More... | |
| struct | audio_config_t |
| Audio configuration. More... | |
| struct | nrec_config_t |
| NREC configuration. More... | |
| struct | stream_interface_t |
| Stream Interface Functions. More... | |
| struct | capture_stream_interface_t |
| Capture stream interface. More... | |
| struct | render_stream_interface_t |
| Render stream interface. More... | |
Enumerations | |
| enum | stream_type_t { CAPTURE, RENDER, FILE_PLAYBACK, A2DP_PLAYBACK, HFP, MAX_NO_OF_STREAMS, STREAM_TYPE_INVALD = MAX_NO_OF_STREAMS } |
| Audio Streams. More... | |
| enum | param_type_t { AM_CODEC_CONFIG, AM_AUDIO_CONFIG, AM_SAMPLE_RATE, AM_CHANNELS, AM_BITS_PER_SAMPLE, AM_MIC_GAIN_LEVEL, AM_SPEAKER_VOL_LEVEL, AM_NREC_ENABLE, AM_NREC_DISABLE, AM_GAIN_CONFIG, AM_NREC_CONFIG, AM_IO_DEVICE } |
| Audio Parameter types. More... | |
| enum | am_audio_io_device_t { AM_SPEAKERS, AM_HEADPHONES, AM_UART } |
| audio output type | |
Functions | |
| void | wiced_am_init (void) |
| The application should call this function to Initialize the Audio Manager. More... | |
| int32_t | wiced_am_stream_open (uint32_t stream_type) |
| The application should call this function to open the stream This will construct the graph of various components in the chain based on the stream type. More... | |
| wiced_result_t | wiced_am_stream_start (int32_t stream_id) |
| The application should call this function to start the stream. More... | |
| wiced_result_t | wiced_am_stream_stop (int32_t stream_id) |
| The application should call this function to stop the stream. More... | |
| wiced_result_t | wiced_am_stream_close (int32_t stream_id) |
| The application should call this function to close the stream. More... | |
| wiced_result_t | wiced_am_stream_set_param (int32_t stream_id, uint32_t param_type, void *param_config) |
| The application should call this function to set the parameters of the stream. More... | |
| int32_t | wiced_am_stream_get_param (uint32_t stream_id, uint32_t param_type, void *param_config) |
| The application should call this function to get parameters of the stream. More... | |
| stream_interface_t * | wiced_am_stream_get_intf (uint32_t stream_id, uint32_t inf_type) |
| The application should call this function to get interface of the stream. More... | |
Copyright 2016-2023, Cypress Semiconductor Corporation (an Infineon company) or an affiliate of Cypress Semiconductor Corporation.
All rights reserved.
This software, including source code, documentation and related materials ("Software") is owned by Cypress Semiconductor Corporation or one of its affiliates ("Cypress") and is protected by and subject to worldwide patent protection (United States and foreign), United States copyright laws and international treaty provisions. Therefore, you may use this Software only as provided in the license agreement accompanying the software package from which you obtained this Software ("EULA"). If no EULA applies, Cypress hereby grants you a personal, non-exclusive, non-transferable license to copy, modify, and compile the Software source code solely for use in connection with Cypress's integrated circuit products. Any reproduction, modification, translation, compilation, or representation of this Software except as specified above is prohibited without the express written permission of Cypress.
Disclaimer: THIS SOFTWARE IS PROVIDED AS-IS, WITH NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, NONINFRINGEMENT, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress reserves the right to make changes to the Software without notice. Cypress does not assume any liability arising out of the application or use of the Software or any product or circuit described in the Software. Cypress does not authorize its products for use in any products where a malfunction or failure of the Cypress product may reasonably be expected to result in significant property damage, injury or death ("High Risk Product"). By including Cypress's product in a High Risk Product, the manufacturer of such system or application assumes all risk of such use and in doing so agrees to indemnify Cypress against all liability.
Audio manager is a high level interface for applications to use platform audio capabilities. It supports different streams like A2DP_PLAYBACK, HFP etc. Audio manager also has interface for specific stream Start, Stop and also stream specific volume control.
| enum param_type_t |
Audio Parameter types.
| enum stream_type_t |
| void wiced_am_init | ( | void | ) |
The application should call this function to Initialize the Audio Manager.
| NO | parameters required. |
| wiced_result_t wiced_am_stream_close | ( | int32_t | stream_id | ) |
The application should call this function to close the stream.
| stream_id | : Id of the stream. |
| stream_interface_t* wiced_am_stream_get_intf | ( | uint32_t | stream_id, |
| uint32_t | inf_type | ||
| ) |
The application should call this function to get interface of the stream.
| stream_id | : Id of the stream. |
| inf_type | : Interface type. |
| int32_t wiced_am_stream_get_param | ( | uint32_t | stream_id, |
| uint32_t | param_type, | ||
| void * | param_config | ||
| ) |
The application should call this function to get parameters of the stream.
| stream_id | : Id of the stream. |
| param_type | : Type of the parameters to be set. |
| param_config | Parameter configurations |
| int32_t wiced_am_stream_open | ( | uint32_t | stream_type | ) |
The application should call this function to open the stream This will construct the graph of various components in the chain based on the stream type.
| stream_type | : Type of the stream to register (stream_type_t) |
| args | : Arguments to be passed if any. |
| wiced_result_t wiced_am_stream_set_param | ( | int32_t | stream_id, |
| uint32_t | param_type, | ||
| void * | param_config | ||
| ) |
The application should call this function to set the parameters of the stream.
| stream_id | : Id of the stream. |
| param_type | : Type of the parameters to be set. |
| param_config | Parameter configurations |
| wiced_result_t wiced_am_stream_start | ( | int32_t | stream_id | ) |
The application should call this function to start the stream.
| stream_id | : Id of the stream. |
| wiced_result_t wiced_am_stream_stop | ( | int32_t | stream_id | ) |
The application should call this function to stop the stream.
| stream_id | : Id of the stream. |
