]> kaliko git repositories - python-musicpd.git/blobdiff - doc/commands.txt
Add a "Library overview" section in doc
[python-musicpd.git] / doc / commands.txt
index 85a85891248ce81a6026ecd4b1916e85f31b98d4..10134a1b361e5d6268b9058d5524aa9852cf985a 100644 (file)
 == Status Commands
-clearerror                         -> getnone
-currentsong                        -> getobject
-idle             <str>             -> getlist
-noidle                             -> None
-status                             -> getobject
-stats                              -> getobject
+clearerror                                 -> fetch_nothing
+currentsong                                -> fetch_object
+idle               [<str>]                 -> fetch_list
+noidle                                     -> None
+status                                     -> fetch_object
+stats                                      -> fetch_object
 
 == Playback Option Commands
-crossfade        <int>             -> getnone
-random           <bool>            -> getnone
-repeat           <bool>            -> getnone
-setvol           <int>             -> getnone
-volume           <int>             -> getnone
+consume            <bool>                  -> fetch_nothing
+crossfade          <int>                   -> fetch_nothing
+mixrampdb          <str>                   -> fetch_nothing
+mixrampdelay       <int>                   -> fetch_nothing
+random             <bool>                  -> fetch_nothing
+repeat             <bool>                  -> fetch_nothing
+setvol             <int>                   -> fetch_nothing
+single             <bool>                  -> fetch_nothing
+replay_gain_mode   <str>                   -> fetch_nothing
+replay_gain_status                         -> fetch_item
+volume             <int>                   -> fetch_nothing
 
 == Playback Control Commands
-next                               -> getnone
-pause            [<bool>]          -> getnone
-play             [<int>]           -> getnone
-playid           [<int>]           -> getnone
-previous                           -> getnone
-seek             <int> <int>       -> getnone
-seekid           <int> <int>       -> getnone
-stop                               -> getnone
+next                                       -> fetch_nothing
+pause              [<bool>]                -> fetch_nothing
+play               [<int>]                 -> fetch_nothing
+playid             [<int>]                 -> fetch_nothing
+previous                                   -> fetch_nothing
+seek               <int> <int>             -> fetch_nothing
+seekid             <int> <int>             -> fetch_nothing
+stop                                       -> fetch_nothing
 
 == Playlist Commands
-add              <str>             -> getnone
-addid            <str> [<int>]     -> getitem
-clear                              -> getnone
-delete           <int>             -> getnone
-deleteid         <int>             -> getnone
-move             <int> <int>       -> getnone
-moveid           <int> <int>       -> getnone
-playlist                           -> getplaylist
-playlistfind     <locate>          -> getsongs
-playlistid       [<int>]           -> getsongs
-playlistinfo     [<int>]           -> getsongs
-playlistsearch   <locate>          -> getsongs
-plchanges        <int>             -> getsongs
-plchangesposid   <int>             -> getchanges
-shuffle                            -> getnone
-swap             <int> <int>       -> getnone
-swapid           <int> <int>       -> getnone
+add                <str>                   -> fetch_nothing
+addid              <str> [<int>]           -> fetch_item
+clear                                      -> fetch_nothing
+delete             <int>|<range>           -> fetch_nothing
+deleteid           <int>                   -> fetch_nothing
+move               <int>|<range> <int>     -> fetch_nothing
+moveid             <int> <int>             -> fetch_nothing
+playlist                                   -> fetch_playlist
+playlistfind       <locate>                -> fetch_songs
+playlistid         [<int>]                 -> fetch_songs
+playlistinfo       [<int>|<range>]         -> fetch_songs
+playlistsearch     <locate>                -> fetch_songs
+plchanges          <int>                   -> fetch_songs
+plchangesposid     <int>                   -> fetch_changes
+prio               <int> <int>|<range>     -> self._fetch_nothing,
+prioid             <int> <int>             -> self._fetch_nothing,
+rangeid            <int> <range>           -> self._fetch_nothing,
+shuffle            [<range>]               -> fetch_nothing
+swap               <int> <int>             -> fetch_nothing
+swapid             <int> <int>             -> fetch_nothing
+addtagid           <int> <str> <str>       -> fetch_nothing
+cleartagid         <int> [<str>]           -> fetch_nothing
 
 == Stored Playlist Commands
