]> kaliko git repositories - python-musicpd.git/blob - doc/commands.txt
Update commands documentation
[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 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 stop                                       -> fetch_nothing
31
32 == Playlist Commands
33 add                <str>                   -> fetch_nothing
34 addid              <str> [<int>]           -> fetch_item
35 clear                                      -> fetch_nothing
36 delete             <int>|<range>           -> fetch_nothing
37 deleteid           <int>                   -> fetch_nothing
38 move               <int>|<range> <int>     -> fetch_nothing
39 moveid             <int> <int>             -> fetch_nothing
40 playlist                                   -> fetch_playlist
41 playlistfind       <locate>                -> fetch_songs
42 playlistid         [<int>]                 -> fetch_songs
43 playlistinfo       [<int>|<range>]         -> fetch_songs
44 playlistsearch     <locate>                -> fetch_songs
45 plchanges          <int>                   -> fetch_songs
46 plchangesposid     <int>                   -> fetch_changes
47 prio               <int> <int>|<range>     -> self._fetch_nothing,
48 prioid             <int> <int>             -> self._fetch_nothing,
49 rangeid            <int> <range>           -> self._fetch_nothing,
50 shuffle            [<range>]               -> fetch_nothing
51 swap               <int> <int>             -> fetch_nothing
52 swapid             <int> <int>             -> fetch_nothing
53 addtagid           <int> <str> <str>       -> fetch_nothing
54 cleartagid         <int> [<str>]           -> fetch_nothing
55
56 == Stored Playlist Commands
57 listplaylist       <str>                   -> fetch_list
58 listplaylistinfo   <str>                   -> fetch_songs
59 listplaylists                              -> fetch_playlists
60 load               <str> [<range>]         -> fetch_nothing
61 playlistadd        <str> <str>             -> fetch_nothing
62 playlistclear      <str>                   -> fetch_nothing
63 playlistdelete     <str> <int>             -> fetch_nothing
64 playlistmove       <str> <int> <int>       -> fetch_nothing
65 rename             <str> <str>             -> fetch_nothing
66 rm                 <str>                   -> fetch_nothing
67 save               <str>                   -> fetch_nothing
68
69 == Database Commands
70 count              <str> <str>                              -> fetch_object
71 count              group <str>                              -> fetch_object
72 find               <str> <str> [<str> <str>]...             -> fetch_songs
73 findadd            <str> <str> [<str> <str>]                -> fetch_nothing
74 list               <str> [<str> <str>]...[group <str>]...   -> fetch_list
75 listall            [<str>]                                  -> fetch_database
76 listallinfo        [<str>]                                  -> fetch_database
77 lsinfo             [<str>]                                  -> fetch_database
78 readcomments       <str>                                    -> fetch_object
79 search             <str> <str> [<str> <str>]...             -> fetch_song
80 searchadd          <str> <str> [<str> <str>]...             -> fetch_nothing
81 searchaddpl        <str> <str> <str> [<str> <str>]...       -> fetch_nothing
82 update             [<str>]                                  -> fetch_item
83 rescan             [<str>]                                  -> fetch_item
84
85 == Mounts and neighbors ==
86
87 mount              <str> <str>             -> self._fetch_nothing
88 unmount            <str>                   -> self._fetch_nothing
89 listmounts                                 -> self._fetch_mounts
90 listneighbors                              -> self._fetch_neighbors
91
92 == Sticker Commands
93 sticker   get      <str> <str> <str>       -> fetch_item
94 sticker   set      <str> <str> <str> <str> -> fetch_nothing
95 sticker   delete   <str> <str> [<str>]     -> fetch_nothing
96 sticker   list     <str> <str>             -> fetch_list
97 sticker   find     <str> <str> <str>       -> fetch_songs
98
99 == Connection Commands
100 close                                      -> None
101 kill                                       -> None
102 password           <str>                   -> fetch_nothing
103 ping                                       -> fetch_nothing
104
105 == Audio Output Commands
106 disableoutput      <int>                   -> fetch_nothing
107 enableoutput       <int>                   -> fetch_nothing
108 toggleoutput       <int>                   -> fetch_nothing
109 outputs                                    -> fetch_outputs
110
111 == Reflection Commands
112 commands                                   -> fetch_list
113 notcommands                                -> fetch_list
114 tagtypes                                   -> fetch_list
115 urlhandlers                                -> fetch_list
116 decoders                                   -> fetch_plugins