cap.h File Reference

Bluetooth Common Audio Profile (CAP) APIs. More...

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <zephyr/bluetooth/audio/audio.h>
#include <zephyr/bluetooth/audio/bap.h>
#include <zephyr/bluetooth/audio/csip.h>
#include <zephyr/bluetooth/addr.h>
#include <zephyr/bluetooth/bluetooth.h>
#include <zephyr/bluetooth/conn.h>
#include <zephyr/bluetooth/iso.h>
#include <zephyr/net/buf.h>

Go to the source code of this file.

Data Structures
struct	bt_cap_initiator_cb
	Callback structure for CAP procedures. More...
union	bt_cap_set_member
	Represents a Common Audio Set member that are either in a Coordinated or ad-hoc set. More...
struct	bt_cap_stream
	Common Audio Profile stream structure. More...
struct	bt_cap_unicast_audio_start_stream_param
	Stream specific parameters for the bt_cap_initiator_unicast_audio_start() function. More...
struct	bt_cap_unicast_audio_start_param
	Parameters for the bt_cap_initiator_unicast_audio_start() function. More...
struct	bt_cap_unicast_audio_update_stream_param
	Stream specific parameters for the bt_cap_initiator_unicast_audio_update() function. More...
struct	bt_cap_unicast_audio_update_param
	Parameters for the bt_cap_initiator_unicast_audio_update() function. More...
struct	bt_cap_unicast_audio_stop_param
	Parameters for the bt_cap_initiator_unicast_audio_stop() function. More...
struct	bt_cap_initiator_broadcast_stream_param
	Parameters part of bt_cap_initiator_broadcast_subgroup_param for bt_cap_initiator_broadcast_audio_create() More...
struct	bt_cap_initiator_broadcast_subgroup_param
	Parameters part of bt_cap_initiator_broadcast_create_param for bt_cap_initiator_broadcast_audio_create() More...
struct	bt_cap_initiator_broadcast_create_param
	Parameters for * bt_cap_initiator_broadcast_audio_create() More...
struct	bt_cap_unicast_to_broadcast_param
	Parameters for bt_cap_initiator_unicast_to_broadcast() More...
struct	bt_cap_broadcast_to_unicast_param
	Parameters for bt_cap_initiator_broadcast_to_unicast() More...
struct	bt_cap_commander_cb
	Callback structure for CAP procedures. More...
struct	bt_cap_commander_broadcast_reception_start_member_param
	Parameters part of bt_cap_commander_broadcast_reception_start_param for bt_cap_commander_broadcast_reception_start() More...
struct	bt_cap_commander_broadcast_reception_start_param
	Parameters for starting broadcast reception More...
struct	bt_cap_commander_broadcast_reception_stop_param
	Parameters for stopping broadcast reception More...
struct	bt_cap_commander_change_volume_param
	Parameters for changing absolute volume More...
struct	bt_cap_commander_change_volume_offset_member_param
	Parameters part of bt_cap_commander_change_volume_offset_param for bt_cap_commander_change_volume_offset() More...
struct	bt_cap_commander_change_volume_offset_param
	Parameters for changing volume offset. More...
struct	bt_cap_commander_change_volume_mute_state_param
	Parameters for changing volume mute state. More...
struct	bt_cap_commander_change_microphone_mute_state_param
	Parameters for changing microphone mute state. More...
struct	bt_cap_commander_change_microphone_gain_setting_member_param
	Parameters part of bt_cap_commander_change_microphone_gain_setting_param for bt_cap_commander_change_microphone_gain_setting() More...
struct	bt_cap_commander_change_microphone_gain_setting_param
	Parameters for changing microphone mute state. More...

Enumerations
enum	bt_cap_set_type { BT_CAP_SET_TYPE_AD_HOC , BT_CAP_SET_TYPE_CSIP }
	Type of CAP set. More...

Functions
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_discover (struct bt_conn *conn)
	Discovers audio support on a remote device.
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_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_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_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_register_cb (const struct bt_cap_initiator_cb *cb)
	Register Common Audio Profile Initiator callbacks.
int	bt_cap_initiator_unregister_cb (const struct bt_cap_initiator_cb *cb)
	Unregister Common Audio Profile Initiator callbacks.
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_initiator_unicast_audio_update (const struct bt_cap_unicast_audio_update_param *param)
	Update unicast audio streams.
int	bt_cap_initiator_unicast_audio_stop (const struct bt_cap_unicast_audio_stop_param *param)
	Stop unicast audio streams.
int	bt_cap_initiator_unicast_audio_cancel (void)
	Cancel any current Common Audio Profile procedure.
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_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_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_broadcast_audio_stop (struct bt_cap_broadcast_source *broadcast_source)
	Stop broadcast audio streams for a Common Audio Profile broadcast source.
int	bt_cap_initiator_broadcast_audio_delete (struct bt_cap_broadcast_source *broadcast_source)
	Delete Common Audio Profile broadcast source.
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_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_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_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_register_cb (const struct bt_cap_commander_cb *cb)
	Register Common Audio Profile Commander callbacks.
int	bt_cap_commander_unregister_cb (const struct bt_cap_commander_cb *cb)
	Unregister Common Audio Profile Commander callbacks.
int	bt_cap_commander_discover (struct bt_conn *conn)
	Discovers audio support on a remote device.
int	bt_cap_commander_cancel (void)
	Cancel any current Common Audio Profile commander procedure.
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_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 (const struct bt_cap_commander_change_volume_param *param)
	Change the volume on one or more Common Audio Profile Acceptors.
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_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.
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_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.

Detailed Description

Bluetooth Common Audio Profile (CAP) APIs.