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