Zephyr API Documentation  3.6.0
A Scalable Open Source RTOS
3.6.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cap.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022-2023 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_CAP_H_
8#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_CAP_H_
9
22#include <stdint.h>
23
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
34struct bt_cap_broadcast_source;
35
55 struct bt_csip_set_member_svc_inst **svc_inst);
56
59#if defined(CONFIG_BT_BAP_UNICAST_CLIENT)
72 void (*unicast_discovery_complete)(
73 struct bt_conn *conn, int err,
74 const struct bt_csip_set_coordinator_csis_inst *csis_inst);
75
86 void (*unicast_start_complete)(int err, struct bt_conn *conn);
87
98 void (*unicast_update_complete)(int err, struct bt_conn *conn);
99
110 void (*unicast_stop_complete)(int err, struct bt_conn *conn);
111#endif /* CONFIG_BT_BAP_UNICAST_CLIENT */
112};
113
127int bt_cap_initiator_unicast_discover(struct bt_conn *conn);
128
135};
136
140 struct bt_conn *member;
141
144};
145
149};
150
159
175int bt_cap_stream_send(struct bt_cap_stream *stream, struct net_buf *buf, uint16_t seq_num);
176
194int bt_cap_stream_send_ts(struct bt_cap_stream *stream, struct net_buf *buf, uint16_t seq_num,
195 uint32_t ts);
196
211
216
219
221 struct bt_bap_ep *ep;
222
231};
232
237
239 size_t count;
240
243};
244
249
251 size_t meta_len;
252
259};
260
265
267 size_t count;
268
271};
272
277
279 size_t count;
280
283};
284
293
310
325
340
364
368
373 size_t data_len;
374
377};
378
382
385
388};
389
393
396
399
408
411
425
426#if defined(CONFIG_BT_ISO_TEST_PARAMS)
434 uint8_t irc;
435
442 uint8_t pto;
443
451 uint16_t iso_interval;
452#endif /* CONFIG_BT_ISO_TEST_PARAMS */
453};
454
470 const struct bt_cap_initiator_broadcast_create_param *param,
471 struct bt_cap_broadcast_source **broadcast_source);
472
492int bt_cap_initiator_broadcast_audio_start(struct bt_cap_broadcast_source *broadcast_source,
493 struct bt_le_ext_adv *adv);
508int bt_cap_initiator_broadcast_audio_update(struct bt_cap_broadcast_source *broadcast_source,
509 const uint8_t meta[], size_t meta_len);
510
523int bt_cap_initiator_broadcast_audio_stop(struct bt_cap_broadcast_source *broadcast_source);
524
542int bt_cap_initiator_broadcast_audio_delete(struct bt_cap_broadcast_source *broadcast_source);
543
558int bt_cap_initiator_broadcast_get_id(const struct bt_cap_broadcast_source *broadcast_source,
559 uint32_t *const broadcast_id);
560
576int bt_cap_initiator_broadcast_get_base(struct bt_cap_broadcast_source *broadcast_source,
577 struct net_buf_simple *base_buf);
578
581 struct bt_bap_unicast_group *unicast_group;
582
590
604};
605
623 struct bt_cap_broadcast_source **source);
624
631 struct bt_cap_broadcast_source *broadcast_source;
632
635
643 size_t count;
644
647};
648
666 struct bt_bap_unicast_group **unicast_group);
667
682 void (*discovery_complete)(struct bt_conn *conn, int err,
683 const struct bt_csip_set_coordinator_csis_inst *csis_inst);
684
685#if defined(CONFIG_BT_VCP_VOL_CTLR)
696 void (*volume_changed)(struct bt_conn *conn, int err);
697
698#if defined(CONFIG_BT_VCP_VOL_CTLR_VOCS)
709 void (*volume_offset_changed)(struct bt_conn *conn, int err);
710#endif /* CONFIG_BT_VCP_VOL_CTLR_VOCS */
711#endif /* CONFIG_BT_VCP_VOL_CTLR */
712};
713
724
734
753int bt_cap_commander_discover(struct bt_conn *conn);
754
778
782
785
788
795
798
805
808};
809
814
817
819 size_t count;
820};
821
832
837
840
842 size_t count;
843};
844
855
860
863
865 size_t count;
866
869};
870
879
883
890};
891
896
899
901 size_t count;
902};
903
913
918
921
923 size_t count;
924
930 bool mute;
931};
932
942
947
950
952 size_t count;
953
959 bool mute;
960};
961
971
975
978};
979
984
987
989 size_t count;
990};
991
1001#ifdef __cplusplus
1002}
1003#endif
1004
1009#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_CAP_H_ */
Header for Bluetooth BAP.
Bluetooth Audio handling.
#define BT_AUDIO_BROADCAST_CODE_SIZE
Definition: audio.h:42
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_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_initiator_broadcast_to_unicast(const struct bt_cap_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_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_initiator_unicast_to_broadcast(const struct bt_cap_unicast_to_broadcast_param *param, struct bt_cap_broadcast_source **source)
Hands over the data streams in a unicast group to a broadcast source.
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_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_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_initiator_unicast_audio_cancel(void)
Cancel any current Common Audio Profile procedure.
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:130
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.
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_initiator_broadcast_get_id(const struct bt_cap_broadcast_source *broadcast_source, uint32_t *const broadcast_id)
Get the broadcast ID of a Common Audio Profile broadcast source.
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:134
@ BT_CAP_SET_TYPE_AD_HOC
The set is an ad-hoc set.
Definition: cap.h:132
#define BT_ISO_BROADCAST_CODE_SIZE
Broadcast code size.
Definition: iso.h:107
Bluetooth ISO handling.
__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:584
Codec QoS structure.
Definition: audio.h:702
Struct to hold subgroup specific information for the receive state.
Definition: bap.h:249
Stream operation.
Definition: bap.h:467
Basic Audio Profile stream structure.
Definition: bap.h:427
union bt_cap_set_member ** members
Coordinated or ad-hoc set members.
Definition: cap.h:646
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:634
size_t count
The number of set members in members.
Definition: cap.h:643
struct bt_cap_broadcast_source * broadcast_source
The source broadcast source with the streams.
Definition: cap.h:631
size_t num_subgroups
Number of subgroups.
Definition: cap.h:807
uint16_t pa_interval
Periodic advertising interval in milliseconds.
Definition: cap.h:794
uint32_t broadcast_id
24-bit broadcast ID
Definition: cap.h:797
bt_addr_le_t addr
Address of the advertiser.
Definition: cap.h:784
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition: cap.h:781
uint8_t adv_sid
SID of the advertising set.
Definition: cap.h:787
struct bt_bap_bass_subgroup * subgroups
Pointer to array of subgroups.
Definition: cap.h:804
Parameters for starting broadcast reception
Definition: cap.h:811
struct bt_cap_commander_broadcast_reception_start_member_param * param
The set of devices for this procedure.
Definition: cap.h:816
size_t count
The number of parameters in param.
Definition: cap.h:819
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:813
Parameters for stopping broadcast reception
Definition: cap.h:834
union bt_cap_set_member * members
Coordinated or ad-hoc set member.
Definition: cap.h:839
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:836
size_t count
The number of members in members.
Definition: cap.h:842
Callback structure for CAP procedures.
Definition: cap.h:669
void(* discovery_complete)(struct bt_conn *conn, int err, const struct bt_csip_set_coordinator_csis_inst *csis_inst)
Callback for bt_cap_initiator_unicast_discover().
Definition: cap.h:682
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition: cap.h:974
int8_t gain
The microphone gain setting to set.
Definition: cap.h:977
Parameters for changing microphone mute state.
Definition: cap.h:981
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:983
struct bt_cap_commander_change_microphone_gain_setting_member_param * param
The set of devices for this procedure.
Definition: cap.h:986
size_t count
The number of parameters in param.
Definition: cap.h:989
Parameters for changing microphone mute state.
Definition: cap.h:944
bool mute
The microphone mute state to set.
Definition: cap.h:959
size_t count
The number of members in members.
Definition: cap.h:952
union bt_cap_set_member * members
Coordinated or ad-hoc set member.
Definition: cap.h:949
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:946
Parameters for changing volume mute state.
Definition: cap.h:915
size_t count
The number of members in members.
Definition: cap.h:923
bool mute
The volume mute state to set.
Definition: cap.h:930
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:917
union bt_cap_set_member * members
Coordinated or ad-hoc set member.
Definition: cap.h:920
int16_t offset
The offset to set.
Definition: cap.h:889
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition: cap.h:882
Parameters for changing volume offset.
Definition: cap.h:893
struct bt_cap_commander_change_volume_offset_member_param * param
The set of devices for this procedure.
Definition: cap.h:898
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:895
size_t count
The number of parameters in param.
Definition: cap.h:901
Parameters for changing absolute volume
Definition: cap.h:857
size_t count
The number of members in members.
Definition: cap.h:865
union bt_cap_set_member * members
Coordinated or ad-hoc set member.
Definition: cap.h:862
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:859
uint8_t volume
The absolute volume to set.
Definition: cap.h:868
struct bt_cap_initiator_broadcast_subgroup_param * subgroup_params
Array of stream parameters.
Definition: cap.h:395
bool encryption
Whether or not to encrypt the streams.
Definition: cap.h:410
uint8_t broadcast_code[BT_AUDIO_BROADCAST_CODE_SIZE]
16-octet broadcast code.
Definition: cap.h:424
uint8_t packing
Broadcast Source packing mode.
Definition: cap.h:407
size_t subgroup_count
The number of parameters in subgroup_params.
Definition: cap.h:392
struct bt_audio_codec_qos * qos
Quality of Service configuration.
Definition: cap.h:398
uint8_t * data
BIS Codec Specific Configuration.
Definition: cap.h:376
struct bt_cap_stream * stream
Audio stream.
Definition: cap.h:367
size_t data_len
The length of the p data array.
Definition: cap.h:373
struct bt_cap_initiator_broadcast_stream_param * stream_params
Array of stream parameters.
Definition: cap.h:384
size_t stream_count
The number of parameters in stream_params.
Definition: cap.h:381
struct bt_audio_codec_cfg * codec_cfg
Subgroup Codec configuration.
Definition: cap.h:387
Callback structure for CAP procedures.
Definition: cap.h:58
Definition: cap.h:146
struct bt_bap_stream_ops * ops
Definition: cap.h:148
struct bt_bap_stream bap_stream
Definition: cap.h:147
Parameters for the bt_cap_initiator_unicast_audio_start() function.
Definition: cap.h:234
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:236
size_t count
The number of parameters in stream_params.
Definition: cap.h:239
struct bt_cap_unicast_audio_start_stream_param * stream_params
Array of stream parameters.
Definition: cap.h:242
Stream specific parameters for the bt_cap_initiator_unicast_audio_start() function.
Definition: cap.h:213
struct bt_cap_stream * stream
Stream for the member.
Definition: cap.h:218
struct bt_audio_codec_cfg * codec_cfg
Codec configuration.
Definition: cap.h:230
union bt_cap_set_member member
Coordinated or ad-hoc set member.
Definition: cap.h:215
struct bt_bap_ep * ep
Endpoint reference for the stream.
Definition: cap.h:221
Parameters for the bt_cap_initiator_unicast_audio_stop() function.
Definition: cap.h:274
size_t count
The number of streams in streams.
Definition: cap.h:279
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:276
struct bt_cap_stream ** streams
Array of streams to stop.
Definition: cap.h:282
Parameters for the bt_cap_initiator_unicast_audio_update() function.
Definition: cap.h:262
struct bt_cap_unicast_audio_update_stream_param * stream_params
Array of stream parameters.
Definition: cap.h:270
enum bt_cap_set_type type
The type of the set.
Definition: cap.h:264
size_t count
The number of parameters in stream_params.
Definition: cap.h:267
Stream specific parameters for the bt_cap_initiator_unicast_audio_update() function.
Definition: cap.h:246
size_t meta_len
The length of meta.
Definition: cap.h:251
struct bt_cap_stream * stream
Stream to update.
Definition: cap.h:248
uint8_t * meta
The new metadata.
Definition: cap.h:258
struct bt_bap_unicast_group * unicast_group
The source unicast group with the streams.
Definition: cap.h:581
uint8_t broadcast_code[BT_ISO_BROADCAST_CODE_SIZE]
16-octet broadcast code.
Definition: cap.h:603
bool encrypt
Whether or not to encrypt the streams.
Definition: cap.h:589
Struct representing a coordinated set instance on a remote device.
Definition: csip.h:268
Register structure for Coordinated Set Identification Service.
Definition: csip.h:111
ISO Meta Data structure for transmitted ISO packets.
Definition: iso.h:303
Simple network buffer representation.
Definition: buf.h:87
Network buffer representation.
Definition: buf.h:910
Represents a Common Audio Set member that are either in a Coordinated or ad-hoc set.
Definition: cap.h:138
struct bt_conn * member
Connection pointer if the type is BT_CAP_SET_TYPE_AD_HOC.
Definition: cap.h:140
struct bt_csip_set_coordinator_csis_inst * csip
CSIP Coordinated Set struct used if type is BT_CAP_SET_TYPE_CSIP.
Definition: cap.h:143