1yambar-modules-mpd(5)         File Formats Manual        yambar-modules-mpd(5)
2
3
4

NAME

6       mpd - This module provides MPD status such as currently playing
7       artist/album/song
8

TAGS

10       ┌─────────┬──────────┬─────────────────────────────────────────────────┐
11Name     Type     Description                                     
12       ├─────────┼──────────┼─────────────────────────────────────────────────┤
13       │state    │ string   │ One of offline, stopped, paused or playing      
14       ├─────────┼──────────┼─────────────────────────────────────────────────┤
15       │repeat   │ bool     │ True if the repeat flag is set                  │
16       ├─────────┼──────────┼─────────────────────────────────────────────────┤
17       │random   │ bool     │ True if the random flag is set                  │
18       ├─────────┼──────────┼─────────────────────────────────────────────────┤
19       │consume  │ bool     │ True if the consume flag is set                 │
20       ├─────────┼──────────┼─────────────────────────────────────────────────┤
21       │volume   │ range    │ Volume of MPD in percentage                     │
22       ├─────────┼──────────┼─────────────────────────────────────────────────┤
23       │album    │ string   │ Currently playing album (also valid in paused   
24       │         │          │ state)                                          │
25       ├─────────┼──────────┼─────────────────────────────────────────────────┤
26       │artist   │ string   │ Artist of currently playing song (also valid in │
27       │         │          │ paused state)                                   │
28       ├─────────┼──────────┼─────────────────────────────────────────────────┤
29       │title    │ string   │ Title of currently playing song (also valid in  │
30       │         │          │ paused state)                                   │
31       ├─────────┼──────────┼─────────────────────────────────────────────────┤
32       │file     │ string   │ Filename or URL of currently playing song (also │
33       │         │          │ valid in paused state)                          │
34       ├─────────┼──────────┼─────────────────────────────────────────────────┤
35       │pos      │ string   │ %M:%S-formatted string describing the song's    │
36       │         │          │ current position (also see elapsed)             │
37       ├─────────┼──────────┼─────────────────────────────────────────────────┤
38       │end      │ string   │ %M:%S-formatted string describing the song's    │
39       │         │          │ total length (also see duration)                │
40       ├─────────┼──────────┼─────────────────────────────────────────────────┤
41       │elapsed  │ realtime │ Position in currently playing song, in mil‐     │
42       │         │          │ liseconds. Can be used with a progress-bar par‐ │
43       │         │          │ ticle.                                          │
44       ├─────────┼──────────┼─────────────────────────────────────────────────┤
45       │duration │ int      │ Length of currently playing song, in millisec‐  │
46       │         │          │ onds                                            │
47       └─────────┴──────────┴─────────────────────────────────────────────────┘
48

CONFIGURATION

50       ┌─────┬────────┬─────┬─────────────────────────────────────────────────┐
51Name Type   Req Description                                     
52       ├─────┼────────┼─────┼─────────────────────────────────────────────────┤
53       │host │ string │ yes │ Hostname/IP/unix-socket to connect to           │
54       ├─────┼────────┼─────┼─────────────────────────────────────────────────┤
55       │port │ int    │ no  │ TCP port to connect to                          │
56       └─────┴────────┴─────┴─────────────────────────────────────────────────┘
57

EXAMPLES

59           bar:
60             left:
61               - mpd:
62                   host: /run/mpd/socket
63                   content:
64                     string: {text: "{artist} - {album} - {title} ({end})"}
65

SEE ALSO

67       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
68       tions(5)
69
70                                  2023-07-22             yambar-modules-mpd(5)
Impressum