Files | |
file | wiced_bt_hfp_hf.h |
Data Structures | |
struct | wiced_bt_hfp_hf_call_data_t |
struct | wiced_bt_hfp_hf_event_data_t |
struct | wiced_bt_hfp_hf_volume_data_t |
Typedefs | |
typedef void(* | wiced_bt_hfp_hf_event_cb_t )(wiced_bt_hfp_hf_event_t event, wiced_bt_hfp_hf_event_data_t *p_data) |
Functions | |
wiced_result_t | wiced_bt_hfp_hf_connect (wiced_bt_device_address_t bd_address) |
wiced_result_t | wiced_bt_hfp_hf_deinit (void) |
wiced_result_t | wiced_bt_hfp_hf_disconnect (wiced_bt_device_address_t bd_address) |
wiced_result_t | wiced_bt_hfp_hf_init (wiced_bt_hfp_hf_config_data_t *p_config_data, wiced_bt_hfp_hf_event_cb_t event_cb) |
wiced_result_t | wiced_bt_hfp_hf_notify_volume (wiced_bt_device_address_t bd_address, wiced_bt_hfp_hf_volume_type_t volume_type, uint8_t volume_level) |
wiced_result_t | wiced_bt_hfp_hf_perform_call_action (wiced_bt_device_address_t bd_address, wiced_bt_hfp_hf_call_action_t action, char *number) |
wiced_result_t | wiced_bt_hfp_hf_send_at_cmd (wiced_bt_device_address_t bd_address, char *at_cmd) |
The profile defines how two devices supporting the Hands-Free Profile shall interact with each other on a point-to-point basis. An implementation of the Hands-Free Profile typically enables a headset, or an embedded hands-free unit to connect, wirelessly, to a cellular phone for the purposes of acting as the cellular phone's audio input and output mechanism and allowing typical telephony functions to be performed without access to the actual phone.
The most common examples of such devices are in-car Hands-Free units used together with cellular phones, or wearable wireless headsets.
typedef void(* wiced_bt_hfp_hf_event_cb_t)(wiced_bt_hfp_hf_event_t event, wiced_bt_hfp_hf_event_data_t *p_data) |
HF control path callback type
Application implements callback of this type to receive HF events and commands.
event | HF event. |
p_data | pointer to event data. |
AG supported feature flags.
Call action command
States of a call during setup procedure
HF Events. These are received via wiced_bt_hfp_hf_event_cb_t() callback function. See wiced_bt_hfp_hf_event_data_t for payload.
HF device supported feature flags.
wiced_result_t wiced_bt_hfp_hf_connect | ( | wiced_bt_device_address_t | bd_address | ) |
API to initiate a HFP connection to an AG
Called by the application to connect to an AG with the given address.
bd_address | BD address of the AG. |
wiced_result_t wiced_bt_hfp_hf_deinit | ( | void | ) |
API to deregister the HFP-HF component from the stack and to cleanup the internal data structures.
Called by the application when the HFP-HF component is no longer needed by it.
wiced_result_t wiced_bt_hfp_hf_disconnect | ( | wiced_bt_device_address_t | bd_address | ) |
API to disconnect from an AG
Called by the application to disconnect from an AG with the given address.
bd_address | BD address of the AG. |
wiced_result_t wiced_bt_hfp_hf_init | ( | wiced_bt_hfp_hf_config_data_t * | p_config_data, |
wiced_bt_hfp_hf_event_cb_t | event_cb | ||
) |
API to initialize the HFP-HF component and register with the stack.
Called by the application before any other API is called. Application provides the SINK configuration data and callback to receive control events.
num_server | Number of Handsfree server to be created |
a_config_data | HF configuration parameters array for each server. See wiced_bt_hfp_hf_config_data_t. |
event_cb | Callback function for receiving HF events. |
wiced_result_t wiced_bt_hfp_hf_notify_volume | ( | wiced_bt_device_address_t | bd_address, |
wiced_bt_hfp_hf_volume_type_t | volume_type, | ||
uint8_t | volume_level | ||
) |
API to send the current speaker/mic volume level to AG
Called by the application to notify the AG of the change in volume of mic or speaker.
bd_address | BD address of the AG. |
volume_type | Mic or speaker for which the volume was changed. |
volume_level | Volume level from 0 to 15. |
wiced_result_t wiced_bt_hfp_hf_perform_call_action | ( | wiced_bt_device_address_t | bd_address, |
wiced_bt_hfp_hf_call_action_t | action, | ||
char * | number | ||
) |
API to manipulate a call (i.e., to answer, hold, hangup, reject, etc)
Allows the application to take actions indicated in wiced_bt_hfp_hf_call_action_t.
bd_address | BD address of the AG |
action | Action to be initiated, see wiced_bt_hfp_hf_call_action_t. |
number | Contains a NUL terminated number to be called, if NULL, the last number redial (LNR) is initiated. valid when action is WICED_BT_HFP_HF_CALL_ACTION_DIAL, for all other actions this is ignored. |
wiced_result_t wiced_bt_hfp_hf_send_at_cmd | ( | wiced_bt_device_address_t | bd_address, |
char * | at_cmd | ||
) |
API to send the at command to the AG
Called by the application to send an at command to AG. The command sent is pass thru for library. The response is received thru WICED_BT_HFP_HF_AT_RESULT_CODE_IND_EVT.
bd_address | BD address of the AG. |
at_cmd | Null terminated at command string to be sent to AG. |