]> kaliko git repositories - python-musicpd.git/blob - doc/commands.txt
doc/commands.txt: updating to match the new internal API
[python-musicpd.git] / doc / commands.txt
1 == Status Commands
2 clearerror                         -> fetch_nothing
3 currentsong                        -> fetch_object
4 idle             <str>             -> fetch_list
5 noidle                             -> None
6 status                             -> fetch_object
7 stats                              -> fetch_object
8
9 == Playback Option Commands
10 consume          <bool>            -> fetch_nothing
11 crossfade        <int>             -> fetch_nothing
12 random           <bool>            -> fetch_nothing
13 repeat           <bool>            -> fetch_nothing
14 setvol           <int>             -> fetch_nothing
15 single           <bool>            -> fetch_nothing
16 volume           <int>             -> fetch_nothing
17
18 == Playback Control Commands
19 next                               -> fetch_nothing
20 pause            [<bool>]          -> fetch_nothing
21 play             [<int>]           -> fetch_nothing
22 playid           [<int>]           -> fetch_nothing
23 previous                           -> fetch_nothing
24 seek             <int> <int>       -> fetch_nothing
25 seekid           <int> <int>       -> fetch_nothing
26 stop                               -> fetch_nothing
27
28 == Playlist Commands
29 add              <str>             -> fetch_nothing
30 addid            <str> [<int>]     -> fetch_item
31 clear                              -> fetch_nothing
32 delete           <int>             -> fetch_nothing
33 deleteid         <int>             -> fetch_nothing
34 move             <int> <int>       -> fetch_nothing
35 moveid           <int> <int>       -> fetch_nothing
36 playlist                           -> fetch_playlist
37 playlistfind     <locate>          -> fetch_songs
38 playlistid       [<int>]           -> fetch_songs
39 playlistinfo     [<int>]           -> fetch_songs
40 playlistsearch   <locate>          -> fetch_songs
41 plchanges        <int>             -> fetch_songs
42 plchangesposid   <int>             -> fetch_changes
43 shuffle                            -> fetch_nothing
44 swap             <int> <int>       -> fetch_nothing
45 swapid           <int> <int>       -> fetch_nothing
46
47 == Stored Playlist Commands
48 listplaylist     <str>             -> fetch_list
49 listplaylistinfo <str>             -> fetch_songs
50 listplaylists                      -> fetch_playlists
51 load             <str>             -> fetch_nothing
52 playlistadd      <str> <str>       -> fetch_nothing
53 playlistclear    <str>             -> fetch_nothing
54 playlistdelete   <str> <int>       -> fetch_nothing
55 playlistmove     <str> <int> <int> -> fetch_nothing
56 rename           <str> <str>       -> fetch_nothing
57 rm               <str>             -> fetch_nothing
58 save             <str>             -> fetch_nothing
59
60 == Database Commands
61 count            <locate>          -> fetch_object
62 find             <locate>          -> fetch_songs
63 list             <str> [<locate>]  -> fetch_list
64 listall          [<str>]           -> fetch_database
65 listallinfo      [<str>]           -> fetch_database
66 lsinfo           [<str>]           -> fetch_database
67 search           <locate>          -> fetch_songs
68 update           [<str>]           -> fetch_item
69
70 == Connection Commands
71 close                              -> None
72 kill                               -> None
73 password         <str>             -> fetch_nothing
74 ping                               -> fetch_nothing
75
76 == Audio Output Commands
77 disableoutput    <int>             -> fetch_nothing
78 enableoutput     <int>             -> fetch_nothing
79 outputs                            -> fetch_outputs
80
81 == Reflection Commands
82 commands                           -> fetch_list
83 notcommands                        -> fetch_list
84 tagtypes                           -> fetch_list
85 urlhandlers                        -> fetch_list