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 currently active player.
17 ignored-players:
19 typeof: []string
20 Ignore updates of the listed players, when using playerctld.
21 interval:
23 typeof: integer
24 default: 0
25 Refresh MPRIS information on a timer.
26 format:
28 typeof: string
29 default: {player} ({status}) {dynamic}
30 The text format.
31 format-[status]:
33 typeof: string
34 The status-specific text format.
35 tooltip:
37 typeof: bool
38 default: true
39 Option to disable tooltip on hover.
40 tooltip-format:
42 typeof: string
43 default: {player} ({status}) {dynamic}
44 The tooltip text format.
45 tooltip-format-[status]:
47 typeof: string
48 The status-specific tooltip format.
49 artist-len:
51 typeof: integer
52 Maximum length of the Artist tag (Wide/Fullwidth Unicode charac‐
53 ters count as two). Set to zero to hide the artist in `{dynamic}` tag.
54 album-len:
56 typeof: integer
57 Maximum length of the Album tag (Wide/Fullwidth Unicode characters
58 count as two). Set to zero to hide the album in `{dynamic}` tag.
59 title-len:
61 typeof: integer
62 Maximum length of the Title tag (Wide/Fullwidth Unicode characters
63 count as two). Set to zero to hide the title in `{dynamic}` tag.
64 dynamic-len:
66 typeof: integer
67 Maximum length of the Dynamic tag (Wide/Fullwidth Unicode charac‐
68 ters
69 count as two). The dynamic tag will not truncate any tags beyond
70 their
71 set length limits, instead, it will attempt to fit as much of the
72 available tags as possible. It is recommended you set title-len to
73 something less than or equal to this value, so the title will al‐
74 ways be
75 displayed.
76 dynamic-order:
78 typeof: []string
79 default: ["title", "artist", "album", "position", "length"]
80 Order of the tags shown by Dynamic tag. The position and length
81 tags
82 will always be combined in the format [{position}/{length}]. The
83 order
84 of these tags in relation to other tags will be determined based
85 on the
86 declaration of the first among the two tags. Absence in this list
87 means
88 force exclusion.
89 dynamic-importance-order:
91 typeof: []string
92 default: ["title", "artist", "album", "position", "length"]
93 Priority of the tags when truncating the Dynamic tag. The final
94 ones
95 will be the first to be truncated. Absence in this list means
96 force
97 inclusion.
98 dynamic-separator:
100 typeof: string
101 default: " - "
102 These characters will be used to separate two different tags, ex‐
103 cept
104 when one of these tags is position and length.
105 truncate-hours:
107 typeof: bool
108 default: true
109 Whether to hide hours when media duration is less than an hour
110 long.
111 enable-tooltip-len-limits:
113 typeof: bool
114 default: false
115 Option to enable the length limits for the tooltip as well. By de‐
116 fault, the tooltip ignores all length limits.
117 ellipsis:
119 typeof: string
120 default: "…"
121 This character will be used when any of the tags exceed their max‐
122 imum length. If you don't want to use an ellipsis, set this to empty
123 string.
124 rotate:
126 typeof: integer
127 Positive value to rotate the text label.
128 max-length:
130 typeof: integer
131 The maximum length in character the module should display.
132 min-length:
134 typeof: integer
135 The minimum length in characters the module should accept.
136 align:
138 typeof: float
139 The alignment of the text, where 0 is left-aligned and 1 is right-
140 aligned.
141 If the module is rotated, it will follow the flow of the text.
142 on-click:
144 typeof: string
145 default: play-pause
146 Overwrite default action toggles.
147 on-click-middle:
149 typeof: string
150 default: previous track
151 Overwrite default action toggles.
152 on-click-right:
154 typeof: string
155 default: next track
156 Overwrite default action toggles.
157 player-icons:
159 typeof: map[string]string
160 Allows setting {player-icon} based on player-name property.
161 status-icons:
163 typeof: map[string]string
164 Allows setting {status-icon} based on player status (playing,
165 paused, stopped).
166
168 {player}: The name of the current media player
169 {status}: The current status (playing, paused, stopped)
171 {artist}: The artist of the current track
173 {album}: The album title of the current track
175 {title}: The title of the current track
177 {length}: Length of the track, formatted as HH:MM:SS
179 {dynamic}: Use {artist}, {album}, {title} and {length}, automatically
181 omit
182 empty values
183 {player_icon}: Chooses an icon from player-icons based on {player}
185 {status_icon}: Chooses an icon from status-icons based on {status}
187
189 "mpris": {
190 "format": "{player_icon} {dynamic}",
191 "format-paused": "{status_icon} <i>{dynamic}</i>",
192 "player-icons": {
193 "default": "▶",
194 "mpv": "🎵"
195 },
196 "status-icons": {
197 "paused": "⏸"
198 },
199 // "ignored-players": ["firefox"]
200 }
201
203 • #mpris
204 • #mpris.${status}
205 • #mpris.${player}
206 2023-11-05 waybar-mpris(5)