mpd.md

   1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
   2
   3 Shows MPD status in a textbox.
   4
   5         mpdwidget = lain.widgets.mpd()
   6
   7 Now playing songs are notified like this:
   8
   9         +--------------------------------------------------------+
  10         | +-------+                                              |
  11         | |/^\_/^\| Now playing                                  |
  12     | |\ O O /| Cannibal Corpse (Hammer Smashed Face) - 1993 |
  13     | | '.o.' | Hammer Smashed Face (Radio Disney Version)   |
  14         | +-------+                                              |
  15         +--------------------------------------------------------+
  16
  17 ### input table
  18
  19 Variable | Meaning | Type | Default
  20 --- | --- | --- | ---
  21 `timeout` | Refresh timeout seconds | int | 1
  22 `password` | MPD password | string | ""
  23 `host` | MPD server | string | "127.0.0.1"
  24 `port` | MPD port | string | "6600"
  25 `music_dir` | Music directory | string | "~/Music"
  26 `settings` | User settings | function | empty function
  27
  28 `settings` can use `mpd_now` table, which contains the following string values:
  29
  30 - state (possible values: "play", "pause", "stop")
  31 - file
  32 - artist
  33 - title
  34 - album
  35 - date
  36
  37 and can modify `notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition:
  38
  39     notification _preset = {
  40        title   = "Now playing",
  41        timeout = 6,
  42        text    = string.format("%s (%s) - %s\n%s", mpd_now.artist,
  43                  mpd_now.album, mpd_now.date, mpd_now.title)
  44     }
  45
  46 ### output table
  47
  48 Variable | Meaning | Type
  49 --- | --- | ---
  50 `widget` | The textbox | `wibox.widget.textbox`
  51 `notify` | The notification | function
  52
  53 You can control the widget with key bindings like these:
  54
  55     -- MPD control
  56     awful.key({ altkey, "Control" }, "Up",
  57         function ()
  58             awful.util.spawn_with_shell("mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle")
  59             mpdwidget.notify()
  60         end),
  61     awful.key({ altkey, "Control" }, "Down",
  62         function ()
  63             awful.util.spawn_with_shell("mpc stop || ncmpcpp stop || ncmpc stop || pms stop")
  64             mpdwidget.notify()
  65         end),
  66     awful.key({ altkey, "Control" }, "Left",
  67         function ()
  68             awful.util.spawn_with_shell("mpc prev || ncmpcpp prev || ncmpc prev || pms prev")
  69             mpdwidget.notify()
  70         end),
  71     awful.key({ altkey, "Control" }, "Right",
  72         function ()
  73             awful.util.spawn_with_shell("mpc next || ncmpcpp next || ncmpc next || pms next")
  74             mpdwidget.notify()
  75         end),
  76
  77 where `altkey = "Mod1"`.