1waybar-mpris(5)               File Formats Manual              waybar-mpris(5)
2
3
4

NAME

6       waybar - MPRIS module
7

DESCRIPTION

9       The mpris module displays currently playing media via libplayerctl.
10

CONFIGURATION

12       player:
13            typeof: string
14            default: playerctld
15            Name of the MPRIS player to attach to. Using the default value al‐
16       ways
17           follows the currenly active player.
18
19       ignored-players:
20            typeof: []string
21            Ignore updates of the listed players, when using playerctld.
22
23       interval:
24            typeof: integer
25            Refresh MPRIS information on a timer.
26
27       format:
28            typeof: string
29            default: {player} ({status}) {dynamic}
30            The text format.
31
32       format-[status]:
33            typeof: string
34            The status-specific text format.
35
36       on-click:
37            typeof: string
38            default: play-pause
39            Overwrite default action toggles.
40
41       on-middle-click:
42            typeof: string
43            default: previous track
44            Overwrite default action toggles.
45
46       on-right-click:
47            typeof: string
48            default: next track
49            Overwrite default action toggles.
50
51       player-icons:
52            typeof: map[string]string
53           Allows setting {player-icon} based on player-name property.
54
55       status-icons:
56            typeof: map[string]string
57           Allows setting {status-icon} based on player status (playing,
58           paused, stopped).
59

FORMAT REPLACEMENTS

61       {player}: The name of the current media player
62
63       {status}: The current status (playing, paused, stopped)
64
65       {artist}: The artist of the current track
66
67       {album}: The album title of the current track
68
69       {title}: The title of the current track
70
71       {length}: Length of the track, formatted as HH:MM:SS
72
73       {dynamic}: Use {artist}, {album}, {title} and {length}, automatically
74       omit
75                  empty values
76
77       {player-icon}: Chooses an icon from player-icons based on {player}
78
79       {status-icon}: Chooses an icon from status-icons based on {status}
80

EXAMPLES

82           "mpris": {
83                "format": "DEFAULT: {player_icon} {dynamic}",
84                "format-paused": "DEFAULT: {status_icon} <i>{dynamic}</i>",
85                "player-icons": {
86                     "default": "▶",
87                     "mpv": "🎵"
88                },
89                "status-icons": {
90                     "paused": "⏸"
91                },
92                // "ignored-players": ["firefox"]
93           }
94

STYLE

96       •   #mpris
97       •   #mpris.${status}
98       •   #mpris.${player}
99
100
101
102                                  2023-01-11                   waybar-mpris(5)