bt_cap_initiator_cb Struct Reference

Callback structure for CAP procedures. More...

#include <cap.h>

Data Fields
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().
void(*	unicast_start_complete )(int err, struct bt_conn *conn)
	Callback for bt_cap_initiator_unicast_audio_start().
void(*	unicast_update_complete )(int err, struct bt_conn *conn)
	Callback for bt_cap_initiator_unicast_audio_update().
void(*	unicast_stop_complete )(int err, struct bt_conn *conn)
	Callback for bt_cap_initiator_unicast_audio_stop().
void(*	broadcast_started )(struct bt_cap_broadcast_source *source)
	The Broadcast Source has started and all of the streams are ready for audio data.
void(*	broadcast_stopped )(struct bt_cap_broadcast_source *source, uint8_t reason)
	The Broadcast Source has stopped and none of the streams are ready for audio data.

Detailed Description

Callback structure for CAP procedures.

Field Documentation

broadcast_started

void(* bt_cap_initiator_cb::broadcast_started) (struct bt_cap_broadcast_source *source)

The Broadcast Source has started and all of the streams are ready for audio data.

Parameters

source

The started Broadcast Source

broadcast_stopped

void(* bt_cap_initiator_cb::broadcast_stopped) (struct bt_cap_broadcast_source *source, uint8_t reason)

The Broadcast Source has stopped and none of the streams are ready for audio data.

Parameters

source	The stopped Broadcast Source
reason	The reason why the Broadcast Source stopped (see the BT_HCI_ERR_* values)

unicast_discovery_complete

void(* bt_cap_initiator_cb::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().

Parameters

conn	The connection pointer supplied to bt_cap_initiator_unicast_discover().
err	0 if Common Audio Service was found else -ENODATA.
member	Pointer to the set member. NULL if err != 0.
csis_inst	The Coordinated Set Identification Service if Common Audio Service was found and includes a Coordinated Set Identification Service. NULL on error or if remote device does not include Coordinated Set Identification Service. NULL if err != 0.

unicast_start_complete

void(* bt_cap_initiator_cb::unicast_start_complete) (int err, struct bt_conn *conn)

Callback for bt_cap_initiator_unicast_audio_start().

Parameters

err

0 if success. -ENOEXEC if subprocedure could not be performed. -ENOMEM if subprocedure could not be performed due to lack of memory. -EACCES if request rejected by peer. -EBUSY if subprocedure could not be performed because unicast client is already busy. -EINVAL if subprocedure contained invalid parameters. -EBADMSG if unexpected state change happened. -EALREADY if subprocedure could not be performed due to unexpected state. -ECONNRESET if connection dropped during procedure. -ENOTCONN if subprocedure could not be performed due to connection. -ECANCELED if cancelled by bt_cap_initiator_unicast_audio_cancel().

conn

Pointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_initiator_unicast_audio_cancel()

unicast_stop_complete

void(* bt_cap_initiator_cb::unicast_stop_complete) (int err, struct bt_conn *conn)

Callback for bt_cap_initiator_unicast_audio_stop().

Parameters

err

0 if success. -ENOEXEC if subprocedure could not be performed. -ENOMEM if subprocedure could not be performed due to lack of memory. -EACCES if request rejected by peer. -EBUSY if subprocedure could not be performed because unicast client is already busy. -EINVAL if subprocedure contained invalid parameters. -EBADMSG if unexpected state change happened. -EALREADY if subprocedure could not be performed due to unexpected state. -ECONNRESET if connection dropped during procedure. -ENOTCONN if subprocedure could not be performed due to connection. -ECANCELED if cancelled by bt_cap_initiator_unicast_audio_cancel().

conn

Pointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_initiator_unicast_audio_cancel()

unicast_update_complete

void(* bt_cap_initiator_cb::unicast_update_complete) (int err, struct bt_conn *conn)

Callback for bt_cap_initiator_unicast_audio_update().

Parameters

err

0 if success. -ENOEXEC if subprocedure could not be performed. -ENOMEM if subprocedure could not be performed due to lack of memory. -EACCES if request rejected by peer. -EBUSY if subprocedure could not be performed because unicast client is already busy. -EINVAL if subprocedure contained invalid parameters. -EBADMSG if unexpected state change happened. -ECONNRESET if connection dropped during procedure. -ENOTCONN if subprocedure could not be performed due to connection. -ECANCELED if cancelled by bt_cap_initiator_unicast_audio_cancel().

conn

Pointer to the connection where the error occurred. NULL if err is 0 or if cancelled by bt_cap_initiator_unicast_audio_cancel()

---

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

• include/zephyr/bluetooth/audio/cap.h