abadef6691ee0d9d807efd3f7ef950510f3a67c5
[disorder] / lib / client.h
1 /*
2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2008 Richard Kettlewell
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18 * USA
19 */
20 /** @file lib/client.h
21 * @brief Simple C client
22 *
23 * See @ref lib/eclient.h for an asynchronous-capable client
24 * implementation.
25 */
26
27 #ifndef CLIENT_H
28 #define CLIENT_H
29
30 /** @brief Client data */
31 typedef struct disorder_client disorder_client;
32
33 struct queue_entry;
34 struct kvp;
35 struct sink;
36
37 disorder_client *disorder_new(int verbose);
38 int disorder_connect(disorder_client *c);
39 int disorder_connect_user(disorder_client *c,
40 const char *username,
41 const char *password);
42 int disorder_connect_cookie(disorder_client *c, const char *cookie);
43 int disorder_close(disorder_client *c);
44 int disorder_version(disorder_client *c, char **versionp);
45 int disorder_play(disorder_client *c, const char *track);
46 int disorder_remove(disorder_client *c, const char *track);
47 int disorder_move(disorder_client *c, const char *track, int delta);
48 int disorder_enable(disorder_client *c);
49 int disorder_disable(disorder_client *c);
50 int disorder_scratch(disorder_client *c, const char *id);
51 int disorder_shutdown(disorder_client *c);
52 int disorder_reconfigure(disorder_client *c);
53 int disorder_rescan(disorder_client *c);
54 int disorder_playing(disorder_client *c, struct queue_entry **qp);
55 int disorder_recent(disorder_client *c, struct queue_entry **qp);
56 int disorder_queue(disorder_client *c, struct queue_entry **qp);
57 int disorder_directories(disorder_client *c, const char *dir, const char *re,
58 char ***vecp, int *nvecp);
59 int disorder_files(disorder_client *c, const char *dir, const char *re,
60 char ***vecp, int *nvecp);
61 int disorder_allfiles(disorder_client *c, const char *dir, const char *re,
62 char ***vecp, int *nvecp);
63 char *disorder_user(disorder_client *c);
64 int disorder_exists(disorder_client *c, const char *track, int *existsp);
65 int disorder_enabled(disorder_client *c, int *enabledp);
66 int disorder_set(disorder_client *c, const char *track,
67 const char *key, const char *value);
68 int disorder_unset(disorder_client *c, const char *track,
69 const char *key);
70 int disorder_get(disorder_client *c, const char *track, const char *key,
71 char **valuep);
72 int disorder_prefs(disorder_client *c, const char *track,
73 struct kvp **kp);
74 int disorder_length(disorder_client *c, const char *track,
75 long *valuep);
76 int disorder_search(disorder_client *c, const char *terms,
77 char ***vecp, int *nvecp);
78 int disorder_random_enable(disorder_client *c);
79 int disorder_random_disable(disorder_client *c);
80 int disorder_random_enabled(disorder_client *c, int *enabledp);
81 int disorder_stats(disorder_client *c,
82 char ***vecp, int *nvecp);
83 int disorder_set_volume(disorder_client *c, int left, int right);
84 int disorder_get_volume(disorder_client *c, int *left, int *right);
85 int disorder_log(disorder_client *c, struct sink *s);
86 int disorder_part(disorder_client *c, char **partp,
87 const char *track, const char *context, const char *part);
88 int disorder_resolve(disorder_client *c, char **trackp, const char *track);
89 int disorder_pause(disorder_client *c);
90 int disorder_resume(disorder_client *c);
91 int disorder_tags(disorder_client *c,
92 char ***vecp, int *nvecp);
93 int disorder_set_global(disorder_client *c,
94 const char *key, const char *value);
95 int disorder_unset_global(disorder_client *c, const char *key);
96 int disorder_get_global(disorder_client *c, const char *key, char **valuep);
97 int disorder_new_tracks(disorder_client *c,
98 char ***vecp, int *nvecp,
99 int max);
100 int disorder_rtp_address(disorder_client *c, char **addressp, char **portp);
101 int disorder_adduser(disorder_client *c,
102 const char *user, const char *password,
103 const char *rights);
104 int disorder_deluser(disorder_client *c, const char *user);
105 int disorder_userinfo(disorder_client *c, const char *user, const char *key,
106 char **valuep);
107 int disorder_edituser(disorder_client *c, const char *user,
108 const char *key, const char *value);
109 int disorder_users(disorder_client *c,
110 char ***vecp, int *nvecp);
111 int disorder_register(disorder_client *c, const char *user,
112 const char *password, const char *email,
113 char **confirmp);
114 int disorder_confirm(disorder_client *c, const char *confirm);
115 int disorder_make_cookie(disorder_client *c, char **cookiep);
116 const char *disorder_last(disorder_client *c);
117 int disorder_revoke(disorder_client *c);
118 int disorder_reminder(disorder_client *c, const char *user);
119 int disorder_schedule_list(disorder_client *c, char ***idsp, int *nidsp);
120 int disorder_schedule_del(disorder_client *c, const char *id);
121 int disorder_schedule_get(disorder_client *c, const char *id,
122 struct kvp **actiondatap);
123 int disorder_schedule_add(disorder_client *c,
124 time_t when,
125 const char *priority,
126 const char *action,
127 ...);
128
129 #endif /* CLIENT_H */
130
131 /*
132 Local Variables:
133 c-basic-offset:2
134 comment-column:40
135 End:
136 */