xref: /btstack/src/classic/avrcp_browsing_controller.h (revision e30788a349d5f828c85e078d0b321f42b825c51d)
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 MATTHIAS
24  * RINGWALD 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  * avrcp_browsing.h
40  *
41  * Audio/Video Remote Control Profile Browsing
42  *
43  */
44 
45 #ifndef __AVRCP_BROWSING_CONTROLLER_H
46 #define __AVRCP_BROWSING_CONTROLLER_H
47 
48 #include <stdint.h>
49 #include "avrcp.h"
50 
51 #if defined __cplusplus
52 extern "C" {
53 #endif
54 
55 
56 /* API_START */
57 
58 /**
59  * @brief Set up AVRCP Browsing Controller device.
60  */
61 void avrcp_browsing_controller_init(void);
62 
63 /**
64  * @brief Register callback for the AVRCP Browsing Controller client.
65  * @param callback
66  */
67 // void avrcp_browsing_controller_register_packet_handler(btstack_packet_handler_t callback);
68 
69 /**
70  * @brief Connect to device with a Bluetooth address.
71  * @param bd_addr
72  * @param ertm_buffer
73  * @param ertm_buffer_size
74  * @param ertm_config
75  * @param avrcp_browsing_cid
76  * @returns status
77  */
78 uint8_t avrcp_browsing_controller_connect(bd_addr_t bd_addr, uint8_t * ertm_buffer, uint32_t size, l2cap_ertm_config_t * ertm_config, uint16_t * avrcp_browsing_cid);
79 
80 /**
81  * @brief Disconnect from AVRCP target
82  * @param avrcp_browsing_cid
83  * @returns status
84  */
85 uint8_t avrcp_browsing_controller_disconnect(uint16_t avrcp_browsing_cid);
86 
87 /**
88  * @brief Retrieve a listing of the contents of a folder.
89  * @param avrcp_browsing_cid
90  * @param scope    0-player list, 1-virtual file system, 2-search, 3-now playing
91  * @param start_item
92  * @param end_item
93  * @param attribute_count
94  * @param attribute_list
95  **/
96 uint8_t avrcp_browsing_controller_get_folder_items(uint16_t avrcp_browsing_cid, uint8_t scope, uint32_t start_item, uint32_t end_item, uint8_t attribute_count, uint8_t * attribute_list);
97 
98 /**
99  * @brief Retrieve a player list.
100  * @param avrcp_browsing_cid
101  **/
102 uint8_t avrcp_browsing_controller_get_player_list(uint16_t avrcp_browsing_cid);
103 
104 /* API_END */
105 
106 #if defined __cplusplus
107 }
108 #endif
109 
110 #endif // __AVRCP_BROWSING_CONTROLLER_H