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

Broadcast Audio Sink callback structure. More...

#include <bap.h>

Data Fields

void(* base_recv )(struct bt_bap_broadcast_sink *sink, const struct bt_bap_base *base, size_t base_size)
 Broadcast Audio Source Endpoint (BASE) received.
 
void(* syncable )(struct bt_bap_broadcast_sink *sink, const struct bt_iso_biginfo *biginfo)
 Broadcast sink is syncable.
 
void(* started )(struct bt_bap_broadcast_sink *sink)
 The Broadcast Sink has started and audio data may be received from all of the streams.
 
void(* stopped )(struct bt_bap_broadcast_sink *sink, uint8_t reason)
 The Broadcast Sink has stopped and none of the streams will receive audio data.
 

Detailed Description

Broadcast Audio Sink callback structure.

Field Documentation

◆ base_recv

void(* bt_bap_broadcast_sink_cb::base_recv) (struct bt_bap_broadcast_sink *sink, const struct bt_bap_base *base, size_t base_size)

Broadcast Audio Source Endpoint (BASE) received.

Callback for when we receive a BASE from a broadcaster after syncing to the broadcaster's periodic advertising.

Parameters
sinkPointer to the sink structure.
baseBroadcast Audio Source Endpoint (BASE).
base_sizeSize of the base

◆ started

void(* bt_bap_broadcast_sink_cb::started) (struct bt_bap_broadcast_sink *sink)

The Broadcast Sink has started and audio data may be received from all of the streams.

Parameters
sinkThe started Broadcast Sink

◆ stopped

void(* bt_bap_broadcast_sink_cb::stopped) (struct bt_bap_broadcast_sink *sink, uint8_t reason)

The Broadcast Sink has stopped and none of the streams will receive audio data.

Parameters
sinkThe stopped Broadcast Sink
reasonThe reason why the Broadcast Sink stopped (see the BT_HCI_ERR_* values)

◆ syncable

void(* bt_bap_broadcast_sink_cb::syncable) (struct bt_bap_broadcast_sink *sink, const struct bt_iso_biginfo *biginfo)

Broadcast sink is syncable.

Called whenever a broadcast sink is not synchronized to audio, but the audio is synchronizable. This is inferred when a BIGInfo report is received.

Once this callback has been called, it is possible to call bt_bap_broadcast_sink_sync() to synchronize to the audio stream(s).

Parameters
sinkPointer to the sink structure.
biginfoThe BIGInfo report.

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