]> kaliko git repositories - python-musicpd.git/blob - doc/source/commands.txt
Add getvol command (closes #9)
[python-musicpd.git] / doc / source / 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 mixrampdb          <str>                   -> fetch_nothing
13 mixrampdelay       <int>                   -> fetch_nothing
14 random             <bool>                  -> fetch_nothing
15 repeat             <bool>                  -> fetch_nothing
16 setvol             <int>                   -> fetch_nothing
17 getvol                                     -> fetch_object
18 single             <bool>                  -> fetch_nothing
19 replay_gain_mode   <str>                   -> fetch_nothing
20 replay_gain_status                         -> fetch_item
21 volume             <int>                   -> fetch_nothing
22
23 == Playback Control Commands
24 next                                       -> fetch_nothing
25 pause              [<bool>]                -> fetch_nothing
26 play               [<int>]                 -> fetch_nothing
27 playid             [<int>]                 -> fetch_nothing
28 previous                                   -> fetch_nothing
29 seek               <int> <int>             -> fetch_nothing
30 seekid             <int> <int>             -> fetch_nothing
31 seekcur            <int>                   -> fetch_nothing
32 stop                                       -> fetch_nothing
33
34 == Queue Commands
35 add                <str>                   -> fetch_nothing
36 addid              <str> [<int>]           -> fetch_item
37 clear                                      -> fetch_nothing
38 delete             <int>|<range>           -> fetch_nothing
39 deleteid           <int>                   -> fetch_nothing
40 move               <int>|<range> <int>     -> fetch_nothing
41 moveid             <int> <int>             -> fetch_nothing
42 playlist                                   -> fetch_playlist
43 playlistfind       <locate>                -> fetch_songs
44 playlistid         [<int>]                 -> fetch_songs
45 playlistinfo       [<int>|<range>]         -> fetch_songs
46 playlistsearch     <locate>                -> fetch_songs
47 plchanges          <int>                   -> fetch_songs
48 plchangesposid     <int>                   -> fetch_changes
49 prio               <int> <int>|<range>     -> fetch_nothing,
50 prioid             <int> <int>             -> fetch_nothing,
51 rangeid            <int> <range>           -> fetch_nothing,
52 shuffle            [<range>]               -> fetch_nothing
53 swap               <int> <int>             -> fetch_nothing
54 swapid             <int> <int>             -> fetch_nothing
55 addtagid           <int> <str> <str>       -> fetch_nothing
56 cleartagid         <int> [<str>]           -> fetch_nothing
57
58 == Stored Playlist Commands
59 listplaylist       <str>                   -> fetch_list
60 listplaylistinfo   <str>                   -> fetch_songs
61 listplaylists                              -> fetch_playlists
62 load               <str> [<range>]         -> fetch_nothing
63 playlistadd        <str> <str>             -> fetch_nothing
64 playlistclear      <str>                   -> fetch_nothing
65 playlistdelete     <str> <int>             -> fetch_nothing
66 playlistmove       <str> <int> <int>       -> fetch_nothing
67 rename             <str> <str>             -> fetch_nothing
68 rm                 <str>                   -> fetch_nothing
69 save               <str>                   -> fetch_nothing
70
71 == Database Commands
72 albumart           <str> <int>                              -> fetch_composite
73 count              <str> <str>                              -> fetch_object
74 count              group <str>                              -> fetch_object
75 getfingerprint     <str>                                    -> fetch_object
76 find               <str> <str> [<str> <str>]...             -> fetch_songs
77 findadd            <str> <str> [<str> <str>]                -> fetch_nothing
78 list               <str> [<str> <str>]...[group <str>]...   -> fetch_list
79 listall            [<str>]                                  -> fetch_database
80 listallinfo        [<str>]                                  -> fetch_database
81 listfiles          <str>                                    -> fetch_database
82 lsinfo             [<str>]                                  -> fetch_database
83 readcomments       [<str>]                                  -> fetch_object
84 readpicture        <str> <int>                              -> fetch_composite
85 search             <str> <str> [<str> <str>]...             -> fetch_song
86 searchadd          <str> <str> [<str> <str>]...             -> fetch_nothing
87 searchaddpl        <str> <str> <str> [<str> <str>]...       -> fetch_nothing
88 update             [<str>]                                  -> fetch_item
89 rescan             [<str>]                                  -> fetch_item
90
91 == Mounts and neighbors ==
92 mount              <str> <str>     -> fetch_nothing
93 unmount            <str>           -> fetch_nothing
94 listmounts                         -> fetch_mounts
95 listneighbors                      -> fetch_neighbors
96
97 == Sticker Commands
98 sticker   get      <str> <str> <str>       -> fetch_item
99 sticker   set      <str> <str> <str> <str> -> fetch_nothing
100 sticker   delete   <str> <str> [<str>]     -> fetch_nothing
101 sticker   list     <str> <str>             -> fetch_list
102 sticker   find     <str> <str> <str>       -> fetch_songs
103
104 == Connection Commands
105 close                               -> None
106 kill                                -> None
107 password           <str>            -> fetch_nothing
108 ping                                -> fetch_nothing
109 binarylimit        <str>            -> fetch_nothing
110 tagtypes                            -> fetch_list
111 tagtypes disable <str> [<str>]...   -> fetch_nothing
112 tagtypes enable <str> [<str>]...    -> fetch_nothing
113 tagtypes clear                      -> fetch_nothing
114 tagtypes all                        -> fetch_nothing
115
116 == Partition Commands
117 partition          <str>    -> fetch_nothing
118 listpartitions              -> fetch_list
119 newpartition       <str>    -> fetch_nothing
120 delpartition       <str>    -> fetch_nothing
121 moveoutput         <str>    -> fetch_nothing
122
123 == Audio Output Commands
124 disableoutput      <int>       -> fetch_nothing
125 enableoutput       <int>       -> fetch_nothing
126 toggleoutput       <int>       -> fetch_nothing
127 outputs                        -> fetch_outputs
128 outputset  <str> <str> <str>   -> fetch_nothing
129
130 == Reflection Commands
131 config           -> fetch_object
132 commands         -> fetch_list
133 notcommands      -> fetch_list
134 urlhandlers      -> fetch_list
135 decoders         -> fetch_plugins