addding doc/commands.txt to document supported commands
authorJ. Alexander Treuman <jat@spatialrift.net>
Wed, 27 Feb 2008 21:24:45 +0000 (16:24 -0500)
committerJ. Alexander Treuman <jat@spatialrift.net>
Wed, 27 Feb 2008 21:24:45 +0000 (16:24 -0500)
doc/commands.txt [new file with mode: 0644]

diff --git a/doc/commands.txt b/doc/commands.txt
new file mode 100644 (file)
index 0000000..fcf48bb
--- /dev/null
@@ -0,0 +1,69 @@
+== Admin Commands
+disableoutput    <int>             -> getnone
+enableoutput     <int>             -> getnone
+kill                               -> None
+update           [<str>]           -> getitem
+== Informational Commands
+status                             -> getobject
+stats                              -> getobject
+outputs                            -> getoutputs
+commands                           -> getlist
+notcommands                        -> getlist
+tagtypes                           -> getlist
+urlhandlers                        -> getlist
+== Database Commands
+find             <locate>          -> getsongs
+list             <str> [<locate>]  -> getlist
+listall          [<str>]           -> getdatabase
+listallinfo      [<str>]           -> getdatabase
+lsinfo           [<str>]           -> getdatabase
+search           <locate>          -> getsongs
+count            <locate>          -> getobject
+== Playlist Commands
+add              <str>             -> getnone
+addid            <str> [<int>]     -> getitem
+clear                              -> getnone
+currentsong                        -> getobject
+delete           <int>             -> getnone
+deleteid         <int>             -> getnone
+load             <str>             -> getnone
+rename           <str> <str>       -> getnone
+move             <int> <int>       -> getnone
+moveid           <int> <int>       -> getnone
+playlist                           -> getplaylist
+playlistinfo     [<int>]           -> getsongs
+playlistid       [<int>]           -> getsongs
+plchanges        <int>             -> getsongs
+plchangesposid   <int>             -> getchanges
+rm               <str>             -> getnone
+save             <str>             -> getnone
+shuffle                            -> getnone
+swap             <int> <int>       -> getnone
+swapid           <int> <int>       -> getnone
+listplaylist     <str>             -> getlist
+listplaylistinfo <str>             -> getsongs
+playlistadd      <str> <str>       -> getnone
+playlistclear    <str>             -> getnone
+playlistdelete   <str> <int>       -> getnone
+playlistmove     <str> <int> <int> -> getnone
+playlistfind     <locate>          -> getsongs
+playlistsearch   <locate>          -> getsongs
+== Playback Commands
+crossfade        <int>             -> getnone
+next                               -> getnone
+pause            [<bool>]          -> getnone
+play             [<int>]           -> getnone
+playid           [<int>]           -> getnone
+previous                           -> getnone
+random           <bool>            -> getnone
+repeat           <bool>            -> getnone
+seek             <int> <int>       -> getnone
+seekid           <int> <int>       -> getnone
+setvol           <int>             -> getnone
+stop                               -> getnone
+volume           <int>             -> getnone
+== Miscellaneous Commands
+clearerror                         -> getnone
+close                              -> None
+password         <str>             -> getnone
+ping                               -> getnone