-listplaylist     <str>             -> getlist
-listplaylistinfo <str>             -> getsongs
-listplaylists                      -> getplaylists
-load             <str>             -> getnone
-playlistadd      <str> <str>       -> getnone
-playlistclear    <str>             -> getnone
-playlistdelete   <str> <int>       -> getnone
-playlistmove     <str> <int> <int> -> getnone
-rename           <str> <str>       -> getnone
-rm               <str>             -> getnone
-save             <str>             -> getnone
+listplaylist       <str>                   -> fetch_list
+listplaylistinfo   <str>                   -> fetch_songs
+listplaylists                              -> fetch_playlists
+load               <str> [<range>]         -> fetch_nothing
+playlistadd        <str> <str>             -> fetch_nothing
+playlistclear      <str>                   -> fetch_nothing
+playlistdelete     <str> <int>             -> fetch_nothing
+playlistmove       <str> <int> <int>       -> fetch_nothing
+rename             <str> <str>             -> fetch_nothing
+rm                 <str>                   -> fetch_nothing
+save               <str>                   -> fetch_nothing
 
 == Database Commands
-count            <locate>          -> getobject
-find             <locate>          -> getsongs
-list             <str> [<locate>]  -> getlist
-listall          [<str>]           -> getdatabase
-listallinfo      [<str>]           -> getdatabase
-lsinfo           [<str>]           -> getdatabase
-search           <locate>          -> getsongs
-update           [<str>]           -> getitem
+count              <str> <str>                              -> fetch_object
+count              group <str>                              -> fetch_object
+find               <str> <str> [<str> <str>]...             -> fetch_songs
+findadd            <str> <str> [<str> <str>]                -> fetch_nothing
+list               <str> [<str> <str>]...[group <str>]...   -> fetch_list
+listall            [<str>]                                  -> fetch_database
+listallinfo        [<str>]                                  -> fetch_database
+lsinfo             [<str>]                                  -> fetch_database
+readcomments       <str>                                    -> fetch_object
+search             <str> <str> [<str> <str>]...             -> fetch_song
+searchadd          <str> <str> [<str> <str>]...             -> fetch_nothing
+searchaddpl        <str> <str> <str> [<str> <str>]...       -> fetch_nothing
+update             [<str>]                                  -> fetch_item
+rescan             [<str>]                                  -> fetch_item
+
+== Mounts and neighbors ==
+
+mount              <str> <str>     -> self._fetch_nothing
+unmount            <str>           -> self._fetch_nothing
+listmounts                         -> self._fetch_mounts
+listneighbors                      -> self._fetch_neighbors
+
+== Sticker Commands
+sticker   get      <str> <str> <str>       -> fetch_item
+sticker   set      <str> <str> <str> <str> -> fetch_nothing
+sticker   delete   <str> <str> [<str>]     -> fetch_nothing
+sticker   list     <str> <str>             -> fetch_list
+sticker   find     <str> <str> <str>       -> fetch_songs
 
 == Connection Commands
-close                              -> None
-kill                               -> None
-password         <str>             -> getnone
-ping                               -> getnone
+close                       -> None
+kill                        -> None
+password           <str>    -> fetch_nothing
+ping                        -> fetch_nothing
+
+== Partition Commands
+partition          <str>    -> fetch_nothing
+listpartitions              -> fetch_list
+newpartition       <str>    -> fetch_nothing
 
 == Audio Output Commands
-disableoutput    <int>             -> getnone
-enableoutput     <int>             -> getnone
-outputs                            -> getoutputs
+disableoutput      <int>    -> fetch_nothing
+enableoutput       <int>    -> fetch_nothing
+toggleoutput       <int>    -> fetch_nothing
+outputs                     -> fetch_outputs
 
 == Reflection Commands
-commands                           -> getlist
-notcommands                        -> getlist
-tagtypes                           -> getlist
-urlhandlers                        -> getlist
+config           -> fetch_object
+commands         -> fetch_list
+notcommands      -> fetch_list
+tagtypes         -> fetch_list
+urlhandlers      -> fetch_list
+decoders         -> fetch_plugins