12#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_CAP_H_
13#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_CAP_H_
51struct bt_cap_broadcast_source;
54struct bt_cap_unicast_group;
75 struct bt_csip_set_member_svc_inst **svc_inst);
79#if defined(CONFIG_BT_BAP_UNICAST_CLIENT) || defined(__DOXYGEN__)
94 struct bt_conn *conn,
int err,
134#if defined(CONFIG_BT_BAP_BROADCAST_SOURCE)
140 void (*broadcast_started)(
struct bt_cap_broadcast_source *source);
148 void (*broadcast_stopped)(
struct bt_cap_broadcast_source *source,
uint8_t reason);
300#if defined(CONFIG_BT_ISO_TEST_PARAMS) || defined(__DOXYGEN__)
346 struct bt_cap_unicast_group **unicast_group);
436 struct bt_bap_ep *
ep;
673#if defined(CONFIG_BT_ISO_TEST_PARAMS) || defined(__DOXYGEN__)
724 struct bt_cap_broadcast_source **broadcast_source);
746 struct bt_le_ext_adv *adv);
762 const uint8_t meta[],
size_t meta_len);
860 struct bt_cap_unicast_group *unicast_group,
861 struct bt_cap_broadcast_source *broadcast_source);
943 struct bt_bap_unicast_group **unicast_group);
964#if defined(CONFIG_BT_VCP_VOL_CTLR) || defined(__DOXYGEN__)
989#if defined(CONFIG_BT_VCP_VOL_CTLR_VOCS) || defined(__DOXYGEN__)
1003#if defined(CONFIG_BT_MICP_MIC_CTLR) || defined(__DOXYGEN__)
1015#if defined(CONFIG_BT_MICP_MIC_CTLR_AICS) || defined(__DOXYGEN__)
1030#if defined(CONFIG_BT_BAP_BROADCAST_ASSISTANT) || defined(__DOXYGEN__)
Bluetooth device address definitions and utilities.
Header for Bluetooth BAP.
Bluetooth Audio handling.
Bluetooth subsystem core APIs.
Bluetooth connection handling.
Bluetooth Coordinated Set Identification Profile (CSIP) APIs.
#define BT_BAP_BASS_MAX_SUBGROUPS
Maximum number of subgroups supported in the BAP Scan Delegator API.
Definition bap.h:48
int bt_cap_commander_discover(struct bt_conn *conn)
Discovers audio support on a remote device.
int bt_cap_commander_change_microphone_mute_state(const struct bt_cap_commander_change_microphone_mute_state_param *param)
Change the microphone mute state on one or more Common Audio Profile Acceptors.
int bt_cap_stream_send_ts(struct bt_cap_stream *stream, struct net_buf *buf, uint16_t seq_num, uint32_t ts)
Send data to Common Audio Profile stream with timestamp.
int bt_cap_commander_broadcast_reception_start(const struct bt_cap_commander_broadcast_reception_start_param *param)
Starts the reception of broadcast audio on one or more remote Common Audio Profile Acceptors.
int bt_cap_unicast_group_create(const struct bt_cap_unicast_group_param *param, struct bt_cap_unicast_group **unicast_group)
Create unicast group.
int bt_cap_initiator_broadcast_audio_start(struct bt_cap_broadcast_source *broadcast_source, struct bt_le_ext_adv *adv)
Start Common Audio Profile broadcast source.
int bt_cap_stream_send(struct bt_cap_stream *stream, struct net_buf *buf, uint16_t seq_num)
Send data to Common Audio Profile stream without timestamp.
int bt_cap_commander_unregister_cb(const struct bt_cap_commander_cb *cb)
Unregister Common Audio Profile Commander callbacks.
int bt_cap_initiator_register_cb(const struct bt_cap_initiator_cb *cb)
Register Common Audio Profile Initiator callbacks.
int bt_cap_handover_register_cb(const struct bt_cap_handover_cb *cb)
Register Common Audio Profile Handover callbacks.
int bt_cap_unicast_group_foreach_stream(struct bt_cap_unicast_group *unicast_group, bt_cap_unicast_group_foreach_stream_func_t func, void *user_data)
Iterate through all streams in a unicast group.
int bt_cap_unicast_group_reconfig(struct bt_cap_unicast_group *unicast_group, const struct bt_cap_unicast_group_param *param)
Reconfigure unicast group.
int bt_cap_initiator_broadcast_get_base(struct bt_cap_broadcast_source *broadcast_source, struct net_buf_simple *base_buf)
Get the Broadcast Audio Stream Endpoint of a Common Audio Profile broadcast source.
int bt_cap_initiator_broadcast_audio_create(const struct bt_cap_initiator_broadcast_create_param *param, struct bt_cap_broadcast_source **broadcast_source)
Create a Common Audio Profile broadcast source.
int bt_cap_commander_cancel(void)
Cancel any current Common Audio Profile commander procedure.
int bt_cap_unicast_group_add_streams(struct bt_cap_unicast_group *unicast_group, const struct bt_cap_unicast_group_stream_pair_param params[], size_t num_param)
Add streams to a unicast group as a unicast client.
int bt_cap_stream_get_tx_sync(struct bt_cap_stream *stream, struct bt_iso_tx_info *info)
Get ISO transmission timing info for a Common Audio Profile stream.
int bt_cap_handover_unregister_cb(const struct bt_cap_handover_cb *cb)
Unregister Common Audio Profile Handover callbacks.
int bt_cap_initiator_broadcast_audio_update(struct bt_cap_broadcast_source *broadcast_source, const uint8_t meta[], size_t meta_len)
Update broadcast audio streams for a Common Audio Profile broadcast source.
int bt_cap_initiator_unicast_audio_update(const struct bt_cap_unicast_audio_update_param *param)
Update unicast audio streams.
int bt_cap_commander_change_microphone_gain_setting(const struct bt_cap_commander_change_microphone_gain_setting_param *param)
Change the microphone gain setting on one or more Common Audio Profile Acceptors.
int bt_cap_unicast_group_delete(struct bt_cap_unicast_group *unicast_group)
Delete audio unicast group.
int bt_cap_handover_broadcast_to_unicast(const struct bt_cap_handover_broadcast_to_unicast_param *param, struct bt_bap_unicast_group **unicast_group)
Hands over the data streams in a broadcast source to a unicast group.
int bt_cap_initiator_unicast_audio_cancel(void)
Cancel any current Common Audio Profile procedure.
int bt_cap_initiator_unregister_cb(const struct bt_cap_initiator_cb *cb)
Unregister Common Audio Profile Initiator callbacks.
int bt_cap_handover_unicast_to_broadcast(const struct bt_cap_handover_unicast_to_broadcast_param *param)
Hands over the sink streams in a unicast group to a broadcast source.
int bt_cap_commander_register_cb(const struct bt_cap_commander_cb *cb)
Register Common Audio Profile Commander callbacks.
int bt_cap_initiator_unicast_discover(struct bt_conn *conn)
Discovers audio support on a remote device.
int bt_cap_commander_broadcast_reception_stop(const struct bt_cap_commander_broadcast_reception_stop_param *param)
Stops the reception of broadcast audio on one or more remote Common Audio Profile Acceptors.
int bt_cap_commander_change_volume_mute_state(const struct bt_cap_commander_change_volume_mute_state_param *param)
Change the volume mute state on one or more Common Audio Profile Acceptors.
void bt_cap_stream_ops_register(struct bt_cap_stream *stream, struct bt_bap_stream_ops *ops)
Register Audio operations for a Common Audio Profile stream.
int bt_cap_initiator_broadcast_audio_delete(struct bt_cap_broadcast_source *broadcast_source)
Delete Common Audio Profile broadcast source.
bt_cap_set_type
Type of CAP set.
Definition cap.h:168
int bt_cap_initiator_unicast_audio_start(const struct bt_cap_unicast_audio_start_param *param)
Setup and start unicast audio streams for a set of devices.
int bt_cap_commander_change_volume_offset(const struct bt_cap_commander_change_volume_offset_param *param)
Change the volume offset on one or more Common Audio Profile Acceptors.
int bt_cap_initiator_broadcast_audio_stop(struct bt_cap_broadcast_source *broadcast_source)
Stop broadcast audio streams for a Common Audio Profile broadcast source.
bool(* bt_cap_unicast_group_foreach_stream_func_t)(struct bt_cap_stream *stream, void *user_data)
Callback function for bt_bap_unicast_group_foreach_stream()
Definition cap.h:409
int bt_cap_commander_distribute_broadcast_code(const struct bt_cap_commander_distribute_broadcast_code_param *param)
Distributes the broadcast code on one or more remote Common Audio Profile Acceptors.
int bt_cap_acceptor_register(const struct bt_csip_set_member_register_param *param, struct bt_csip_set_member_svc_inst **svc_inst)
Register the Common Audio Service.
int bt_cap_initiator_unicast_audio_stop(const struct bt_cap_unicast_audio_stop_param *param)
Stop unicast audio streams.
int bt_cap_commander_change_volume(const struct bt_cap_commander_change_volume_param *param)
Change the volume on one or more Common Audio Profile Acceptors.
@ BT_CAP_SET_TYPE_CSIP
The set is a CSIP Coordinated Set.
Definition cap.h:172
@ BT_CAP_SET_TYPE_AD_HOC
The set is an ad-hoc set.
Definition cap.h:170
#define BT_ISO_BROADCAST_CODE_SIZE
Broadcast code size (16 octets)
Definition iso.h:145
#define bool
Definition stdbool.h:13
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
__INT8_TYPE__ int8_t
Definition stdint.h:72
__INT16_TYPE__ int16_t
Definition stdint.h:73
Bluetooth LE Device Address.
Definition addr.h:49
Codec specific configuration structure.
Definition audio.h:755
Struct to hold subgroup specific information for the receive state.
Definition bap.h:641
QoS configuration structure.
Definition bap.h:232
Stream operation.
Definition bap.h:931
Basic Audio Profile stream structure.
Definition bap.h:890
Parameters part of bt_cap_commander_broadcast_reception_start_param for bt_cap_commander_broadcast_re...
Definition cap.h:1137
size_t num_subgroups
Number of subgroups.
Definition cap.h:1165
uint16_t pa_interval
Periodic advertising interval in milliseconds.
Definition cap.h:1152
struct bt_bap_bass_subgroup subgroups[BT_BAP_BASS_MAX_SUBGROUPS]
Pointer to array of subgroups.
Definition cap.h:1162
uint32_t broadcast_id
24-bit broadcast ID
Definition cap.h:1155
bt_addr_le_t addr
Address of the advertiser.
Definition cap.h:1142
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition cap.h:1139
uint8_t adv_sid
SID of the advertising set.
Definition cap.h:1145
Parameters for starting broadcast reception.
Definition cap.h:1169
struct bt_cap_commander_broadcast_reception_start_member_param * param
The set of devices for this procedure.
Definition cap.h:1174
size_t count
The number of parameters in param.
Definition cap.h:1177
enum bt_cap_set_type type
The type of the set.
Definition cap.h:1171
Member parameters for stopping broadcast reception.
Definition cap.h:1192
uint8_t src_id
Source ID of the receive state.
Definition cap.h:1197
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition cap.h:1194
size_t num_subgroups
Number of subgroups.
Definition cap.h:1200
Parameters for stopping broadcast reception.
Definition cap.h:1204
enum bt_cap_set_type type
The type of the set.
Definition cap.h:1206
struct bt_cap_commander_broadcast_reception_stop_member_param * param
The set of devices for this procedure.
Definition cap.h:1209
size_t count
The number of parameters in param.
Definition cap.h:1212
Callback structure for CAP procedures.
Definition cap.h:946
void(* broadcast_reception_start)(struct bt_conn *conn, int err)
Callback for bt_cap_commander_broadcast_reception_start().
Definition cap.h:1041
void(* microphone_gain_changed)(struct bt_conn *conn, int err)
Callback for bt_cap_commander_change_microphone_gain_setting().
Definition cap.h:1026
void(* broadcast_reception_stop)(struct bt_conn *conn, int err)
Callback for bt_cap_commander_broadcast_reception_stop().
Definition cap.h:1052
void(* volume_changed)(struct bt_conn *conn, int err)
Callback for bt_cap_commander_change_volume().
Definition cap.h:975
void(* volume_offset_changed)(struct bt_conn *conn, int err)
Callback for bt_cap_commander_change_volume_offset().
Definition cap.h:1000
void(* distribute_broadcast_code)(struct bt_conn *conn, int err)
Callback for bt_cap_commander_distribute_broadcast_code().
Definition cap.h:1063
void(* microphone_mute_changed)(struct bt_conn *conn, int err)
Callback for bt_cap_commander_change_microphone_mute_state().
Definition cap.h:1014
void(* volume_mute_changed)(struct bt_conn *conn, int err)
Callback for bt_cap_commander_change_volume_mute_state().
Definition cap.h:987
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().
Definition cap.h:960
Parameters part of bt_cap_commander_change_microphone_gain_setting_param for bt_cap_commander_change_...
Definition cap.h:1394
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition cap.h:1396
int8_t gain
The microphone gain setting to set.
Definition cap.h:1399
Parameters for changing microphone mute state.
Definition cap.h:1403
enum bt_cap_set_type type
The type of the set.
Definition cap.h:1405
struct bt_cap_commander_change_microphone_gain_setting_member_param * param
The set of devices for this procedure.
Definition cap.h:1408
size_t count
The number of parameters in param.
Definition cap.h:1411
Parameters for changing microphone mute state.
Definition cap.h:1362
bool mute
The microphone mute state to set.
Definition cap.h:1377
size_t count
The number of members in members.
Definition cap.h:1370
union bt_cap_set_member * members
Coordinated or ad-hoc set member.
Definition cap.h:1367
enum bt_cap_set_type type
The type of the set.
Definition cap.h:1364
Parameters for changing volume mute state.
Definition cap.h:1333
size_t count
The number of members in members.
Definition cap.h:1341
bool mute
The volume mute state to set.
Definition cap.h:1348
enum bt_cap_set_type type
The type of the set.
Definition cap.h:1335
union bt_cap_set_member * members
Coordinated or ad-hoc set member.
Definition cap.h:1338
Parameters part of bt_cap_commander_change_volume_offset_param for bt_cap_commander_change_volume_off...
Definition cap.h:1298
int16_t offset
The offset to set.
Definition cap.h:1307
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition cap.h:1300
Parameters for changing volume offset.
Definition cap.h:1311
struct bt_cap_commander_change_volume_offset_member_param * param
The set of devices for this procedure.
Definition cap.h:1316
enum bt_cap_set_type type
The type of the set.
Definition cap.h:1313
size_t count
The number of parameters in param.
Definition cap.h:1319
Parameters for changing absolute volume.
Definition cap.h:1271
size_t count
The number of members in members.
Definition cap.h:1279
union bt_cap_set_member * members
Coordinated or ad-hoc set member.
Definition cap.h:1276
enum bt_cap_set_type type
The type of the set.
Definition cap.h:1273
uint8_t volume
The absolute volume to set.
Definition cap.h:1282
Member parameters for distributing broadcast code.
Definition cap.h:1227
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition cap.h:1229
uint8_t src_id
Source ID of the receive state.
Definition cap.h:1232
Parameters for distributing broadcast code.
Definition cap.h:1236
struct bt_cap_commander_distribute_broadcast_code_member_param * param
The set of devices for this procedure.
Definition cap.h:1241
size_t count
The number of parameters in param.
Definition cap.h:1244
enum bt_cap_set_type type
The type of the set.
Definition cap.h:1238
uint8_t broadcast_code[BT_ISO_BROADCAST_CODE_SIZE]
16-octet broadcast code.
Definition cap.h:1256
Parameters for bt_cap_handover_broadcast_to_unicast()
Definition cap.h:904
enum bt_cap_set_type type
The type of the set.
Definition cap.h:913
size_t count
The number of set members in members.
Definition cap.h:922
union bt_cap_set_member ** members
Coordinated or ad-hoc set members.
Definition cap.h:925
struct bt_cap_broadcast_source * broadcast_source
The source broadcast source with the streams.
Definition cap.h:910
Callback structure for CAP procedures.
Definition cap.h:848
void(* unicast_to_broadcast_complete)(int err, struct bt_conn *conn, struct bt_cap_unicast_group *unicast_group, struct bt_cap_broadcast_source *broadcast_source)
The unicast to broadcast handover procedure has finished.
Definition cap.h:859
Parameters for bt_cap_handover_unicast_to_broadcast()
Definition cap.h:816
enum bt_cap_set_type type
The type of the set.
Definition cap.h:818
uint16_t pa_interval
The periodic advertising interval configured for the advertising set.
Definition cap.h:834
struct bt_le_ext_adv * ext_adv
The advertising set to use for the broadcast source.
Definition cap.h:831
struct bt_cap_initiator_broadcast_create_param * broadcast_create_param
Broadcast source parameters.
Definition cap.h:844
struct bt_cap_unicast_group * unicast_group
The source unicast group with the streams.
Definition cap.h:821
uint32_t broadcast_id
The broadcast ID the advertising set is, or will be, using.
Definition cap.h:837
Parameters for * bt_cap_initiator_broadcast_audio_create()
Definition cap.h:637
uint8_t pto
Pre-transmission offset.
Definition cap.h:690
struct bt_bap_qos_cfg * qos
Quality of Service configuration.
Definition cap.h:645
struct bt_cap_initiator_broadcast_subgroup_param * subgroup_params
Array of stream parameters.
Definition cap.h:642
bool encryption
Whether or not to encrypt the streams.
Definition cap.h:657
uint8_t irc
Immediate Repetition Count.
Definition cap.h:681
uint16_t iso_interval
ISO interval.
Definition cap.h:699
uint8_t broadcast_code[BT_ISO_BROADCAST_CODE_SIZE]
16-octet broadcast code.
Definition cap.h:671
uint8_t packing
Broadcast Source packing mode.
Definition cap.h:654
size_t subgroup_count
The number of parameters in subgroup_params.
Definition cap.h:639
Parameters part of bt_cap_initiator_broadcast_subgroup_param for bt_cap_initiator_broadcast_audio_cre...
Definition cap.h:607
uint8_t * data
BIS Codec Specific Configuration.
Definition cap.h:618
struct bt_cap_stream * stream
Audio stream.
Definition cap.h:609
size_t data_len
The length of the p data array.
Definition cap.h:615
Parameters part of bt_cap_initiator_broadcast_create_param for bt_cap_initiator_broadcast_audio_creat...
Definition cap.h:625
struct bt_cap_initiator_broadcast_stream_param * stream_params
Array of stream parameters.
Definition cap.h:630
size_t stream_count
The number of parameters in stream_params.
Definition cap.h:627
struct bt_audio_codec_cfg * codec_cfg
Subgroup Codec configuration.
Definition cap.h:633
Callback structure for CAP procedures.
Definition cap.h:78
void(* unicast_stop_complete)(int err, struct bt_conn *conn)
Callback for bt_cap_initiator_unicast_audio_stop().
Definition cap.h:132
void(* unicast_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().
Definition cap.h:93
void(* unicast_update_complete)(int err, struct bt_conn *conn)
Callback for bt_cap_initiator_unicast_audio_update().
Definition cap.h:120
void(* unicast_start_complete)(int err, struct bt_conn *conn)
Callback for bt_cap_initiator_unicast_audio_start().
Definition cap.h:108
Common Audio Profile stream structure.
Definition cap.h:190
struct bt_bap_stream_ops * ops
Audio stream operations.
Definition cap.h:195
struct bt_bap_stream bap_stream
The underlying BAP audio stream.
Definition cap.h:192
Parameters for the bt_cap_initiator_unicast_audio_start() function.
Definition cap.h:452
enum bt_cap_set_type type
The type of the set.
Definition cap.h:454
size_t count
The number of parameters in stream_params.
Definition cap.h:457
struct bt_cap_unicast_audio_start_stream_param * stream_params
Array of stream parameters.
Definition cap.h:460
Stream specific parameters for the bt_cap_initiator_unicast_audio_start() function.
Definition cap.h:428
struct bt_cap_stream * stream
Stream for the member.
Definition cap.h:433
struct bt_audio_codec_cfg * codec_cfg
Codec configuration.
Definition cap.h:448
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition cap.h:430
struct bt_bap_ep * ep
Endpoint reference for the stream.
Definition cap.h:436
Parameters for the bt_cap_initiator_unicast_audio_stop() function.
Definition cap.h:492
size_t count
The number of streams in streams.
Definition cap.h:497
bool release
Whether to release the streams after they have stopped.
Definition cap.h:503
enum bt_cap_set_type type
The type of the set.
Definition cap.h:494
struct bt_cap_stream ** streams
Array of streams to stop.
Definition cap.h:500
Parameters for the bt_cap_initiator_unicast_audio_update() function.
Definition cap.h:480
struct bt_cap_unicast_audio_update_stream_param * stream_params
Array of stream parameters.
Definition cap.h:488
enum bt_cap_set_type type
The type of the set.
Definition cap.h:482
size_t count
The number of parameters in stream_params.
Definition cap.h:485
Stream specific parameters for the bt_cap_initiator_unicast_audio_update() function.
Definition cap.h:464
size_t meta_len
The length of meta.
Definition cap.h:469
struct bt_cap_stream * stream
Stream to update.
Definition cap.h:466
uint8_t * meta
The new metadata.
Definition cap.h:476
Parameters for the creating unicast groups with bt_cap_unicast_group_create()
Definition cap.h:284
struct bt_cap_unicast_group_stream_pair_param * params
Array of stream parameters.
Definition cap.h:289
uint8_t packing
Unicast Group packing mode.
Definition cap.h:298
uint8_t p_to_c_ft
Peripheral to Central flush timeout.
Definition cap.h:319
size_t params_count
The number of parameters in params.
Definition cap.h:286
uint16_t iso_interval
ISO interval.
Definition cap.h:328
uint8_t c_to_p_ft
Central to Peripheral flush timeout.
Definition cap.h:309
Parameter struct for the unicast group functions.
Definition cap.h:275
struct bt_cap_unicast_group_stream_param * rx_param
Pointer to a receiving stream parameters.
Definition cap.h:277
struct bt_cap_unicast_group_stream_param * tx_param
Pointer to a transmitting stream parameters.
Definition cap.h:280
Parameter struct for each stream in the unicast group.
Definition cap.h:261
struct bt_cap_stream * stream
Pointer to a stream object.
Definition cap.h:263
struct bt_bap_qos_cfg * qos_cfg
The QoS settings for the stream object.
Definition cap.h:266
Struct representing a coordinated set instance on a remote device.
Definition csip.h:357
Struct representing a remote device as a set member.
Definition csip.h:366
Register structure for Coordinated Set Identification Service.
Definition csip.h:134
ISO Meta Data structure for transmitted ISO packets.
Definition iso.h:384
Simple network buffer representation.
Definition net_buf.h:89
Network buffer representation.
Definition net_buf.h:1006
Represents a Common Audio Set member that are either in a Coordinated or ad-hoc set.
Definition cap.h:176
struct bt_conn * member
Connection pointer if the type is BT_CAP_SET_TYPE_AD_HOC.
Definition cap.h:178
struct bt_csip_set_coordinator_csis_inst * csip
CSIP Coordinated Set struct used if type is BT_CAP_SET_TYPE_CSIP.
Definition cap.h:181