capabilities.h File Reference

#include <zephyr/bluetooth/audio/audio.h>

Go to the source code of this file.

Data Structures
struct	bt_audio_capability_pref
	Audio Capability Preference structure. More...
struct	bt_audio_capability_ops
	Capability operations structure. More...
struct	bt_audio_capability
	Audio Capability structure. More...

Macros
#define	BT_AUDIO_CAPABILITY_PREF(_framing, _phy, _rtn, _latency, _pd_min, _pd_max, _pref_pd_min, _pref_pd_max)
	Helper to declare elements of bt_audio_capability_pref. More...

Enumerations
enum	bt_audio_capability_framing { BT_AUDIO_CAPABILITY_UNFRAMED_SUPPORTED = 0x00 , BT_AUDIO_CAPABILITY_UNFRAMED_NOT_SUPPORTED = 0x01 }
	Audio Capability type. More...

Functions
sys_slist_t *	bt_audio_capability_get (enum bt_audio_dir dir)
int	bt_audio_capability_register (struct bt_audio_capability *cap)
	Register Audio Capability. More...
int	bt_audio_capability_unregister (struct bt_audio_capability *cap)
	Unregister Audio Capability. More...
int	bt_audio_capability_set_location (enum bt_audio_dir dir, enum bt_audio_location location)
	Set the location for an endpoint type. More...
int	bt_audio_capability_set_available_contexts (enum bt_audio_dir dir, enum bt_audio_context contexts)
	Set the available contexts for an endpoint type. More...
enum bt_audio_context	bt_audio_capability_get_available_contexts (enum bt_audio_dir dir)
	Get the available contexts for an endpoint type. More...

Macro Definition Documentation

BT_AUDIO_CAPABILITY_PREF

#define BT_AUDIO_CAPABILITY_PREF	(		_framing,
			_phy,
			_rtn,
			_latency,
			_pd_min,
			_pd_max,
			_pref_pd_min,
			_pref_pd_max
	)

Value:

        { \
                .framing = _framing, \
                .phy = _phy, \
                .rtn = _rtn, \
                .latency = _latency, \
                .pd_min = _pd_min, \
                .pd_max = _pd_max, \
                .pref_pd_min = _pref_pd_min, \
                .pref_pd_max = _pref_pd_max, \
        }

Helper to declare elements of bt_audio_capability_pref.

Parameters

_framing	Framing Support
_phy	Preferred Target PHY
_rtn	Preferred Retransmission number
_latency	Preferred Maximum Transport Latency (msec)
_pd_min	Minimum Presentation Delay (usec)
_pd_max	Maximum Presentation Delay (usec)
_pref_pd_min	Preferred Minimum Presentation Delay (usec)
_pref_pd_max	Preferred Maximum Presentation Delay (usec)

Enumeration Type Documentation

bt_audio_capability_framing

enum bt_audio_capability_framing

Audio Capability type.

Enumerator
BT_AUDIO_CAPABILITY_UNFRAMED_SUPPORTED
BT_AUDIO_CAPABILITY_UNFRAMED_NOT_SUPPORTED

Function Documentation

bt_audio_capability_get()

sys_slist_t * bt_audio_capability_get

(

enum bt_audio_dir

dir

)

bt_audio_capability_get_available_contexts()

enum bt_audio_context bt_audio_capability_get_available_contexts

(

enum bt_audio_dir

dir

)

Get the available contexts for an endpoint type.

Parameters

dir	Direction of the endpoints to get contexts for.

Returns

Bitmask of available contexts.

bt_audio_capability_register()

int bt_audio_capability_register

(

struct bt_audio_capability *

cap

)

Register Audio Capability.

Register Audio Local Capability.

Parameters

cap	Capability structure.

Returns

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

bt_audio_capability_set_available_contexts()

int bt_audio_capability_set_available_contexts	(	enum bt_audio_dir	dir,
		enum bt_audio_context	contexts
	)

Set the available contexts for an endpoint type.

Parameters

dir	Direction of the endpoints to change available contexts for.
contexts	The contexts to be set.

bt_audio_capability_set_location()

int bt_audio_capability_set_location	(	enum bt_audio_dir	dir,
		enum bt_audio_location	location
	)

Set the location for an endpoint type.

Parameters

dir	Direction of the endpoints to change location for.
location	The location to be set.

bt_audio_capability_unregister()

int bt_audio_capability_unregister

(

struct bt_audio_capability *

cap

)

Unregister Audio Capability.

Unregister Audio Local Capability.

Parameters

cap	Capability structure.

Returns

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