bt_audio_capability_ops Struct Reference

Capability operations structure. More...

#include <capabilities.h>

Data Fields
struct bt_audio_stream *(*	config )(struct bt_conn *conn, struct bt_audio_ep *ep, enum bt_audio_dir dir, struct bt_audio_capability *cap, struct bt_codec *codec)
	Capability config callback. More...
int(*	reconfig )(struct bt_audio_stream *stream, struct bt_audio_capability *cap, struct bt_codec *codec)
	Capability reconfig callback. More...
int(*	qos )(struct bt_audio_stream *stream, struct bt_codec_qos *qos)
	Capability QoS callback. More...
int(*	enable )(struct bt_audio_stream *stream, struct bt_codec_data *meta, size_t meta_count)
	Capability Enable callback. More...
int(*	start )(struct bt_audio_stream *stream)
	Capability Start callback. More...
int(*	metadata )(struct bt_audio_stream *stream, struct bt_codec_data *meta, size_t meta_count)
	Capability Metadata callback. More...
int(*	disable )(struct bt_audio_stream *stream)
	Capability Disable callback. More...
int(*	stop )(struct bt_audio_stream *stream)
	Capability Stop callback. More...
int(*	release )(struct bt_audio_stream *stream)
	Capability release callback. More...

Detailed Description

Capability operations structure.

These are only used for unicast streams and broadcast sink streams.

Field Documentation

config

struct bt_audio_stream *(* bt_audio_capability_ops::config) (struct bt_conn *conn, struct bt_audio_ep *ep, enum bt_audio_dir dir, struct bt_audio_capability *cap, struct bt_codec *codec)

Capability config callback.

Config callback is called whenever a new Audio Stream needs to be allocated.

Parameters

conn	Connection object
ep	Remote Audio Endpoint being configured
dir	Direction of the endpoint.
cap	Local Audio Capability being configured
codec	Codec configuration

Returns

Allocated Audio Stream object or NULL in case of error.

disable

int(* bt_audio_capability_ops::disable) (struct bt_audio_stream *stream)

Capability Disable callback.

Disable callback is called whenever an Audio Stream is about to be disabled.

Parameters

stream

Stream object being disabled.

Returns

0 in case of success or negative value in case of error.

enable

int(* bt_audio_capability_ops::enable) (struct bt_audio_stream *stream, struct bt_codec_data *meta, size_t meta_count)

Capability Enable callback.

Enable callback is called whenever an Audio Stream is about to be enabled.

Parameters

stream	Stream object being enabled.
meta_count	Number of metadata entries
meta	Metadata entries

Returns

0 in case of success or negative value in case of error.

metadata

int(* bt_audio_capability_ops::metadata) (struct bt_audio_stream *stream, struct bt_codec_data *meta, size_t meta_count)

Capability Metadata callback.

Metadata callback is called whenever an Audio Stream needs to update its metadata.

Parameters

stream	Stream object.
meta_count	Number of metadata entries
meta	Metadata entries

Returns

0 in case of success or negative value in case of error.

qos

int(* bt_audio_capability_ops::qos) (struct bt_audio_stream *stream, struct bt_codec_qos *qos)

Capability QoS callback.

QoS callback is called whenever an Audio Stream Quality of Service needs to be configured.

Parameters

stream	Stream object being reconfigured.
QoS	Quality of Service configuration

Returns

0 in case of success or negative value in case of error.

reconfig

int(* bt_audio_capability_ops::reconfig) (struct bt_audio_stream *stream, struct bt_audio_capability *cap, struct bt_codec *codec)

Capability reconfig callback.

Reconfig callback is called whenever an Audio Stream needs to be reconfigured with different codec configuration.

Parameters

stream	Stream object being reconfigured.
cap	Local Audio Capability being reconfigured
codec	Codec configuration

Returns

0 in case of success or negative value in case of error.

release

int(* bt_audio_capability_ops::release) (struct bt_audio_stream *stream)

Capability release callback.

Release callback is called whenever a new Audio Stream needs to be deallocated.

Parameters

stream

Stream object.

Returns

0 in case of success or negative value in case of error.

start

int(* bt_audio_capability_ops::start) (struct bt_audio_stream *stream)

Capability Start callback.

Start callback is called whenever an Audio Stream is about to start streaming.

Parameters

stream

Stream object.

Returns

0 in case of success or negative value in case of error.

stop

int(* bt_audio_capability_ops::stop) (struct bt_audio_stream *stream)

Capability Stop callback.

Stop callback is called whenever an Audio Stream is about to stop streaming.

Parameters

stream

Stream object.

Returns

0 in case of success or negative value in case of error.

---

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

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