Zephyr API Documentation  3.7.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_hfp_hf_cb Struct Reference

HFP profile application callback. More...

#include <hfp_hf.h>

Data Fields

void(* connected )(struct bt_conn *conn)
 HF connected callback to application.
 
void(* disconnected )(struct bt_conn *conn)
 HF disconnected callback to application.
 
void(* sco_connected )(struct bt_conn *conn, struct bt_conn *sco_conn)
 HF SCO/eSCO connected Callback.
 
void(* sco_disconnected )(struct bt_conn *sco_conn, uint8_t reason)
 HF SCO/eSCO disconnected Callback.
 
void(* service )(struct bt_conn *conn, uint32_t value)
 HF indicator Callback.
 
void(* call )(struct bt_conn *conn, uint32_t value)
 HF indicator Callback.
 
void(* call_setup )(struct bt_conn *conn, uint32_t value)
 HF indicator Callback.
 
void(* call_held )(struct bt_conn *conn, uint32_t value)
 HF indicator Callback.
 
void(* signal )(struct bt_conn *conn, uint32_t value)
 HF indicator Callback.
 
void(* roam )(struct bt_conn *conn, uint32_t value)
 HF indicator Callback.
 
void(* battery )(struct bt_conn *conn, uint32_t value)
 HF indicator Callback.
 
void(* ring_indication )(struct bt_conn *conn)
 HF incoming call Ring indication callback to application.
 
void(* cmd_complete_cb )(struct bt_conn *conn, struct bt_hfp_hf_cmd_complete *cmd)
 HF notify command completed callback to application.
 

Detailed Description

HFP profile application callback.

Field Documentation

◆ battery

void(* bt_hfp_hf_cb::battery) (struct bt_conn *conn, uint32_t value)

HF indicator Callback.

This callback battery service indicator value to the application

Parameters
connConnection object.
valuebattery indicator value received from the AG.

◆ call

void(* bt_hfp_hf_cb::call) (struct bt_conn *conn, uint32_t value)

HF indicator Callback.

This callback provides call indicator value to the application

Parameters
connConnection object.
valuecall indicator value received from the AG.

◆ call_held

void(* bt_hfp_hf_cb::call_held) (struct bt_conn *conn, uint32_t value)

HF indicator Callback.

This callback provides call held indicator value to the application

Parameters
connConnection object.
valuecall held indicator value received from the AG.

◆ call_setup

void(* bt_hfp_hf_cb::call_setup) (struct bt_conn *conn, uint32_t value)

HF indicator Callback.

This callback provides call setup indicator value to the application

Parameters
connConnection object.
valuecall setup indicator value received from the AG.

◆ cmd_complete_cb

void(* bt_hfp_hf_cb::cmd_complete_cb) (struct bt_conn *conn, struct bt_hfp_hf_cmd_complete *cmd)

HF notify command completed callback to application.

The command sent from the application is notified about its status

Parameters
connConnection object.
cmdstructure contains status of the command including cme.

◆ connected

void(* bt_hfp_hf_cb::connected) (struct bt_conn *conn)

HF connected callback to application.

If this callback is provided it will be called whenever the connection completes.

Parameters
connConnection object.

◆ disconnected

void(* bt_hfp_hf_cb::disconnected) (struct bt_conn *conn)

HF disconnected callback to application.

If this callback is provided it will be called whenever the connection gets disconnected, including when a connection gets rejected or cancelled or any error in SLC establishment.

Parameters
connConnection object.

◆ ring_indication

void(* bt_hfp_hf_cb::ring_indication) (struct bt_conn *conn)

HF incoming call Ring indication callback to application.

If this callback is provided it will be called whenever there is an incoming call.

Parameters
connConnection object.

◆ roam

void(* bt_hfp_hf_cb::roam) (struct bt_conn *conn, uint32_t value)

HF indicator Callback.

This callback provides roaming indicator value to the application

Parameters
connConnection object.
valueroaming indicator value received from the AG.

◆ sco_connected

void(* bt_hfp_hf_cb::sco_connected) (struct bt_conn *conn, struct bt_conn *sco_conn)

HF SCO/eSCO connected Callback.

If this callback is provided it will be called whenever the SCO/eSCO connection completes.

Parameters
connConnection object.
sco_connSCO/eSCO Connection object.

◆ sco_disconnected

void(* bt_hfp_hf_cb::sco_disconnected) (struct bt_conn *sco_conn, uint8_t reason)

HF SCO/eSCO disconnected Callback.

If this callback is provided it will be called whenever the SCO/eSCO connection gets disconnected.

Parameters
connConnection object.
reasonBT_HCI_ERR_* reason for the disconnection.

◆ service

void(* bt_hfp_hf_cb::service) (struct bt_conn *conn, uint32_t value)

HF indicator Callback.

This callback provides service indicator value to the application

Parameters
connConnection object.
valueservice indicator value received from the AG.

◆ signal

void(* bt_hfp_hf_cb::signal) (struct bt_conn *conn, uint32_t value)

HF indicator Callback.

This callback provides signal indicator value to the application

Parameters
connConnection object.
valuesignal indicator value received from the AG.

The documentation for this struct was generated from the following file: