Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_cap_commander_cb Struct Reference

Callback structure for CAP procedures. More...

#include <cap.h>

Data Fields

void(* discovery_complete )(struct bt_conn *conn, int err, const struct bt_csip_set_coordinator_set_member *member, const struct bt_csip_set_coordinator_csis_inst *csis_inst)
 Callback for bt_cap_initiator_unicast_discover().
 
void(* volume_changed )(struct bt_conn *conn, int err)
 Callback for bt_cap_commander_change_volume().
 
void(* volume_mute_changed )(struct bt_conn *conn, int err)
 Callback for bt_cap_commander_change_volume_mute_state().
 
void(* volume_offset_changed )(struct bt_conn *conn, int err)
 Callback for bt_cap_commander_change_volume_offset().
 
void(* microphone_mute_changed )(struct bt_conn *conn, int err)
 Callback for bt_cap_commander_change_microphone_mute_state().
 
void(* microphone_gain_changed )(struct bt_conn *conn, int err)
 Callback for bt_cap_commander_change_microphone_gain_setting().
 
void(* broadcast_reception_start )(struct bt_conn *conn, int err)
 Callback for bt_cap_commander_broadcast_reception_start().
 
void(* broadcast_reception_stop )(struct bt_conn *conn, int err)
 Callback for bt_cap_commander_broadcast_reception_stop().
 

Detailed Description

Callback structure for CAP procedures.

Field Documentation

◆ broadcast_reception_start

void(* bt_cap_commander_cb::broadcast_reception_start) (struct bt_conn *conn, int err)

Callback for bt_cap_commander_broadcast_reception_start().

Parameters
connPointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_commander_cancel()
err0 on success, BT_GATT_ERR() with a specific ATT (BT_ATT_ERR_*) error code or -ECANCELED if cancelled by bt_cap_commander_cancel().

◆ broadcast_reception_stop

void(* bt_cap_commander_cb::broadcast_reception_stop) (struct bt_conn *conn, int err)

Callback for bt_cap_commander_broadcast_reception_stop().

Parameters
connPointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_commander_cancel()
err0 on success, BT_GATT_ERR() with a specific ATT (BT_ATT_ERR_*) error code or -ECANCELED if cancelled by bt_cap_commander_cancel().

◆ discovery_complete

void(* bt_cap_commander_cb::discovery_complete) (struct bt_conn *conn, int err, const struct bt_csip_set_coordinator_set_member *member, const struct bt_csip_set_coordinator_csis_inst *csis_inst)

Callback for bt_cap_initiator_unicast_discover().

Parameters
connThe connection pointer supplied to bt_cap_initiator_unicast_discover().
err0 if Common Audio Service was found else -ENODATA.
memberPointer to the set member. NULL if err != 0.
csis_instThe Coordinated Set Identification Service if Common Audio Service was found and includes a Coordinated Set Identification Service. NULL on error or if remote device does not include Coordinated Set Identification Service. NULL if err != 0.

◆ microphone_gain_changed

void(* bt_cap_commander_cb::microphone_gain_changed) (struct bt_conn *conn, int err)

Callback for bt_cap_commander_change_microphone_gain_setting().

Parameters
connPointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_commander_cancel()
err0 on success, BT_GATT_ERR() with a specific ATT (BT_ATT_ERR_*) error code or -ECANCELED if cancelled by bt_cap_commander_cancel().

◆ microphone_mute_changed

void(* bt_cap_commander_cb::microphone_mute_changed) (struct bt_conn *conn, int err)

Callback for bt_cap_commander_change_microphone_mute_state().

Parameters
connPointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_commander_cancel()
err0 on success, BT_GATT_ERR() with a specific ATT (BT_ATT_ERR_*) error code or -ECANCELED if cancelled by bt_cap_commander_cancel().

◆ volume_changed

void(* bt_cap_commander_cb::volume_changed) (struct bt_conn *conn, int err)

Callback for bt_cap_commander_change_volume().

Parameters
connPointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_commander_cancel()
err0 on success, BT_GATT_ERR() with a specific ATT (BT_ATT_ERR_*) error code or -ECANCELED if cancelled by bt_cap_commander_cancel().

◆ volume_mute_changed

void(* bt_cap_commander_cb::volume_mute_changed) (struct bt_conn *conn, int err)

Callback for bt_cap_commander_change_volume_mute_state().

Parameters
connPointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_commander_cancel()
err0 on success, BT_GATT_ERR() with a specific ATT (BT_ATT_ERR_*) error code or -ECANCELED if cancelled by bt_cap_commander_cancel().

◆ volume_offset_changed

void(* bt_cap_commander_cb::volume_offset_changed) (struct bt_conn *conn, int err)

Callback for bt_cap_commander_change_volume_offset().

Parameters
connPointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_commander_cancel()
err0 on success, BT_GATT_ERR() with a specific ATT (BT_ATT_ERR_*) error code or -ECANCELED if cancelled by bt_cap_commander_cancel().

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