Zephyr API Documentation 4.3.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Audio Video Remote Control Cover Art Profile

Audio Video Remote Control Cover Art Profile (AVRCP-CA) More...

Data Structures

struct  bt_avrcp_cover_art_ct
 AVRCP Controller Cover Art structure. More...
struct  bt_avrcp_cover_art_tg
 AVRCP Target Cover Art structure. More...
struct  bt_avrcp_cover_art_ct_cb
 AVRCP Cover Art Controller callback structure. More...
struct  bt_avrcp_cover_art_tg_cb
 AVRCP Cover Art Target callback structure. More...

Functions

int bt_avrcp_cover_art_ct_cb_register (struct bt_avrcp_cover_art_ct_cb *cb)
 Register AVRCP Cover Art Controller callbacks.
int bt_avrcp_cover_art_tg_cb_register (struct bt_avrcp_cover_art_tg_cb *cb)
 Register AVRCP Cover Art target callbacks.
int bt_avrcp_cover_art_ct_l2cap_connect (struct bt_avrcp_ct *ct, struct bt_avrcp_cover_art_ct **cover_art_ct, uint16_t psm)
 Connect L2CAP channel for AVRCP Cover Art Controller.
int bt_avrcp_cover_art_ct_l2cap_disconnect (struct bt_avrcp_cover_art_ct *ct)
 Disconnect L2CAP channel for AVRCP Cover Art Controller.
int bt_avrcp_cover_art_tg_l2cap_disconnect (struct bt_avrcp_cover_art_tg *tg)
 Disconnect L2CAP channel for AVRCP Cover Art Target.
struct net_bufbt_avrcp_cover_art_ct_create_pdu (struct bt_avrcp_cover_art_ct *ct, struct net_buf_pool *pool)
 Create PDU buffer for AVRCP Cover Art Controller.
struct net_bufbt_avrcp_cover_art_tg_create_pdu (struct bt_avrcp_cover_art_tg *tg, struct net_buf_pool *pool)
 Create PDU buffer for AVRCP Cover Art Target.
int bt_avrcp_cover_art_ct_connect (struct bt_avrcp_cover_art_ct *ct)
 Send OBEX connect request.
int bt_avrcp_cover_art_tg_connect (struct bt_avrcp_cover_art_tg *tg, uint8_t rsp_code)
 Send OBEX connect response.
int bt_avrcp_cover_art_ct_disconnect (struct bt_avrcp_cover_art_ct *ct)
 Send OBEX disconnect request.
int bt_avrcp_cover_art_tg_disconnect (struct bt_avrcp_cover_art_tg *tg, uint8_t rsp_code)
 Send OBEX disconnect response.
int bt_avrcp_cover_art_ct_abort (struct bt_avrcp_cover_art_ct *ct, struct net_buf *buf)
 Send OBEX abort request.
int bt_avrcp_cover_art_tg_abort (struct bt_avrcp_cover_art_tg *tg, uint8_t rsp_code, struct net_buf *buf)
 Send OBEX abort response.
int bt_avrcp_cover_art_ct_get_image_properties (struct bt_avrcp_cover_art_ct *ct, bool final, struct net_buf *buf)
 Send get image properties request.
int bt_avrcp_cover_art_tg_get_image_properties (struct bt_avrcp_cover_art_tg *tg, uint8_t rsp_code, struct net_buf *buf)
 Send get image properties response.
int bt_avrcp_cover_art_ct_get_image (struct bt_avrcp_cover_art_ct *ct, bool final, struct net_buf *buf)
 Send get image request.
int bt_avrcp_cover_art_tg_get_image (struct bt_avrcp_cover_art_tg *tg, uint8_t rsp_code, struct net_buf *buf)
 Send get image response.
int bt_avrcp_cover_art_ct_get_linked_thumbnail (struct bt_avrcp_cover_art_ct *ct, bool final, struct net_buf *buf)
 Send get linked thumbnail request.
int bt_avrcp_cover_art_tg_get_linked_thumbnail (struct bt_avrcp_cover_art_tg *tg, uint8_t rsp_code, struct net_buf *buf)
 Send get linked thumbnail response.

Detailed Description

Audio Video Remote Control Cover Art Profile (AVRCP-CA)

Function Documentation

◆ bt_avrcp_cover_art_ct_abort()

