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 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 #include <time.h>
  31 #include "configuration.h"
  32
  33 /** @brief Client data */
  34 typedef struct disorder_client disorder_client;
  35
  36 struct queue_entry;
  37 struct kvp;
  38 struct sink;
  39
  40 disorder_client *disorder_new(int verbose);
  41 int disorder_connect(disorder_client *c);
  42 int disorder_connect_user(disorder_client *c,
  43                           const char *username,
  44                           const char *password);
  45 int disorder_connect_cookie(disorder_client *c, const char *cookie);
  46 int disorder_connect_generic(struct config *conf,
  47                              disorder_client *c,
  48                              const char *username,
  49                              const char *password,
  50                              const char *cookie);
  51 int disorder_close(disorder_client *c);
  52 int disorder_version(disorder_client *c, char **versionp);
  53 int disorder_play(disorder_client *c, const char *track);
  54 int disorder_remove(disorder_client *c, const char *track);
  55 int disorder_move(disorder_client *c, const char *track, int delta);
  56 int disorder_enable(disorder_client *c);
  57 int disorder_disable(disorder_client *c);
  58 int disorder_scratch(disorder_client *c, const char *id);
  59 int disorder_shutdown(disorder_client *c);
  60 int disorder_reconfigure(disorder_client *c);
  61 int disorder_rescan(disorder_client *c);
  62 int disorder_playing(disorder_client *c, struct queue_entry **qp);
  63 int disorder_recent(disorder_client *c, struct queue_entry **qp);
  64 int disorder_queue(disorder_client *c, struct queue_entry **qp);
  65 int disorder_directories(disorder_client *c, const char *dir, const char *re,
  66                          char ***vecp, int *nvecp);
  67 int disorder_files(disorder_client *c, const char *dir, const char *re,
  68                    char ***vecp, int *nvecp);
  69 int disorder_allfiles(disorder_client *c, const char *dir, const char *re,
  70                       char ***vecp, int *nvecp);
  71 char *disorder_user(disorder_client *c);
  72 int disorder_exists(disorder_client *c, const char *track, int *existsp);
  73 int disorder_enabled(disorder_client *c, int *enabledp);
  74 int disorder_set(disorder_client *c, const char *track,
  75                  const char *key, const char *value);
  76 int disorder_unset(disorder_client *c, const char *track,
  77                    const char *key);
  78 int disorder_get(disorder_client *c, const char *track, const char *key,
  79                  char **valuep);
  80 int disorder_prefs(disorder_client *c, const char *track,
  81                    struct kvp **kp);
  82 int disorder_length(disorder_client *c, const char *track,
  83                     long *valuep);
  84 int disorder_search(disorder_client *c, const char *terms,
  85                     char ***vecp, int *nvecp);
  86 int disorder_random_enable(disorder_client *c);
  87 int disorder_random_disable(disorder_client *c);
  88 int disorder_random_enabled(disorder_client *c, int *enabledp);
  89 int disorder_stats(disorder_client *c,
  90                    char ***vecp, int *nvecp);
  91 int disorder_set_volume(disorder_client *c, int left, int right);
  92 int disorder_get_volume(disorder_client *c, int *left, int *right);
  93 int disorder_log(disorder_client *c, struct sink *s);
  94 int disorder_part(disorder_client *c, char **partp,
  95                   const char *track, const char *context, const char *part);
  96 int disorder_resolve(disorder_client *c, char **trackp, const char *track);
  97 int disorder_pause(disorder_client *c);
  98 int disorder_resume(disorder_client *c);
  99 int disorder_tags(disorder_client *c,
 100                    char ***vecp, int *nvecp);
 101 int disorder_set_global(disorder_client *c,
 102                         const char *key, const char *value);
 103 int disorder_unset_global(disorder_client *c, const char *key);
 104 int disorder_get_global(disorder_client *c, const char *key, char **valuep);
 105 int disorder_new_tracks(disorder_client *c,
 106                         char ***vecp, int *nvecp,
 107                         int max);
 108 int disorder_rtp_address(disorder_client *c, char **addressp, char **portp);
 109 int disorder_adduser(disorder_client *c,
 110                      const char *user, const char *password,
 111                      const char *rights);
 112 int disorder_deluser(disorder_client *c, const char *user);
 113 int disorder_userinfo(disorder_client *c, const char *user, const char *key,
 114                       char **valuep);
 115 int disorder_edituser(disorder_client *c, const char *user,
 116                       const char *key, const char *value);
 117 int disorder_users(disorder_client *c,
 118                    char ***vecp, int *nvecp);
 119 int disorder_register(disorder_client *c, const char *user,
 120                       const char *password, const char *email,
 121                       char **confirmp);
 122 int disorder_confirm(disorder_client *c, const char *confirm);
 123 int disorder_make_cookie(disorder_client *c, char **cookiep);
 124 const char *disorder_last(disorder_client *c);
 125 int disorder_revoke(disorder_client *c);
 126 int disorder_reminder(disorder_client *c, const char *user);
 127 int disorder_schedule_list(disorder_client *c, char ***idsp, int *nidsp);
 128 int disorder_schedule_del(disorder_client *c, const char *id);
 129 int disorder_schedule_get(disorder_client *c, const char *id,
 130                           struct kvp **actiondatap);
 131 int disorder_schedule_add(disorder_client *c,
 132                           time_t when,
 133                           const char *priority,
 134                           const char *action,
 135                           ...);
 136
 137 #endif /* CLIENT_H */
 138
 139 /*
 140 Local Variables:
 141 c-basic-offset:2
 142 comment-column:40
 143 End:
 144 */