CCP Call Control Client APIs

Data Structures
struct	bt_ccp_call_control_client_bearers
	Struct with information about bearers of a client. More...
struct	bt_ccp_call_control_client_cb
	Struct to hold the Telephone Bearer Service client callbacks. More...

Functions
int	bt_ccp_call_control_client_discover (struct bt_conn *conn, struct bt_ccp_call_control_client **out_client)
	Discovers the Telephone Bearer Service (TBS) support on a remote device.
int	bt_ccp_call_control_client_register_cb (struct bt_ccp_call_control_client_cb *cb)
	Register callbacks for the Call Control Client.
int	bt_ccp_call_control_client_unregister_cb (struct bt_ccp_call_control_client_cb *cb)
	Unregister callbacks for the Call Control Client.
int	bt_ccp_call_control_client_get_bearers (struct bt_ccp_call_control_client *client, struct bt_ccp_call_control_client_bearers *bearers)
	Get the bearers of a client instance.
int	bt_ccp_call_control_client_read_bearer_provider_name (struct bt_ccp_call_control_client_bearer *bearer)
	Read the bearer provider name of a remote TBS bearer.

Detailed Description

Function Documentation

bt_ccp_call_control_client_discover()

int bt_ccp_call_control_client_discover	(	struct bt_conn *	conn,
		struct bt_ccp_call_control_client **	out_client )

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

Discovers the Telephone Bearer Service (TBS) support on a remote device.

This will discover the Telephone Bearer Service (TBS) and Generic Telephone Bearer Service (GTBS) on the remote device.

Attention

Available only when the following Kconfig option is enabled: CONFIG_BT_CCP_CALL_CONTROL_CLIENT..

Parameters

conn	Connection to a remote server.
out_client	Pointer to client instance on success

Return values

0	Success
-EINVAL	conn or out_client is NULL
-ENOTCONN	conn is not connected
-ENOMEM	Could not allocated memory for the request
-EBUSY	Already doing discovery for conn
-ENOEXEC	Rejected by the GATT layer

bt_ccp_call_control_client_get_bearers()

int bt_ccp_call_control_client_get_bearers	(	struct bt_ccp_call_control_client *	client,
		struct bt_ccp_call_control_client_bearers *	bearers )

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

Get the bearers of a client instance.

Parameters

[in]	client	The client to get the bearers of.
[out]	bearers	The bearers struct that will be populated with the bearers of client.

Return values

0	Success
-EINVAL	client or bearers is NULL

bt_ccp_call_control_client_read_bearer_provider_name()

int bt_ccp_call_control_client_read_bearer_provider_name

(

struct bt_ccp_call_control_client_bearer *

bearer

)

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

Read the bearer provider name of a remote TBS bearer.

Attention

Available only when the following Kconfig option is enabled: CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME.

Parameters

bearer

The bearer to read the name from

Return values

0	Success
-EINVAL	bearer is NULL
-EFAULT	bearer has not been discovered
-EEXIST	A CCP Call Control Client APIs could not be identified for bearer
-EBUSY	The CCP Call Control Client APIs identified by bearer is busy, or the TBS instance of bearer is busy.
-ENOTCONN	The CCP Call Control Client APIs identified by bearer is not connected

bt_ccp_call_control_client_register_cb()

int bt_ccp_call_control_client_register_cb

(

struct bt_ccp_call_control_client_cb *

cb

)

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

Register callbacks for the Call Control Client.

Parameters

cb	The callback struct

Return values

0	Success
-EINVAL	cb is NULL
-EEXISTS	cb is already registered

bt_ccp_call_control_client_unregister_cb()

int bt_ccp_call_control_client_unregister_cb

(

struct bt_ccp_call_control_client_cb *

cb

)

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

Unregister callbacks for the Call Control Client.

Parameters

cb	The callback struct

Return values

0	Success
-EINVAL	cb is NULL
-EALREADY	cb is not registered