src/libmpd-player.h

   1 /*
   2  * Copyright (C) 2004-2005 Qball Cow <Qball@qballcow.nl>
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public
  15  * License along with this program; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20
  21 /**
  22  * @defgroup Player Player
  23  * These functions allow the client to control the player part of mpd.
  24  * To use the read functions you need "read" permission on mpd.
  25  * To use the control functions you need "control" and "read" permission on mpd.
  26  */
  27 /* @{*/
  28 #ifndef __MPD_LIB_PLAYER__
  29 #define __MPD_LIB_PLAYER__
  30
  31 /**
  32  * Enum representing the possible states of the player
  33  */
  34
  35 typedef enum {
  36         /** The player is paused */
  37         MPD_PLAYER_PAUSE = MPD_STATUS_STATE_PAUSE,
  38         /** The player is playing */
  39         MPD_PLAYER_PLAY =  MPD_STATUS_STATE_PLAY,
  40         /** The player is stopped */
  41         MPD_PLAYER_STOP =  MPD_STATUS_STATE_STOP,
  42         /** The player is in an unknown state */
  43         MPD_PLAYER_UNKNOWN = MPD_STATUS_STATE_UNKNOWN
  44 } MpdState;
  45
  46 /**
  47  * \param mi a #MpdObj
  48  *
  49  * Sends mpd the play command.
  50  *
  51  * This equals:
  52  * @code
  53  * mpd_player_play_id(mi, -1);
  54  * @endcode
  55  *
  56  * @returns a #MpdError
  57  */
  58 int mpd_player_play(MpdObj * mi);
  59
  60
  61 /**
  62  *
  63  * \param mi a #MpdObj
  64  * \param id a songid.
  65  *
  66  * Plays the song with id
  67  *
  68  * @returns a #MpdError
  69  */
  70 int mpd_player_play_id(MpdObj * mi, int id);
  71
  72
  73 /**
  74  * \param mi a #MpdObj
  75  *
  76  * Sends mpd the stop command.
  77  *
  78  * @returns a #MpdError
  79  */
  80 int mpd_player_stop(MpdObj * mi);
  81
  82
  83 /**
  84  * \param mi a #MpdObj
  85  *
  86  * Sends mpd the next command.
  87  *
  88  * @returns a #MpdError
  89  */
  90 int mpd_player_next(MpdObj * mi);
  91
  92
  93 /**
  94  * \param mi a #MpdObj
  95  *
  96  * Sends mpd the prev command.
  97  *
  98  * @returns a #MpdError
  99  */
 100 int mpd_player_prev(MpdObj * mi);
 101
 102
 103 /**
 104  * \param mi a #MpdObj
 105  *
 106  * Sends mpd the pause command.
 107  *
 108  * @returns a #MpdError
 109  */
 110 int mpd_player_pause(MpdObj * mi);
 111
 112
 113 /**
 114  * \param mi a #MpdObj
 115  *
 116  * Returns the mpd play state (play/paused/stop)
 117  *
 118  * @returns a #MpdState
 119  */
 120 int mpd_player_get_state(MpdObj * mi);
 121
 122 /**
 123  * \param mi a #MpdObj
 124  *
 125  * Returns the id of the currently playing song
 126  *
 127  * @returns the songid of the playing song
 128  */
 129 int mpd_player_get_current_song_id(MpdObj * mi);
 130
 131
 132 /**
 133  * \param mi a #MpdObj
 134  *
 135  * Returns the position of the currently playing song in the playlist
 136  *
 137  * @returns the position of the playing song
 138  */
 139 int mpd_player_get_current_song_pos(MpdObj * mi);
 140
 141
 142 /**
 143  * \param mi a #MpdObj
 144  *
 145  * Get the state of repeat: 1 if enabled, 0 when disabled.
 146  *
 147  * @returns the state of repeat
 148  */
 149 int mpd_player_get_repeat(MpdObj * mi);
 150
 151
 152 /**
 153  * \param mi a #MpdObj
 154  * \param repeat New state of repeat (1 is enabled, 0 is disabled)
 155  *
 156  * Enable/disabled repeat
 157  *
 158  * @returns 0 when succesfull
 159  */
 160 int mpd_player_set_repeat(MpdObj * mi, int repeat);
 161 /**
 162  * \param mi a #MpdObj
 163  *
 164  * Get the state of random: 1 if enabled, 0 when disabled.
 165  *
 166  * @returns the state of random
 167  */
 168
 169 int mpd_player_get_random(MpdObj * mi);
 170 /**
 171  * @param mi a #MpdObj
 172  * @param random New state of random (1 is enabled, 0 is disabled)
 173  *
 174  * Enable/disabled random
 175  *
 176  * @returns 0 when succesfull
 177  */
 178 int mpd_player_set_random(MpdObj * mi, int random);
 179
 180
 181 /**
 182  * @param mi a #MpdObj
 183  * @param sec Position to seek to. (in seconds)
 184  *
 185  * Seek through the current song.
 186  * @returns a #MpdError
 187  */
 188 int mpd_player_seek(MpdObj * mi, int sec);
 189
 190 #endif
 191
 192 /*@}*/