Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
 4.1.99
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
hfp_hf.h File Reference

Handsfree Profile handling. More...

Go to the source code of this file.

Data Structures

struct  bt_hfp_hf_cb
 HFP profile application callback. More...
 

Macros

#define BT_HFP_HF_CODEC_CVSD   0x01
 
#define BT_HFP_HF_CODEC_MSBC   0x02
 
#define BT_HFP_HF_CODEC_LC3_SWB   0x03
 

Enumerations

enum  hfp_hf_ag_indicators {
  HF_SERVICE_IND = 0 , HF_CALL_IND , HF_CALL_SETUP_IND , HF_CALL_HELD_IND ,
  HF_SIGNAL_IND , HF_ROAM_IND , HF_BATTERY_IND
}
 

Functions

int bt_hfp_hf_register (struct bt_hfp_hf_cb *cb)
 Register HFP HF profile.
 
int bt_hfp_hf_connect (struct bt_conn *conn, struct bt_hfp_hf **hf, uint8_t channel)
 Initiate the service level connection establishment procedure.
 
int bt_hfp_hf_disconnect (struct bt_hfp_hf *hf)
 Release the service level connection.
 
int bt_hfp_hf_cli (struct bt_hfp_hf *hf, bool enable)
 Handsfree HF enable/disable Calling Line Identification (CLI) Notification.
 
int bt_hfp_hf_vgm (struct bt_hfp_hf *hf, uint8_t gain)
 Handsfree HF report Gain of Microphone (VGM)
 
int bt_hfp_hf_vgs (struct bt_hfp_hf *hf, uint8_t gain)
 Handsfree HF report Gain of Speaker (VGS)
 
int bt_hfp_hf_get_operator (struct bt_hfp_hf *hf)
 Handsfree HF requests currently selected operator.
 
int bt_hfp_hf_accept (struct bt_hfp_hf_call *call)
 Handsfree HF accept the incoming call.
 
int bt_hfp_hf_reject (struct bt_hfp_hf_call *call)
 Handsfree HF reject the incoming call.
 
int bt_hfp_hf_terminate (struct bt_hfp_hf_call *call)
 Handsfree HF terminate the incoming call.
 
int bt_hfp_hf_hold_incoming (struct bt_hfp_hf_call *call)
 Handsfree HF put the incoming call on hold.
 
int bt_hfp_hf_query_respond_hold_status (struct bt_hfp_hf *hf)
 Handsfree HF query respond and hold status of AG.
 
int bt_hfp_hf_number_call (struct bt_hfp_hf *hf, const char *number)
 Handsfree HF phone number call.
 
int bt_hfp_hf_memory_dial (struct bt_hfp_hf *hf, const char *location)
 Handsfree HF memory dialing call.
 
int bt_hfp_hf_redial (struct bt_hfp_hf *hf)
 Handsfree HF redial last number.
 
int bt_hfp_hf_audio_connect (struct bt_hfp_hf *hf)
 Handsfree HF setup audio connection.
 
int bt_hfp_hf_select_codec (struct bt_hfp_hf *hf, uint8_t codec_id)
 Handsfree HF set selected codec id.
 
int bt_hfp_hf_set_codecs (struct bt_hfp_hf *hf, uint8_t codec_ids)
 Handsfree HF set supported codec ids.
 
int bt_hfp_hf_turn_off_ecnr (struct bt_hfp_hf *hf)
 Handsfree HF turns off AG's EC and NR.
 
int bt_hfp_hf_call_waiting_notify (struct bt_hfp_hf *hf, bool enable)
 Handsfree HF enable/disable call waiting notification.
 
int bt_hfp_hf_release_all_held (struct bt_hfp_hf *hf)
 Handsfree HF release all held calls.
 
int bt_hfp_hf_set_udub (struct bt_hfp_hf *hf)
 Handsfree HF set User Determined User Busy (UDUB) for a waiting call.
 
int bt_hfp_hf_release_active_accept_other (struct bt_hfp_hf *hf)
 Handsfree HF release all active calls and accept other call.
 
int bt_hfp_hf_hold_active_accept_other (struct bt_hfp_hf *hf)
 Handsfree HF hold all active calls and accept other call.
 
int bt_hfp_hf_join_conversation (struct bt_hfp_hf *hf)
 Handsfree HF add a held call to the conversation.
 
int bt_hfp_hf_explicit_call_transfer (struct bt_hfp_hf *hf)
 Handsfree HF explicit call transfer.
 
int bt_hfp_hf_release_specified_call (struct bt_hfp_hf_call *call)
 Handsfree HF release call with specified index.
 
int bt_hfp_hf_private_consultation_mode (struct bt_hfp_hf_call *call)
 Handsfree HF request private consultation mode with specified call.
 
int bt_hfp_hf_voice_recognition (struct bt_hfp_hf *hf, bool activate)
 Handsfree HF enable/disable the voice recognition function.
 
int bt_hfp_hf_ready_to_accept_audio (struct bt_hfp_hf *hf)
 Handsfree HF indicate that the HF is ready to accept audio.
 
int bt_hfp_hf_request_phone_number (struct bt_hfp_hf *hf)
 Handsfree HF attach a phone number for a voice tag.
 
int bt_hfp_hf_transmit_dtmf_code (struct bt_hfp_hf_call *call, char code)
 Handsfree HF Transmit A specific DTMF Code.
 
int bt_hfp_hf_query_subscriber (struct bt_hfp_hf *hf)
 Handsfree HF Query Subscriber Number Information.
 
int bt_hfp_hf_indicator_status (struct bt_hfp_hf *hf, uint8_t status)
 Handsfree HF set AG indicator activated/deactivated status.
 
int bt_hfp_hf_enhanced_safety (struct bt_hfp_hf *hf, bool enable)
 Handsfree HF enable/disable enhanced safety.
 
int bt_hfp_hf_battery (struct bt_hfp_hf *hf, uint8_t level)
 Handsfree HF remaining battery level.
 

Detailed Description

Handsfree Profile handling.