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

Struct to hold the Basic Audio Profile Scan Delegator callbacks. More...

#include <bap.h>

Data Fields

void(* recv_state_updated )(struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state)
 Receive state updated.
 
int(* pa_sync_req )(struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state, bool past_avail, uint16_t pa_interval)
 Periodic advertising sync request.
 
int(* pa_sync_term_req )(struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state)
 Periodic advertising sync termination request.
 
void(* broadcast_code )(struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state, const uint8_t broadcast_code[BT_ISO_BROADCAST_CODE_SIZE])
 Broadcast code received.
 
int(* bis_sync_req )(struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state, const uint32_t bis_sync_req[CONFIG_BT_BAP_BASS_MAX_SUBGROUPS])
 Broadcast Isochronous Stream synchronize request.
 
void(* scanning_state )(struct bt_conn *conn, bool is_scanning)
 Broadcast Assistant scanning state callback.
 

Detailed Description

Struct to hold the Basic Audio Profile Scan Delegator callbacks.

These can be registered for usage with bt_bap_scan_delegator_register().

Field Documentation

◆ bis_sync_req

int(* bt_bap_scan_delegator_cb::bis_sync_req) (struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state, const uint32_t bis_sync_req[CONFIG_BT_BAP_BASS_MAX_SUBGROUPS])

Broadcast Isochronous Stream synchronize request.

Request from Broadcast Assistant device to modify the Broadcast Isochronous Stream states. The request shall be fulfilled with accordance to the bis_sync_req within reasonable time. The Broadcast Assistant may also request fewer, or none, indexes to be synchronized.

Parameters
[in]connPointer to the connection of the Broadcast Assistant requesting the sync.
[in]recv_statePointer to the receive state that is being requested for the sync.
[in]bis_sync_reqArray of bitfields of which BIS indexes that is requested to sync for each subgroup by the Broadcast Assistant. A value of 0 indicates a request to terminate the BIG sync.
Returns
0 in case of accept, or other value to reject.

◆ broadcast_code

void(* bt_bap_scan_delegator_cb::broadcast_code) (struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state, const uint8_t broadcast_code[BT_ISO_BROADCAST_CODE_SIZE])

Broadcast code received.

Broadcast code received from a broadcast assistant

Parameters
connPointer to the connection providing the broadcast code.
recv_statePointer to the receive state the broadcast code is being provided for.
broadcast_codeThe 16-octet broadcast code

◆ pa_sync_req

int(* bt_bap_scan_delegator_cb::pa_sync_req) (struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state, bool past_avail, uint16_t pa_interval)

Periodic advertising sync request.

Request from peer device to synchronize with the periodic advertiser denoted by the recv_state. To notify the Broadcast Assistant about any pending sync

Parameters
connPointer to the connection requesting the periodic advertising sync.
recv_statePointer to the receive state that is being requested for periodic advertising sync.
past_availTrue if periodic advertising sync transfer is available.
pa_intervalThe periodic advertising interval.
Returns
0 in case of accept, or other value to reject.

◆ pa_sync_term_req

int(* bt_bap_scan_delegator_cb::pa_sync_term_req) (struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state)

Periodic advertising sync termination request.

Request from peer device to terminate the periodic advertiser sync denoted by the recv_state.

Parameters
connPointer to the connection requesting the periodic advertising sync termination.
recv_statePointer to the receive state that is being requested for periodic advertising sync.
Returns
0 in case of success or negative value in case of error.

◆ recv_state_updated

void(* bt_bap_scan_delegator_cb::recv_state_updated) (struct bt_conn *conn, const struct bt_bap_scan_delegator_recv_state *recv_state)

Receive state updated.

Parameters
connPointer to the connection to a remote device if the change was caused by it, otherwise NULL.
recv_statePointer to the receive state that was updated.
Returns
0 in case of success or negative value in case of error.

◆ scanning_state

void(* bt_bap_scan_delegator_cb::scanning_state) (struct bt_conn *conn, bool is_scanning)

Broadcast Assistant scanning state callback.

Callback triggered when a Broadcast Assistant notifies the Scan Delegator about the assistants scanning state.

Parameters
connPointer to the connection that initiated the scan.
is_scanningtrue if scanning started, false if scanning stopped.

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