int bt_avrcp_cover_art_ct_abort ( struct bt_avrcp_cover_art_ct * ct,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send OBEX abort request.

Parameters
ctAVRCP Cover Art controller instance
bufRequest data buffer
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_ct_cb_register()

int bt_avrcp_cover_art_ct_cb_register ( struct bt_avrcp_cover_art_ct_cb * cb)

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Register AVRCP Cover Art Controller callbacks.

Parameters
cbPointer to callback structure
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_ct_connect()

int bt_avrcp_cover_art_ct_connect ( struct bt_avrcp_cover_art_ct * ct)

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send OBEX connect request.

Parameters
ctAVRCP Cover Art controller instance
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_ct_create_pdu()

struct net_buf * bt_avrcp_cover_art_ct_create_pdu ( struct bt_avrcp_cover_art_ct * ct,
struct net_buf_pool * pool )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Create PDU buffer for AVRCP Cover Art Controller.

Parameters
ctAVRCP Cover Art controller instance
poolBuffer pool to allocate from
Returns
Allocated buffer or NULL on failure

◆ bt_avrcp_cover_art_ct_disconnect()

int bt_avrcp_cover_art_ct_disconnect ( struct bt_avrcp_cover_art_ct * ct)

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send OBEX disconnect request.

Parameters
ctAVRCP Cover Art controller instance
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_ct_get_image()

int bt_avrcp_cover_art_ct_get_image ( struct bt_avrcp_cover_art_ct * ct,
bool final,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send get image request.

Parameters
ctAVRCP Cover Art controller instance
finalTrue if this is the final packet in the request
bufRequest data buffer containing image descriptor
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_ct_get_image_properties()

int bt_avrcp_cover_art_ct_get_image_properties ( struct bt_avrcp_cover_art_ct * ct,
bool final,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send get image properties request.

Parameters
ctAVRCP Cover Art controller instance
finalTrue if this is the final packet in the request
bufRequest data buffer containing image handle
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_ct_get_linked_thumbnail()

int bt_avrcp_cover_art_ct_get_linked_thumbnail ( struct bt_avrcp_cover_art_ct * ct,
bool final,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send get linked thumbnail request.

Parameters
ctAVRCP Cover Art controller instance
finalTrue if this is the final packet in the request
bufRequest data buffer containing image handle
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_ct_l2cap_connect()

int bt_avrcp_cover_art_ct_l2cap_connect ( struct bt_avrcp_ct * ct,
struct bt_avrcp_cover_art_ct ** cover_art_ct,
uint16_t psm )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Connect L2CAP channel for AVRCP Cover Art Controller.

Parameters
ctAVRCP controller instance
cover_art_ctPointer to store the created Cover Art controller instance
psmProtocol Service Multiplexer for the L2CAP connection
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_ct_l2cap_disconnect()

int bt_avrcp_cover_art_ct_l2cap_disconnect ( struct bt_avrcp_cover_art_ct * ct)

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Disconnect L2CAP channel for AVRCP Cover Art Controller.

Parameters
ctAVRCP Cover Art controller instance
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_tg_abort()

int bt_avrcp_cover_art_tg_abort ( struct bt_avrcp_cover_art_tg * tg,
uint8_t rsp_code,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send OBEX abort response.

Parameters
tgAVRCP Cover Art target instance
rsp_codeOBEX response code
bufResponse data buffer
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_tg_cb_register()

int bt_avrcp_cover_art_tg_cb_register ( struct bt_avrcp_cover_art_tg_cb * cb)

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Register AVRCP Cover Art target callbacks.

Parameters
cbPointer to callback structure
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_tg_connect()

int bt_avrcp_cover_art_tg_connect ( struct bt_avrcp_cover_art_tg * tg,
uint8_t rsp_code )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send OBEX connect response.

Parameters
tgAVRCP Cover Art target instance
rsp_codeOBEX response code
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_tg_create_pdu()

struct net_buf * bt_avrcp_cover_art_tg_create_pdu ( struct bt_avrcp_cover_art_tg * tg,
struct net_buf_pool * pool )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Create PDU buffer for AVRCP Cover Art Target.

Parameters
tgAVRCP Cover Art target instance
poolBuffer pool to allocate from
Returns
Allocated buffer or NULL on failure

◆ bt_avrcp_cover_art_tg_disconnect()

int bt_avrcp_cover_art_tg_disconnect ( struct bt_avrcp_cover_art_tg * tg,
uint8_t rsp_code )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send OBEX disconnect response.

Parameters
tgAVRCP Cover Art target instance
rsp_codeOBEX response code
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_tg_get_image()

int bt_avrcp_cover_art_tg_get_image ( struct bt_avrcp_cover_art_tg * tg,
uint8_t rsp_code,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send get image response.

Parameters
tgAVRCP Cover Art target instance
rsp_codeOBEX response code
bufResponse data buffer containing image data
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_tg_get_image_properties()

int bt_avrcp_cover_art_tg_get_image_properties ( struct bt_avrcp_cover_art_tg * tg,
uint8_t rsp_code,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send get image properties response.

Parameters
tgAVRCP Cover Art target instance
rsp_codeOBEX response code
bufResponse data buffer containing image properties
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_tg_get_linked_thumbnail()

int bt_avrcp_cover_art_tg_get_linked_thumbnail ( struct bt_avrcp_cover_art_tg * tg,
uint8_t rsp_code,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Send get linked thumbnail response.

Parameters
tgAVRCP Cover Art target instance
rsp_codeOBEX response code
bufResponse data buffer containing thumbnail data
Returns
0 on success, negative error code on failure

◆ bt_avrcp_cover_art_tg_l2cap_disconnect()

int bt_avrcp_cover_art_tg_l2cap_disconnect ( struct bt_avrcp_cover_art_tg * tg)

#include <zephyr/bluetooth/classic/avrcp_cover_art.h>

Disconnect L2CAP channel for AVRCP Cover Art Target.

Parameters
tgAVRCP Cover Art target instance
Returns
0 on success, negative error code on failure