.. _plugin:mpd:

===
MPD
===
| 

about
-----
| 

:author:  FeedBackLoop <feedbackloop@gmail.com>
:contact: FREENODE/#fbf
:distribution: core
:license:  

| 

description
-----------
| 

 music player daemon control. 



| 

commands
--------
| 


    :commands in this plugin: mpd-consume .. mpd .. mpd-play .. mpd-volume .. mpd-cfgdefined .. mpd-crop .. mpd-enable .. mpd-cfg .. mpd-rm .. mpd-find .. mpd-current .. mpd-clear .. mpd-add .. mpd-toggle .. mpd-stats .. mpd-repeat .. mpd-playlist .. mpd-outputs .. mpd-pause .. mpd-disable .. mpd-random .. mpd-lsplaylists .. mpd-del .. mpd-watch-start .. mpd-jump .. mpd-np .. mpd-shuffle .. mpd-stop .. mpd-next .. mpd-crossfade .. mpd-load .. mpd-watch-stop .. mpd-queue .. mpd-prev .. mpd-watch-list .. mpd-cfgsave .. mpd-single .. mpd-save

| 

1) *mpd .. [handle_mpd]*

    :description:  no arguments - display mpd status. 

    :permissions: USER

    :code: :ref:`fbf.plugs.extra.mpd_mpd_command`.

    :examples:

    ::

        <user> ;mpd
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1


2) *mpd-add .. [handle_mpd_add]*

    :description:  arguments: <filename> - add a file to the MPD. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-add_command`.

    :examples:

    ::

        <user> ;mpd-add mp3/bigbeat/fatboy slim/fatboy slim - everybody needs a 303.mp3
        <output> failed to load song "mp3/bigbeat/fatboy slim/fatboy slim - everybody needs a 303.mp3"


3) *mpd-cfg .. [cfg]*

    :description:  the config (cfg) command. 

    :permissions: OPER

    :code: :ref:`fbf.lib.persistconfig_PersistConfig_class`.

    :examples:

    ::

        <user> ;mpd-cfg
        <output> options: cfile="docs/docrun/config/plugs/fbf.plugs.extra.mpd" .. datadir="docs/docrun/" .. dir="docs/docrun/config" .. filename="plugs/fbf.plugs.extra.mpd" .. hide=[] .. issaved=True .. jsondb=None .. logname="config/plugs/fbf.plugs.extra.mpd" .. modname="fbf.plugs.extra.mpd" .. origdir="docs/docrun" .. origname="plugs/fbf.plugs.extra.mpd" .. plugname="mpd" .. port="" .. server-host="127.0.0.1" - 1 more


4) *mpd-cfgdefined .. [cfgdefined]*

    :description:  show defined attributes. 

    :permissions: OPER

    :code: :ref:`fbf.lib.persistconfig_PersistConfig_class`.

    :examples:

    ::

        <user> ;mpd-cfgdefined
        <output> cfg has the following options defined: cfile, datadir, dir, filename, hide, issaved, jsondb, logname, modname, origdir, origname, plugname, port, server-host, server-pass, server-port, socket-timeout, song-status, uuid, watcher-enabled, watcher-interval


5) *mpd-cfgsave .. [cfgsave]*

    :description:  save config. 

    :permissions: OPER

    :code: :ref:`fbf.lib.persistconfig_PersistConfig_class`.

    :examples:

    ::

        <user> ;mpd-cfgsave
        <output> config saved


6) *mpd-clear .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-clear_command`.

    :examples:

    ::

        <user> ;mpd-clear
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1
        <output> done - mpd-clear


7) *mpd-consume .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-consume_command`.

    :examples:

    ::

        <user> ;mpd-consume <on|off>
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1


8) *mpd-crop .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-crop_command`.

    :examples:

    ::

        <user> ;mpd-crop
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1
        <output> done - mpd-crop


9) *mpd-crossfade .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-crossfade_command`.

    :examples:

    ::

        <user> ;mpd-crossfade 42
        <output> crossfade option set to 42


10) *mpd-current .. [handle_mpd_np]*

    :description:  no arguments - show current playing song. 

    :permissions: USER

    :code: :ref:`fbf.plugs.extra.mpd_mpd-current_command`.

    :examples:

    ::

        <user> ;mpd-current
        <output> now playing: ? - ? on "?" (duration: unknown)


11) *mpd-del .. [handle_mpd_del]*

    :description:  arguments: <position> - remove a song from the current playlist. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-del_command`.

    :examples:

    ::

        <user> ;mpd-del 1
        <output> no result returned


12) *mpd-disable .. [handle_mpd_disable]*

    :description:  arguments: <outputnumber> - disable an output. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-disable_command`.

    :examples:

    ::

        <user> ;mpd-disable <output #>
        <output> mpd-disable <output #>


13) *mpd-enable .. [handle_mpd_enable]*

    :description:  arguments: <outputnumber> - enable an output. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-enable_command`.

    :examples:

    ::

        <user> ;mpd-enable <output #>
        <output> mpd-enable <output #>


