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,     │
14       │         │          │ stopped, paused or  │
15       │         │          │ playing             
16       ├─────────┼──────────┼─────────────────────┤
17       │repeat   │ bool     │ True if the repeat  
18       │         │          │ flag is set         │
19       ├─────────┼──────────┼─────────────────────┤
20       │random   │ bool     │ True if the random  
21       │         │          │ flag is set         │
22       ├─────────┼──────────┼─────────────────────┤
23       │consume  │ bool     │ True if the consume 
24       │         │          │ flag is set         │
25       ├─────────┼──────────┼─────────────────────┤
26       │volume   │ range    │ Volume of MPD in    │
27       │         │          │ percentage          │
28       ├─────────┼──────────┼─────────────────────┤
29       │album    │ string   │ Currently playing   │
30       │         │          │ album (also valid   │
31       │         │          │ in paused state)    │
32       ├─────────┼──────────┼─────────────────────┤
33       │artist   │ string   │ Artist of currently │
34       │         │          │ playing song (also  │
35       │         │          │ valid in paused     
36       │         │          │ state)              │
37       ├─────────┼──────────┼─────────────────────┤
38       │title    │ string   │ Title of currently  │
39       │         │          │ playing song (also  │
40       │         │          │ valid in paused     
41       │         │          │ state)              │
42       ├─────────┼──────────┼─────────────────────┤
43       │pos      │ string   │ %M:%S-formatted     │
44       │         │          │ string describing   │
45       │         │          │ the song's current  │
46       │         │          │ position (also see  │
47       │         │          │ elapsed)            │
48       ├─────────┼──────────┼─────────────────────┤
49       │end      │ string   │ %M:%S-formatted     │
50       │         │          │ string describing   │
51       │         │          │ the song's total    │
52       │         │          │ length (also see    │
53       │         │          │ duration)           │
54       ├─────────┼──────────┼─────────────────────┤
55       │elapsed  │ realtime │ Position in cur‐    │
56       │         │          │ rently playing      │
57       │         │          │ song, in millisec‐  │
58       │         │          │ onds. Can be used   │
59       │         │          │ with a progress-bar
60       │         │          │ particle.           │
61       ├─────────┼──────────┼─────────────────────┤
62       │duration │ int      │ Length of currently │
63       │         │          │ playing song, in    │
64       │         │          │ milliseconds        │
65       └─────────┴──────────┴─────────────────────┘
66

CONFIGURATION

68       ┌─────┬────────┬─────┬──────────────────┐
69Name Type   Req Description      
70       ├─────┼────────┼─────┼──────────────────┤
71       │host │ string │ yes │ Host‐            │
72       │     │        │     │ name/IP/unix-    │
73       │     │        │     │ socket to con‐   │
74       │     │        │     │ nect to          │
75       ├─────┼────────┼─────┼──────────────────┤
76       │port │ int    │ no  │ TCP port to con‐ │
77       │     │        │     │ nect to          │
78       └─────┴────────┴─────┴──────────────────┘
79

EXAMPLES

81           bar:
82             left:
83               - mpd:
84                   host: /run/mpd/socket
85                   content:
86                     string: {text: "{artist} - {album} - {title} ({end})"}
87

SEE ALSO

89       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
90       tions(5)
91
92                                  2022-08-26             yambar-modules-mpd(5)
Impressum