xref: /btstack/src/classic/avrcp_browsing_target.h (revision 036e10079a77215137b087eeca70f0a6f3513b84)
1 /*
2  * Copyright (C) 2016 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /**
39  * @title AVRCP Browsing Target
40  *
41  */
42 
43 #ifndef AVRCP_BROWSING_TARGET_H
44 #define AVRCP_BROWSING_TARGET_H
45 
46 #include <stdint.h>
47 #include "classic/avrcp.h"
48 
49 #if defined __cplusplus
50 extern "C" {
51 #endif
52 
53 
54 /* API_START */
55 
56 /**
57  * @brief Set up AVRCP Browsing Controller device.
58  */
59 void avrcp_browsing_target_init(void);
60 
61 /**
62  * @brief Register callback for the AVRCP Browsing Controller client.
63  * @param callback
64  */
65 void avrcp_browsing_target_register_packet_handler(btstack_packet_handler_t callback);
66 
67 /**
68  * @brief Accept set browsed player
69  * @param browsing_cid
70  * @param uid_counter
71  * @param browsed_player_id
72  * @param response
73  * @param response_size
74  */
75 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);
76 
77 /**
78  * @brief Reject set browsed player
79  * @param browsing_cid
80  * @param status
81  */
82 uint8_t avrcp_browsing_target_send_reject_set_browsed_player(uint16_t browsing_cid, avrcp_status_code_t status);
83 
84 /**
85  * @brief Send answer to get folder items query on event AVRCP_SUBEVENT_BROWSING_GET_FOLDER_ITEMS. The first byte of this event defines the scope of the query, see avrcp_browsing_scope_t.
86  * @param browsing_cid
87  * @param uid_counter
88  * @param attr_list
89  * @param attr_list_size
90  */
91 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);
92 
93 /**
94  * @brief Send answer to get total number of items query on event AVRCP_SUBEVENT_BROWSING_GET_TOTAL_NUM_ITEMS. The first byte of this event defines the scope of the query, see avrcp_browsing_scope_t.
95  * @param browsing_cid
96  * @param uid_counter
97  * @param total_num_items
98  */
99 uint8_t avrcp_browsing_target_send_get_total_num_items_response(uint16_t browsing_cid, uint16_t uid_counter, uint32_t total_num_items);
100 
101 uint8_t avrcp_browsing_target_send_change_path_response(uint16_t avrcp_browsing_cid, avrcp_status_code_t status, uint32_t num_items);
102 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);
103 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);
104 
105 /**
106  * @brief De-Init AVRCP Browsing Controller
107  */
108 void avrcp_browsing_target_deinit(void);
109 
110 /* API_END */
111 
112 #if defined __cplusplus
113 }
114 #endif
115 
116 #endif // AVRCP_BROWSING_TARGET_H
117