LUASTATUS-PLUGIN-MPD(7)

luastatus-plugin-mpd(7) 💅✨

Okay bestie, this is the Miscellaneous Information Manual moment for luastatus-plugin-mpd(7) — group-chat explainer edition 🫶.

🌸 NAME 🌸

luastatus-plugin-mpd — mpd plugin for luastatus.

✨ OVERVIEW ✨

This plugin monitors the state of an mpd server. That's the whole vibe: it keeps an eye on it 👀.

🎀 OPTIONS 🎀

• hostname — string. Hostname to connect to. Default is to connect to the local host. An absolute path to a UNIX domain socket can also be specified (port is ignored then).
• port — number. Port to connect to. Default is 6600.
• password — string. Server's password.
• timeout — number. If specified and not negative, the number of seconds to wait before calling cb with what="timeout" again (after a connection has been established). May be fractional.
• retry_in — number. Number of seconds to retry in after the connection is lost. A negative value means do not retry and return immediately. May be fractional. Defaults to 10.
• retry_fifo — string. Path to an existent FIFO. The plugin does not create the FIFO itself. To force a reconnect, touch(1) the FIFO, that is, open it for writing and then close.
• events — array of strings. List of MPD subsystems to poll for changes in. See the description of idle command at https://www.musicpd.org/doc/html/protocol.html#querying-mpd-s-status for the complete list. Default is {"mixer","player"}.

💅 CB ARGUMENT 💅

A table with a what entry.

• If what is "connecting", the plugin is now connecting to the server.
• If what is "update", either the plugin has just connected to the server and queried its state, or the server has just changed its state. Additionally, the following entries are provided:
  • song — table with server's response to the currentsong command. Surprisingly, it is not documented at all, so here is an example (all values are strings):

┌───────────────┬──────────────────────┐
│ Key           │ Value                │
├───────────────┼──────────────────────┤
│ file          │ Sensou to Heiwa.mp3  │
├───────────────┼──────────────────────┤
│ Last-Modified │ 2016-07-31T09:56:31Z │
├───────────────┼──────────────────────┤
│ Artist        │ ALI PROJECT          │
├───────────────┼──────────────────────┤
│ AlbumArtist   │ ALI PROJECT          │
├───────────────┼──────────────────────┤
│ Title         │ 戦争と平和           │
├───────────────┼──────────────────────┤
│ Album         │ Erotic & Heretic     │
├───────────────┼──────────────────────┤
│ Track         │ 8                    │
├───────────────┼──────────────────────┤
│ Date          │ 2002-02-20           │
├───────────────┼──────────────────────┤
│ Genre         │ J-Pop                │
├───────────────┼──────────────────────┤
│ Disc          │ 1/1                  │
├───────────────┼──────────────────────┤
│ Time          │ 260                  │
├───────────────┼──────────────────────┤
│ Pos           │ 0                    │
├───────────────┼──────────────────────┤
│ Id            │ 4                    │
└───────────────┴──────────────────────┘

• status — table with server's response to the status command. See the status command description at https://www.musicpd.org/doc/html/protocol.html#querying-mpd-s-status.

All values are strings.

• If what is "timeout", the server hasn't changed its state for the number of seconds specified as the timeout option.
• If what is "error", the connection has been lost; the plugin is now going to sleep and try to reconnect. This is only reported if retry_in is non-negative.

🌈 COPYRIGHT 🌈

LGPLv3.

---

Cute sign-off bestie: the footer/source-version tag is luastatus-plugin-mpd(7) 💖. There's no separate date line on this page, so no invented date here — just that tag and the LGPLv3 copyright above 🫶.