1waybar-mpris(5) File Formats Manual waybar-mpris(5)
2
6 waybar - MPRIS module
7
9 The mpris module displays currently playing media via libplayerctl.
10
12 player:
13 typeof: string
14 default: playerctld
15 Name of the MPRIS player to attach to. Using the default value al‐
16 ways follows the currenly active player.
17 ignored-players:
19 typeof: []string
20 Ignore updates of the listed players, when using playerctld.
21 interval:
23 typeof: integer
24 Refresh MPRIS information on a timer.
25 format:
27 typeof: string
28 default: {player} ({status}) {dynamic}
29 The text format.
30 format-[status]:
32 typeof: string
33 The status-specific text format.
34 tooltip:
36 typeof: bool
37 default: true
38 Option to disable tooltip on hover.
39 tooltip-format:
41 typeof: string
42 default: {player} ({status}) {dynamic}
43 The tooltip text format.
44 tooltip-format-[status]:
46 typeof: string
47 The status-specific tooltip format.
48 artist-len:
50 typeof: integer
51 Maximum length of the Artist tag (Wide/Fullwidth Unicode charac‐
52 ters count as two). Set to zero to hide the artist in `{dynamic}` tag.
53 album-len:
55 typeof: integer
56 Maximum length of the Album tag (Wide/Fullwidth Unicode characters
57 count as two). Set to zero to hide the album in `{dynamic}` tag.
58 title-len:
60 typeof: integer
61 Maximum length of the Title tag (Wide/Fullwidth Unicode characters
62 count as two). Set to zero to hide the title in `{dynamic}` tag.
63 dynamic-len:
65 typeof: integer
66 Maximum length of the Dynamic tag (Wide/Fullwidth Unicode charac‐
67 ters
68 count as two). The dynamic tag will not truncate any tags beyond
69 their
70 set length limits, instead, it will attempt to fit as much of the
71 available tags as possible. It is recommended you set title-len to
72 something less than or equal to this value, so the title will al‐
73 ways be
74 displayed.
75 dynamic-order:
77 typeof: []string
78 default: ["title", "artist", "album", "position", "length"]
79 Order of the tags shown by Dynamic tag. The position and length
80 tags
81 will always be combined in the format [{position}/{length}]. The
82 order
83 of these tags in relation to other tags will be determined based
84 on the
85 declaration of the first among the two tags. Absence in this list
86 means
87 force exclusion.
88 dynamic-importance-order:
90 typeof: []string
91 default: ["title", "artist", "album", "position", "length"]
92 Priority of the tags when truncating the Dynamic tag. The final
93 ones
94 will be the first to be truncated. Absence in this list means
95 force
96 inclusion.
97 dynamic-separator:
99 typeof: string
100 default: " - "
101 These characters will be used to separate two different tags, ex‐
102 cept
103 when one of these tags is position and length.
104 truncate-hours:
106 typeof: bool
107 default: true
108 Whether to hide hours when media duration is less than an hour
109 long.
110 enable-tooltip-len-limits:
112 typeof: bool
113 default: false
114 Option to enable the length limits for the tooltip as well. By de‐
115 fault the tooltip ignores all length limits.
116 ellipsis:
118 typeof: string
119 default: "…"
120 This character will be used when any of the tags exceed their max‐
121 imum length. If you don't want to use an ellipsis, set this to empty
122 string.
123 rotate:
125 typeof: integer
126 Positive value to rotate the text label.
127 max-length:
129 typeof: integer
130 The maximum length in character the module should display.
131 min-length:
133 typeof: integer
134 The minimum length in characters the module should take up.
135 align:
137 typeof: float
138 The alignment of the text, where 0 is left-aligned and 1 is right-
139 aligned.
140 If the module is rotated, it will follow the flow of the text.
141 on-click:
143 typeof: string
144 default: play-pause
145 Overwrite default action toggles.
146 on-middle-click:
148 typeof: string
149 default: previous track
150 Overwrite default action toggles.
151 on-right-click:
153 typeof: string
154 default: next track
155 Overwrite default action toggles.
156 player-icons:
158 typeof: map[string]string
159 Allows setting {player-icon} based on player-name property.
160 status-icons:
162 typeof: map[string]string
163 Allows setting {status-icon} based on player status (playing,
164 paused, stopped).
165
167 {player}: The name of the current media player
168 {status}: The current status (playing, paused, stopped)
170 {artist}: The artist of the current track
172 {album}: The album title of the current track
174 {title}: The title of the current track
176 {length}: Length of the track, formatted as HH:MM:SS
178 {dynamic}: Use {artist}, {album}, {title} and {length}, automatically
180 omit
181 empty values
182 {player_icon}: Chooses an icon from player-icons based on {player}
184 {status_icon}: Chooses an icon from status-icons based on {status}
186
188 "mpris": {
189 "format": "{player_icon} {dynamic}",
190 "format-paused": "{status_icon} <i>{dynamic}</i>",
191 "player-icons": {
192 "default": "▶",
193 "mpv": "🎵"
194 },
195 "status-icons": {
196 "paused": "⏸"
197 },
198 // "ignored-players": ["firefox"]
199 }
200
202 • #mpris
203 • #mpris.${status}
204 • #mpris.${player}
205 2023-08-16 waybar-mpris(5)