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_ag.h File Reference

Handsfree Profile Audio Gateway handling. More...

Go to the source code of this file.

Data Structures

struct  bt_hfp_ag_cb
 HFP profile AG application callback. More...
 

Macros

#define BT_HFP_AG_CODEC_CVSD   0x01
 
#define BT_HFP_AG_CODEC_MSBC   0x02
 
#define BT_HFP_AG_CODEC_LC3_SWB   0x03
 

Typedefs

typedef int(* bt_hfp_ag_query_subscriber_func_t) (struct bt_hfp_ag *ag, char *number, uint8_t type, uint8_t service)
 Query subscriber number callback function.
 

Enumerations

enum  bt_hfp_ag_indicator {
  BT_HFP_AG_SERVICE_IND = 0 , BT_HFP_AG_CALL_IND = 1 , BT_HFP_AG_CALL_SETUP_IND = 2 , BT_HFP_AG_CALL_HELD_IND = 3 ,
  BT_HFP_AG_SIGNAL_IND = 4 , BT_HFP_AG_ROAM_IND = 5 , BT_HFP_AG_BATTERY_IND = 6 , BT_HFP_AG_IND_MAX
}
 
enum  hfp_ag_hf_indicators { HFP_AG_ENHANCED_SAFETY_IND = 1 , HFP_AG_BATTERY_LEVEL_IND = 2 }
 

Functions

int bt_hfp_ag_register (struct bt_hfp_ag_cb *cb)
 Register HFP AG profile.
 
int bt_hfp_ag_connect (struct bt_conn *conn, struct bt_hfp_ag **ag, uint8_t channel)
 Create the hfp ag session.
 
int bt_hfp_ag_disconnect (struct bt_hfp_ag *ag)
 Disconnect the hfp ag session.
 
int bt_hfp_ag_remote_incoming (struct bt_hfp_ag *ag, const char *number)
 Notify HFP Unit of an incoming call.
 
int bt_hfp_ag_hold_incoming (struct bt_hfp_ag_call *call)
 Put the incoming call on hold.
 
int bt_hfp_ag_reject (struct bt_hfp_ag_call *call)
 Reject the incoming call.
 
int bt_hfp_ag_accept (struct bt_hfp_ag_call *call)
 Accept the incoming call.
 
int bt_hfp_ag_terminate (struct bt_hfp_ag_call *call)
 Terminate the active/hold call.
 
int bt_hfp_ag_retrieve (struct bt_hfp_ag_call *call)
 Retrieve the held call.
 
int bt_hfp_ag_hold (struct bt_hfp_ag_call *call)
 Hold the active call.
 
int bt_hfp_ag_outgoing (struct bt_hfp_ag *ag, const char *number)
 Dial a call.
 
int bt_hfp_ag_remote_ringing (struct bt_hfp_ag_call *call)
 Notify HFP Unit that the remote starts ringing.
 
int bt_hfp_ag_remote_reject (struct bt_hfp_ag_call *call)
 Notify HFP Unit that the remote rejects the call.
 
int bt_hfp_ag_remote_accept (struct bt_hfp_ag_call *call)
 Notify HFP Unit that the remote accepts the call.
 
int bt_hfp_ag_remote_terminate (struct bt_hfp_ag_call *call)
 Notify HFP Unit that the remote terminates the active/hold call.
 
int bt_hfp_ag_explicit_call_transfer (struct bt_hfp_ag *ag)
 explicit call transfer
 
int bt_hfp_ag_vgm (struct bt_hfp_ag *ag, uint8_t vgm)
 Set the HF microphone gain.
 
int bt_hfp_ag_vgs (struct bt_hfp_ag *ag, uint8_t vgs)
 Set the HF speaker gain.
 
int bt_hfp_ag_set_operator (struct bt_hfp_ag *ag, uint8_t mode, char *name)
 Set currently network operator.
 
int bt_hfp_ag_audio_connect (struct bt_hfp_ag *ag, uint8_t id)
 Create audio connection.
 
int bt_hfp_ag_inband_ringtone (struct bt_hfp_ag *ag, bool inband)
 Set In-Band Ring Tone.
 
int bt_hfp_ag_voice_recognition (struct bt_hfp_ag *ag, bool activate)
 Enable/disable the voice recognition function.
 
int bt_hfp_ag_vre_state (struct bt_hfp_ag *ag, uint8_t state)
 set voice recognition engine state
 
int bt_hfp_ag_vre_textual_representation (struct bt_hfp_ag *ag, uint8_t state, const char *id, uint8_t type, uint8_t operation, const char *text)
 set voice recognition engine state and textual representation
 
int bt_hfp_ag_signal_strength (struct bt_hfp_ag *ag, uint8_t strength)
 Set signal strength.
 
int bt_hfp_ag_roaming_status (struct bt_hfp_ag *ag, uint8_t status)
 Set roaming status.
 
int bt_hfp_ag_battery_level (struct bt_hfp_ag *ag, uint8_t level)
 Set battery level.
 
int bt_hfp_ag_service_availability (struct bt_hfp_ag *ag, bool available)
 Set service availability.
 
int bt_hfp_ag_hf_indicator (struct bt_hfp_ag *ag, enum hfp_ag_hf_indicators indicator, bool enable)
 Activate/deactivate HF indicator.
 

Detailed Description

Handsfree Profile Audio Gateway handling.