chiark - git - mdw - disorder/blob - 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 3 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,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU 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, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/client.h
  19  * @brief Simple C client
  20  *
  21  * See @ref lib/eclient.h for an asynchronous-capable client
  22  * implementation.
  23  */
  24
  25 #ifndef CLIENT_H
  26 #define CLIENT_H
  27
  28 #include <time.h>
  29 #include "configuration.h"
  30
  31 /** @brief Client data */
  32 typedef struct disorder_client disorder_client;
  33
  34 struct queue_entry;
  35 struct kvp;
  36 struct sink;
  37
  38 disorder_client *disorder_new(int verbose);
  39 int disorder_connect(disorder_client *c);
  40 int disorder_connect_user(disorder_client *c,
  41                           const char *username,
  42                           const char *password);
  43 int disorder_connect_cookie(disorder_client *c, const char *cookie);
  44 int disorder_connect_generic(struct config *conf,
  45                              disorder_client *c,
  46                              const char *username,
  47                              const char *password,
  48                              const char *cookie);
  49 int disorder_close(disorder_client *c);
  50 int disorder_version(disorder_client *c, char **versionp);
  51 int disorder_play(disorder_client *c, const char *track);
  52 int disorder_remove(disorder_client *c, const char *track);
  53 int disorder_move(disorder_client *c, const char *track, int delta);
  54 int disorder_enable(disorder_client *c);
  55 int disorder_disable(disorder_client *c);
  56 int disorder_scratch(disorder_client *c, const char *id);
  57 int disorder_shutdown(disorder_client *c);
  58 int disorder_reconfigure(disorder_client *c);
  59 int disorder_rescan(disorder_client *c);
  60 int disorder_playing(disorder_client *c, struct queue_entry **qp);
  61 int disorder_recent(disorder_client *c, struct queue_entry **qp);
  62 int disorder_queue(disorder_client *c, struct queue_entry **qp);
  63 int disorder_files(disorder_client *c, const char *dir, const char *re,
  64                    char ***vecp, int *nvecp);
  65 int disorder_allfiles(disorder_client *c, const char *dir, const char *re,
  66                       char ***vecp, int *nvecp);
  67 char *disorder_user(disorder_client *c);
  68 int disorder_exists(disorder_client *c, const char *track, int *existsp);
  69 int disorder_enabled(disorder_client *c, int *enabledp);
  70 int disorder_set(disorder_client *c, const char *track,
  71                  const char *key, const char *value);
  72 int disorder_unset(disorder_client *c, const char *track,
  73                    const char *key);
  74 int disorder_get(disorder_client *c, const char *track, const char *key,
  75                  char **valuep);
  76 int disorder_prefs(disorder_client *c, const char *track,
  77                    struct kvp **kp);
  78 int disorder_length(disorder_client *c, const char *track,
  79                     long *valuep);
  80 int disorder_search(disorder_client *c, const char *terms,
  81                     char ***vecp, int *nvecp);
  82 int disorder_random_enable(disorder_client *c);
  83 int disorder_random_disable(disorder_client *c);
  84 int disorder_random_enabled(disorder_client *c, int *enabledp);
  85 int disorder_stats(disorder_client *c,
  86                    char ***vecp, int *nvecp);
  87 int disorder_set_volume(disorder_client *c, int left, int right);
  88 int disorder_get_volume(disorder_client *c, int *left, int *right);
  89 int disorder_log(disorder_client *c, struct sink *s);
  90 int disorder_pause(disorder_client *c);
  91 int disorder_resume(disorder_client *c);
  92 int disorder_tags(disorder_client *c,
  93                    char ***vecp, int *nvecp);
  94 int disorder_set_global(disorder_client *c,
  95                         const char *key, const char *value);
  96 int disorder_unset_global(disorder_client *c, const char *key);
  97 int disorder_get_global(disorder_client *c, const char *key, char **valuep);
  98 int disorder_new_tracks(disorder_client *c,
  99                         char ***vecp, int *nvecp,
 100                         int max);
 101 int disorder_rtp_address(disorder_client *c, char **addressp, char **portp);
 102 int disorder_adduser(disorder_client *c,
 103                      const char *user, const char *password,
 104                      const char *rights);
 105 int disorder_deluser(disorder_client *c, const char *user);
 106 int disorder_userinfo(disorder_client *c, const char *user, const char *key,
 107                       char **valuep);
 108 int disorder_edituser(disorder_client *c, const char *user,
 109                       const char *key, const char *value);
 110 int disorder_users(disorder_client *c,
 111                    char ***vecp, int *nvecp);
 112 int disorder_register(disorder_client *c, const char *user,
 113                       const char *password, const char *email,
 114                       char **confirmp);
 115 int disorder_confirm(disorder_client *c, const char *confirm);
 116 int disorder_make_cookie(disorder_client *c, char **cookiep);
 117 const char *disorder_last(disorder_client *c);
 118 int disorder_revoke(disorder_client *c);
 119 int disorder_reminder(disorder_client *c, const char *user);
 120 int disorder_schedule_list(disorder_client *c, char ***idsp, int *nidsp);
 121 int disorder_schedule_del(disorder_client *c, const char *id);
 122 int disorder_schedule_get(disorder_client *c, const char *id,
 123                           struct kvp **actiondatap);
 124 int disorder_schedule_add(disorder_client *c,
 125                           time_t when,
 126                           const char *priority,
 127                           const char *action,
 128                           ...);
 129 int disorder_adopt(disorder_client *c, const char *id);
 130 int disorder_playlist_delete(disorder_client *c,
 131                              const char *playlist);
 132 int disorder_playlist_get(disorder_client *c, const char *playlist,
 133                           char ***tracksp, int *ntracksp);
 134 int disorder_playlists(disorder_client *c,
 135                        char ***playlistsp, int *nplaylists);
 136 int disorder_playlist_get_share(disorder_client *c, const char *playlist,
 137                                 char **sharep);
 138 int disorder_playlist_set_share(disorder_client *c, const char *playlist,
 139                                 const char *share);
 140 int disorder_playlist_lock(disorder_client *c, const char *playlist);
 141 int disorder_playlist_unlock(disorder_client *c);
 142 int disorder_playlist_set(disorder_client *c,
 143                           const char *playlist,
 144                           char **tracks,
 145                           int ntracks);
 146
 147 #include "client-stubs.h"
 148
 149 #endif /* CLIENT_H */
 150
 151 /*
 152 Local Variables:
 153 c-basic-offset:2
 154 comment-column:40
 155 End:
 156 */