1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
// SPDX-License-Identifier: BSD-2-Clause
// Copyright The Music Player Daemon Project
/*! \file
* \brief MPD client library
*
* Do not include this header directly. Use mpd/client.h instead.
*/
#ifndef MPD_CAPABILITIES_H
#define MPD_CAPABILITIES_H
#include "recv.h"
#include "compiler.h"
#include "tag.h"
#include <stdbool.h>
struct mpd_connection;
#ifdef __cplusplus
extern "C" {
#endif
/**
* Requests a list of supported and allowed commands. Use
* mpd_recv_command_pair() to obtain the list of "command" pairs.
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_send_allowed_commands(struct mpd_connection *connection);
/**
* Requests a list of supported commands which are not allowed for
* this connection. Use mpd_recv_command_pair() to obtain the list of
* "command" pairs.
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_send_disallowed_commands(struct mpd_connection *connection);
/**
* Receives the next supported command. Call this in a loop after
* mpd_send_allowed_commands() or mpd_send_disallowed_commands().
*
* Free the return value with mpd_return_pair().
*
* @param connection a #mpd_connection
* @returns a "command" pair, or NULL on error or if the end of the
* response is reached
*/
mpd_malloc
static inline struct mpd_pair *
mpd_recv_command_pair(struct mpd_connection *connection)
{
return mpd_recv_pair_named(connection, "command");
}
/**
* Requests a list of supported URL handlers in the form "scheme://",
* example: "http://". Use mpd_recv_url_scheme_pair() to obtain the list
* of "handler" pairs.
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_send_list_url_schemes(struct mpd_connection *connection);
/**
* Receives one line of the mpd_send_url_schemes() response.
*
* Free the return value with mpd_return_pair().
*
* @param connection a #mpd_connection
* @returns a "handler" pair, or NULL on error or if the end of the
* response is reached
*/
mpd_malloc
static inline struct mpd_pair *
mpd_recv_url_scheme_pair(struct mpd_connection *connection)
{
return mpd_recv_pair_named(connection, "handler");
}
/**
* Requests a list of supported tag types. Use mpd_recv_tag_type_pair()
* to obtain the list of "tagtype" pairs.
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_send_list_tag_types(struct mpd_connection *connection);
/**
* Receives the next tag type name. Call this in a loop after
* mpd_send_list_tag_types().
*
* Free the return value with mpd_return_pair().
*
* @param connection a #mpd_connection
* @returns a "tagtype" pair, or NULL on error or if the end of the
* response is reached
*/
mpd_malloc
static inline struct mpd_pair *
mpd_recv_tag_type_pair(struct mpd_connection *connection)
{
return mpd_recv_pair_named(connection, "tagtype");
}
/**
* Remove one or more tags from the list of tag types the client is
* interested in. These will be omitted from responses to this
* client.
*
* @param connection the connection to MPD
* @param types an array of tag types to disable
* @param n the number of tag types in the array
* @return true on success, false on error
*
* @since libmpdclient 2.12, MPD 0.21
*/
bool
mpd_send_disable_tag_types(struct mpd_connection *connection,
const enum mpd_tag_type *types, unsigned n);
/**
* Shortcut for mpd_send_disable_tag_types() and mpd_response_finish().
*
* @since libmpdclient 2.12, MPD 0.21
*/
bool
mpd_run_disable_tag_types(struct mpd_connection *connection,
const enum mpd_tag_type *types, unsigned n);
/**
* Re-enable one or more tags from the list of tag types for this
* client. These will no longer be hidden from responses to this
* client.
*
* @param connection the connection to MPD
* @param types an array of tag types to enable
* @param n the number of tag types in the array
* @return true on success, false on error
*
* @since libmpdclient 2.12, MPD 0.21
*/
bool
mpd_send_enable_tag_types(struct mpd_connection *connection,
const enum mpd_tag_type *types, unsigned n);
/**
* Shortcut for mpd_send_enable_tag_types() and mpd_response_finish().
*
* @since libmpdclient 2.12, MPD 0.21
*/
bool
mpd_run_enable_tag_types(struct mpd_connection *connection,
const enum mpd_tag_type *types, unsigned n);
/**
* Clear the list of tag types this client is interested in. This
* means that MPD will not send any tags to this client.
*
* @param connection the connection to MPD
* @return true on success, false on error
*
* @since libmpdclient 2.12, MPD 0.21
*/
bool
mpd_send_clear_tag_types(struct mpd_connection *connection);
/**
* Shortcut for mpd_send_clear_tag_types() and mpd_response_finish().
*
* @since libmpdclient 2.12, MPD 0.21
*/
bool
mpd_run_clear_tag_types(struct mpd_connection *connection);
/**
* Add all tags to the list of tag types this client is interested in.
* This means that MPD will send all tags to this client.
*
* @param connection the connection to MPD
* @return true on success, false on error
*
* @since libmpdclient 2.19, MPD 0.21
*/
bool
mpd_send_all_tag_types(struct mpd_connection *connection);
/**
* Shortcut for mpd_send_all_tag_types() and mpd_response_finish().
*
* @since libmpdclient 2.19, MPD 0.21
*/
bool
mpd_run_all_tag_types(struct mpd_connection *connection);
#ifdef __cplusplus
}
#endif
#endif
|
