mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-03-26 02:37:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

avrcp_browsing_target: update API docu

Browse Source
This commit is contained in:
Milanka Ringwald 2025-01-30 12:46:32 +01:00
parent 085892ca0d
commit 773b7cf44f
1 changed files with 56 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
src/classic/avrcp_browsing_target.h
View File

@ -54,12 +54,19 @@ extern "C" {
/* API_START */
/**
* @brief Set up AVRCP Browsing Controller device.
* @brief Set up AVRCP Browsing Target client.
*/
void avrcp_browsing_target_init(void);
/**
* @brief Register callback for the AVRCP Browsing Controller client.
* @brief Register callback for the AVRCP Browsing Target client to receive events:
* - AVRCP_SUBEVENT_BROWSING_SEARCH
* - AVRCP_SUBEVENT_BROWSING_GET_FOLDER_ITEMS
* - AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS
* - AVRCP_SUBEVENT_BROWSING_SET_BROWSED_PLAYER
* - AVRCP_SUBEVENT_BROWSING_CHANGE_PATH
* - AVRCP_SUBEVENT_BROWSING_GET_ITEM_ATTRIBUTES
*
* @param callback
*/
void avrcp_browsing_target_register_packet_handler(btstack_packet_handler_t callback);
@ -71,6 +78,9 @@ void avrcp_browsing_target_register_packet_handler(btstack_packet_handler_t call
* @param browsed_player_id
* @param response
* @param response_size
* @return ERROR_CODE_SUCCESS if successful, otherwise:
* - ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if unknown connection cid,
* - ERROR_CODE_COMMAND_DISALLOWED if client is not done with previous query.
*/
uint8_t avrcp_browsing_target_send_accept_set_browsed_player(uint16_t browsing_cid, uint16_t uid_counter, uint16_t browsed_player_id, uint8_t * response, uint16_t response_len);
@ -78,6 +88,9 @@ uint8_t avrcp_browsing_target_send_accept_set_browsed_player(uint16_t browsing_c
* @brief Reject set browsed player
* @param browsing_cid
* @param status
* @return ERROR_CODE_SUCCESS if successful, otherwise:
* - ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if unknown connection cid,
* - ERROR_CODE_COMMAND_DISALLOWED if client is not done with previous query.
*/
uint8_t avrcp_browsing_target_send_reject_set_browsed_player(uint16_t browsing_cid, avrcp_status_code_t status);
@ -87,6 +100,9 @@ uint8_t avrcp_browsing_target_send_reject_set_browsed_player(uint16_t browsing_c
* @param uid_counter
* @param attr_list
* @param attr_list_size
* @return ERROR_CODE_SUCCESS if successful, otherwise:
* - ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if unknown connection cid,
* - ERROR_CODE_COMMAND_DISALLOWED if client is not done with previous query.
*/
uint8_t avrcp_browsing_target_send_get_folder_items_response(uint16_t browsing_cid, uint16_t uid_counter, uint8_t * attr_list, uint16_t attr_list_size, uint16_t num_items);
@ -95,15 +111,49 @@ uint8_t avrcp_browsing_target_send_get_folder_items_response(uint16_t browsing_c
* @param browsing_cid
* @param uid_counter
* @param total_num_items
* @return ERROR_CODE_SUCCESS if successful, otherwise:
* - ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if unknown connection cid,
* - ERROR_CODE_COMMAND_DISALLOWED if client is not done with previous query.
*/
uint8_t avrcp_browsing_target_send_get_total_num_items_response(uint16_t browsing_cid, uint16_t uid_counter, uint32_t total_num_items);
uint8_t avrcp_browsing_target_send_change_path_response(uint16_t avrcp_browsing_cid, avrcp_status_code_t status, uint32_t num_items);
uint8_t avrcp_browsing_target_send_get_item_attributes_response(uint16_t avrcp_browsing_cid, avrcp_status_code_t status, uint8_t * attr_list, uint16_t attr_list_size, uint8_t num_items);
uint8_t avrcp_browsing_target_send_search_response(uint16_t avrcp_browsing_cid, avrcp_status_code_t status, uint16_t uid_counter, uint32_t num_items);
/**
* @brief Send answer to change path command on event AVRCP_SUBEVENT_BROWSING_CHANGE_PATH.
* @param browsing_cid
* @param status
* @param num_items
* @return ERROR_CODE_SUCCESS if successful, otherwise:
* - ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if unknown connection cid,
* - ERROR_CODE_COMMAND_DISALLOWED if client is not done with previous query.
*/
uint8_t avrcp_browsing_target_send_change_path_response(uint16_t browsing_cid, avrcp_status_code_t status, uint32_t num_items);
/**
* @brief De-Init AVRCP Browsing Controller
* @brief Send answer to get item attribute response on event AVRCP_SUBEVENT_BROWSING_GET_ITEM_ATTRIBUTES.
* @param browsing_cid
* @param status
* @param attr_list
* @param attr_list_size
* @param num_items
* @return ERROR_CODE_SUCCESS if successful, otherwise:
* - ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if unknown connection cid,
* - ERROR_CODE_COMMAND_DISALLOWED if client is not done with previous query.
*/
uint8_t avrcp_browsing_target_send_get_item_attributes_response(uint16_t browsing_cid, avrcp_status_code_t status, uint8_t * attr_list, uint16_t attr_list_size, uint8_t num_items);
/**
* @brief Send answer to search query on event AVRCP_SUBEVENT_BROWSING_SEARCH.
* @param browsing_cid
* @param uid_counter
* @param total_num_items
* @return ERROR_CODE_SUCCESS if successful, otherwise:
* - ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if unknown connection cid,
* - ERROR_CODE_COMMAND_DISALLOWED if client is not done with previous query.
*/
uint8_t avrcp_browsing_target_send_search_response(uint16_t browsing_cid, avrcp_status_code_t status, uint16_t uid_counter, uint32_t num_items);
/**
* @brief De-Init AVRCP Browsing Target
*/
void avrcp_browsing_target_deinit(void);