Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_bap_broadcast_assistant_cb Struct Reference

Struct to hold the Basic Audio Profile Broadcast Assistant callbacks. More...

#include <bap.h>

Data Fields

void(* discover )(struct bt_conn *conn, int err, uint8_t recv_state_count)
 Callback function for bt_bap_broadcast_assistant_discover.
 
void(* scan )(const struct bt_le_scan_recv_info *info, uint32_t broadcast_id)
 Callback function for Broadcast Audio Scan Service client scan results.
 
void(* recv_state )(struct bt_conn *conn, int err, const struct bt_bap_scan_delegator_recv_state *state)
 Callback function for when a receive state is read or updated.
 
void(* recv_state_removed )(struct bt_conn *conn, uint8_t src_id)
 Callback function for when a receive state is removed.
 
void(* scan_start )(struct bt_conn *conn, int err)
 Callback function for bt_bap_broadcast_assistant_scan_start().
 
void(* scan_stop )(struct bt_conn *conn, int err)
 Callback function for bt_bap_broadcast_assistant_scan_stop().
 
void(* add_src )(struct bt_conn *conn, int err)
 Callback function for bt_bap_broadcast_assistant_add_src().
 
void(* mod_src )(struct bt_conn *conn, int err)
 Callback function for bt_bap_broadcast_assistant_mod_src().
 
void(* broadcast_code )(struct bt_conn *conn, int err)
 Callback function for bt_bap_broadcast_assistant_set_broadcast_code().
 
void(* rem_src )(struct bt_conn *conn, int err)
 Callback function for bt_bap_broadcast_assistant_rem_src().
 

Detailed Description

Struct to hold the Basic Audio Profile Broadcast Assistant callbacks.

These can be registered for usage with bt_bap_broadcast_assistant_register_cb().

Field Documentation

◆ add_src

void(* bt_bap_broadcast_assistant_cb::add_src) (struct bt_conn *conn, int err)

Callback function for bt_bap_broadcast_assistant_add_src().

Parameters
connThe connection to the peer device.
errError value. 0 on success, GATT error on fail.

◆ broadcast_code

void(* bt_bap_broadcast_assistant_cb::broadcast_code) (struct bt_conn *conn, int err)

Callback function for bt_bap_broadcast_assistant_set_broadcast_code().

Parameters
connThe connection to the peer device.
errError value. 0 on success, GATT error on fail.

◆ discover

void(* bt_bap_broadcast_assistant_cb::discover) (struct bt_conn *conn, int err, uint8_t recv_state_count)

Callback function for bt_bap_broadcast_assistant_discover.

Parameters
connThe connection that was used to discover Broadcast Audio Scan Service.
errError value. 0 on success, GATT error or ERRNO on fail.
recv_state_countNumber of receive states on the server.

◆ mod_src

void(* bt_bap_broadcast_assistant_cb::mod_src) (struct bt_conn *conn, int err)

Callback function for bt_bap_broadcast_assistant_mod_src().

Parameters
connThe connection to the peer device.
errError value. 0 on success, GATT error on fail.

◆ recv_state

void(* bt_bap_broadcast_assistant_cb::recv_state) (struct bt_conn *conn, int err, const struct bt_bap_scan_delegator_recv_state *state)

Callback function for when a receive state is read or updated.

Called whenever a receive state is read or updated.

Parameters
connThe connection to the Broadcast Audio Scan Service server.
errError value. 0 on success, GATT error on fail.
stateThe receive state or NULL if the receive state is empty.

◆ recv_state_removed

void(* bt_bap_broadcast_assistant_cb::recv_state_removed) (struct bt_conn *conn, uint8_t src_id)

Callback function for when a receive state is removed.

Parameters
connThe connection to the Broadcast Audio Scan Service server.
src_idThe receive state.

◆ rem_src

void(* bt_bap_broadcast_assistant_cb::rem_src) (struct bt_conn *conn, int err)

Callback function for bt_bap_broadcast_assistant_rem_src().

Parameters
connThe connection to the peer device.
errError value. 0 on success, GATT error on fail.

◆ scan

void(* bt_bap_broadcast_assistant_cb::scan) (const struct bt_le_scan_recv_info *info, uint32_t broadcast_id)

Callback function for Broadcast Audio Scan Service client scan results.

Called when the scanner finds an advertiser that advertises the BT_UUID_BROADCAST_AUDIO UUID.

Parameters
infoAdvertiser information.
broadcast_id24-bit broadcast ID.

◆ scan_start

void(* bt_bap_broadcast_assistant_cb::scan_start) (struct bt_conn *conn, int err)

Callback function for bt_bap_broadcast_assistant_scan_start().

Parameters
connThe connection to the peer device.
errError value. 0 on success, GATT error on fail.

◆ scan_stop

void(* bt_bap_broadcast_assistant_cb::scan_stop) (struct bt_conn *conn, int err)

Callback function for bt_bap_broadcast_assistant_scan_stop().

Parameters
connThe connection to the peer device.
errError value. 0 on success, GATT error on fail.

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