14) *mpd-find .. [handle_mpd_find]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-find_command`.

    :examples:

    ::

        <user> ;mpd-find title love
        <output> no result


15) *mpd-jump .. [handle_mpd_jump]*

    :description:  arguments: <id> - jump to playlist. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-jump_command`.

    :examples:

    ::

        <user> ;mpd-jump 777
        <output> now playing: ? - ? on "?" (duration: unknown)


16) *mpd-load .. [handle_mpd_load]*

    :description:  arguments: <playlist> - load playlist. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-load_command`.

    :examples:

    ::

        <user> ;mpd-load <file>
        <output> Playlist <file> loaded.


17) *mpd-lsplaylists .. [handle_mpd_lsplaylists]*

    :description:  no arguments - show playlists. 

    :permissions: USER

    :code: :ref:`fbf.plugs.extra.mpd_mpd-lsplaylists_command`.

    :examples:

    ::

        <user> ;mpd-lsplaylists
18) *mpd-next .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-next_command`.

    :examples:

    ::

        <user> ;mpd-next
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1
        <output> done - mpd-next


19) *mpd-np .. [handle_mpd_np]*

    :description:  no arguments - show current playing song. 
20) *mpd-outputs .. [handle_mpd_outputs]*

    :description:  show mpd outputs. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-outputs_command`.

    :examples:

    ::

        <user> ;mpd-outputs
        <output> Output 1 (My ALSA Device) is enabled


21) *mpd-pause .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-pause_command`.

    :examples:

    ::

        <user> ;mpd-pause
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1
        <output> done - mpd-pause


22) *mpd-play .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-play_command`.

    :examples:

    ::

        <user> ;mpd-play
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1
        <output> done - mpd-play


23) *mpd-playlist .. [handle_mpd_playlist]*

    :description:  no arguments - show playlist. 

    :permissions: USER

    :code: :ref:`fbf.plugs.extra.mpd_mpd-playlist_command`.

    :examples:

    ::

        <user> ;mpd-playlist
        <output> no playlist


24) *mpd-prev .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-prev_command`.

    :examples:

    ::

        <user> ;mpd-prev
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1
        <output> done - mpd-prev


25) *mpd-queue .. [handle_mpd_add]*

    :description:  arguments: <filename> - add a file to the MPD. 
26) *mpd-random .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-random_command`.

    :examples:

    ::

        <user> ;mpd-random <on|off>
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1


27) *mpd-repeat .. [<lambda>]*

    :description: []
28) *mpd-rm .. [handle_mpd_rm]*

    :description:  arguments: <playlist> - remove playlist. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-rm_command`.

    :examples:

    ::

        <user> ;mpd-rm <file>
        <output> Playlist <file> loaded.


29) *mpd-save .. [handle_mpd_save]*

    :description:  arguments: <playlist> - save playlist. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-save_command`.

    :examples:

    ::

        <user> ;mpd-save <file>
        <output> Playlist <file> loaded.


30) *mpd-shuffle .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-shuffle_command`.

    :examples:

    ::

        <user> ;mpd-shuffle
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1
        <output> done - mpd-shuffle


31) *mpd-single .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-single_command`.

    :examples:

    ::

        <user> ;mpd-single <on|off>
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1


32) *mpd-stats .. [handle_mpd_stats]*

    :description:  no arguments - determine MPD stats. 

    :permissions: USER

    :code: :ref:`fbf.plugs.extra.mpd_mpd-stats_command`.

    :examples:

    ::

        <user> ;mpd-stats
        <output> albums: 0 | artists: 0 | songs: 0 | total database playtime: 00s | total playtime: 00s | uptime: 06d01h49m07s


33) *mpd-stop .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-stop_command`.

    :examples:

    ::

        <user> ;mpd-stop
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1
        <output> done - mpd-stop


34) *mpd-toggle .. [<lambda>]*

    :description: []

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-toggle_command`.

    :examples:

    ::

        <user> ;mpd-toggle
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1
        <output> done - mpd-toggle


35) *mpd-volume .. [handle_mpd_volume]*

    :description:  arguments: <volume> - set MPD volume. 

    :permissions: MPD

    :code: :ref:`fbf.plugs.extra.mpd_mpd-volume_command`.

    :examples:

    ::

        <user> ;mpd-repeat off
        <output> volume: -1 | repeat: 0 | random: 1 | single: 1 | consume: 1


36) *mpd-watch-list .. [handle_mpd_watch_list]*

    :description:  no aruguments - list the watchers channels. 
37) *mpd-watch-start .. [handle_mpd_watch_start]*

    :description:  no arguments - start MPD watcher. 
38) *mpd-watch-stop .. [handle_mpd_watch_stop]*

    :description:  no arguments - stop MPD watcher.