Zephyr API Documentation  3.5.0
A Scalable Open Source RTOS
3.5.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
pacs.h File Reference

Go to the source code of this file.

Data Structures

struct  bt_pacs_cap
 Published Audio Capability structure. More...
 

Typedefs

typedef bool(* bt_pacs_cap_foreach_func_t) (const struct bt_pacs_cap *cap, void *user_data)
 Published Audio Capability iterator callback.
 

Functions

void bt_pacs_cap_foreach (enum bt_audio_dir dir, bt_pacs_cap_foreach_func_t func, void *user_data)
 Published Audio Capability iterator.
 
int bt_pacs_cap_register (enum bt_audio_dir dir, struct bt_pacs_cap *cap)
 Register Published Audio Capability.
 
int bt_pacs_cap_unregister (enum bt_audio_dir dir, struct bt_pacs_cap *cap)
 Unregister Published Audio Capability.
 
int bt_pacs_set_location (enum bt_audio_dir dir, enum bt_audio_location location)
 Set the location for an endpoint type.
 
int bt_pacs_set_available_contexts (enum bt_audio_dir dir, enum bt_audio_context contexts)
 Set the available contexts for an endpoint type.
 
enum bt_audio_context bt_pacs_get_available_contexts (enum bt_audio_dir dir)
 Get the available contexts for an endpoint type.
 
int bt_pacs_set_supported_contexts (enum bt_audio_dir dir, enum bt_audio_context contexts)
 Set the supported contexts for an endpoint type.
 

Typedef Documentation

◆ bt_pacs_cap_foreach_func_t

bt_pacs_cap_foreach_func_t

Published Audio Capability iterator callback.

Parameters
capCapability found.
user_dataData given.
Returns
true to continue to the next capability
false to stop the iteration

Function Documentation

◆ bt_pacs_cap_foreach()

void bt_pacs_cap_foreach ( enum bt_audio_dir  dir,
bt_pacs_cap_foreach_func_t  func,
void *  user_data 
)

Published Audio Capability iterator.

Iterate capabilities with endpoint direction specified.

Parameters
dirDirection of the endpoint to look capability for.
funcCallback function.
user_dataData to pass to the callback.

◆ bt_pacs_cap_register()

int bt_pacs_cap_register ( enum bt_audio_dir  dir,
struct bt_pacs_cap cap 
)

Register Published Audio Capability.

Register Audio Local Capability.

Parameters
dirDirection of the endpoint to register capability for.
capCapability structure.
Returns
0 in case of success or negative value in case of error.

◆ bt_pacs_cap_unregister()

int bt_pacs_cap_unregister ( enum bt_audio_dir  dir,
struct bt_pacs_cap cap 
)

Unregister Published Audio Capability.

Unregister Audio Local Capability.

Parameters
dirDirection of the endpoint to unregister capability for.
capCapability structure.
Returns
0 in case of success or negative value in case of error.

◆ bt_pacs_get_available_contexts()

enum bt_audio_context bt_pacs_get_available_contexts ( enum bt_audio_dir  dir)

Get the available contexts for an endpoint type.

Parameters
dirDirection of the endpoints to get contexts for.
Returns
Bitmask of available contexts.

◆ bt_pacs_set_available_contexts()

int bt_pacs_set_available_contexts ( enum bt_audio_dir  dir,
enum bt_audio_context  contexts 
)

Set the available contexts for an endpoint type.

Parameters
dirDirection of the endpoints to change available contexts for.
contextsThe contexts to be set.

◆ bt_pacs_set_location()

int bt_pacs_set_location ( enum bt_audio_dir  dir,
enum bt_audio_location  location 
)

Set the location for an endpoint type.

Parameters
dirDirection of the endpoints to change location for.
locationThe location to be set.

◆ bt_pacs_set_supported_contexts()

int bt_pacs_set_supported_contexts ( enum bt_audio_dir  dir,
enum bt_audio_context  contexts 
)

Set the supported contexts for an endpoint type.

Parameters
dirDirection of the endpoints to change available contexts for.
contextsThe contexts to be set.