Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
CCP Call Control Server APIs

Functions

int bt_ccp_call_control_server_register_bearer (const struct bt_tbs_register_param *param, struct bt_ccp_call_control_server_bearer **bearer)
 Register a Telephone Bearer.
 
int bt_ccp_call_control_server_unregister_bearer (struct bt_ccp_call_control_server_bearer *bearer)
 Unregister a Telephone Bearer.
 

Detailed Description

Function Documentation

◆ bt_ccp_call_control_server_register_bearer()

int bt_ccp_call_control_server_register_bearer ( const struct bt_tbs_register_param * param,
struct bt_ccp_call_control_server_bearer ** bearer )

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

Register a Telephone Bearer.

This will register a Telephone Bearer Service (TBS) (or a Generic Telephone Bearer service (GTBS)) with the provided parameters.

As per the TBS specification, the GTBS shall be instantiated for the feature, and as such a GTBS shall always be registered before any TBS can be registered. Similarly, all TBS shall be unregistered before the GTBS can be unregistered with bt_ccp_call_control_server_unregister_bearer().

Parameters
[in]paramThe parameters to initialize the bearer.
[out]bearerPointer to the initialized bearer.
Return values
0Success
-EINVALparam contains invalid data
-EALREADYparam.gtbs is true and GTBS has already been registered
-EAGAINparam.gtbs is false and GTBS has not been registered
-ENOMEMparam.gtbs is false and no more TBS can be registered (see CONFIG_BT_TBS_BEARER_COUNT)
-ENOEXECThe service failed to be registered

◆ bt_ccp_call_control_server_unregister_bearer()

int bt_ccp_call_control_server_unregister_bearer ( struct bt_ccp_call_control_server_bearer * bearer)

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

Unregister a Telephone Bearer.

This will unregister a Telephone Bearer Service (TBS) (or a Generic Telephone Bearer service (GTBS)) with the provided parameters. The bearer shall be registered first by bt_ccp_call_control_server_register_bearer() before it can be unregistered.

All TBS shall be unregistered before the GTBS can be unregistered with.

Parameters
bearerThe bearer to unregister.
Return values
0Success
-EINVALbearer is NULL
-EALREADYThe bearer is not registered
-ENOEXECThe service failed to be unregistered