Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Bluetooth Content Control Identifier

Bluetooth Content Control Identifier (CCID) . More...

Macros

#define BT_CCID_MIN   0
 Minimum CCID value.
 
#define BT_CCID_MAX   255
 Maximum CCID value.
 

Functions

int bt_ccid_alloc_value (void)
 Allocates a CCID value.
 
const struct bt_gatt_attrbt_ccid_find_attr (uint8_t ccid)
 Get the GATT attribute of a CCID value.
 

Detailed Description

Bluetooth Content Control Identifier (CCID) .

Since
3.7
Version
0.8.0

The Content Control Identifier (CCID) API manages CCIDs for BT_UUID_CCID characteristics.

Macro Definition Documentation

◆ BT_CCID_MAX

#define BT_CCID_MAX   255

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

Maximum CCID value.

◆ BT_CCID_MIN

#define BT_CCID_MIN   0

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

Minimum CCID value.

Function Documentation

◆ bt_ccid_alloc_value()

int bt_ccid_alloc_value ( void )

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

Allocates a CCID value.

This should always be called right before registering a GATT service that contains a BT_UUID_CCID characteristic. Allocating a CCID without registering the characteristic may (in very rare cases) result in duplicated CCIDs on the device.

Requires that

CONFIG_BT_CONN 

is enabled.

Return values
ccid8-bit unsigned CCID value on success
-ENOMEMNo more CCIDs can be allocated

◆ bt_ccid_find_attr()

const struct bt_gatt_attr * bt_ccid_find_attr ( uint8_t ccid)

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

Get the GATT attribute of a CCID value.

Searches the current GATT database for a CCID characteristic that has the supplied CCID value.

Requires that

CONFIG_BT_CONN 

is enabled.

Parameters
ccidThe CCID to search for
Return values
NULLNone was found
attrPointer to a GATT attribute