waybar/man/waybar-mpris.5.scd

198 lines
5.0 KiB
Plaintext
Raw Permalink Normal View History

waybar-mpris(5)
# NAME
waybar - MPRIS module
# DESCRIPTION
The *mpris* module displays currently playing media via libplayerctl.
# CONFIGURATION
*player*: ++
typeof: string ++
default: playerctld ++
Name of the MPRIS player to attach to. Using the default value always
follows the currenly active player.
*ignored-players*: ++
typeof: []string ++
Ignore updates of the listed players, when using playerctld.
*interval*: ++
typeof: integer ++
Refresh MPRIS information on a timer.
*format*: ++
typeof: string ++
default: {player} ({status}) {dynamic} ++
The text format.
*format-[status]*: ++
typeof: string ++
The status-specific text format.
2023-02-16 13:41:24 +01:00
*tooltip*: ++
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
*tooltip-format*: ++
typeof: string ++
default: {player} ({status}) {dynamic} ++
The tooltip text format.
*tooltip-format-[status]*: ++
typeof: string ++
2023-02-17 09:50:07 +01:00
The status-specific tooltip format.
2023-02-16 13:41:24 +01:00
*artist-len*: ++
typeof: integer ++
Maximum length of the Artist tag (Wide/Fullwidth Unicode characters
count as two). Set to zero to hide the artist in `{dynamic}` tag.
2023-02-16 13:41:24 +01:00
*album-len*: ++
typeof: integer ++
Maximum length of the Album tag (Wide/Fullwidth Unicode characters count
as two). Set to zero to hide the album in `{dynamic}` tag.
2023-02-16 13:41:24 +01:00
*title-len*: ++
typeof: integer ++
Maximum length of the Title tag (Wide/Fullwidth Unicode characters count
as two). Set to zero to hide the title in `{dynamic}` tag.
2023-02-16 13:41:24 +01:00
*dynamic-len*: ++
typeof: integer ++
Maximum length of the Dynamic tag (Wide/Fullwidth Unicode characters ++
count as two). The dynamic tag will not truncate any tags beyond their ++
set length limits, instead, it will attempt to fit as much of the ++
available tags as possible. It is recommended you set title-len to ++
something less than or equal to this value, so the title will always be ++
2023-02-17 09:50:07 +01:00
displayed.
2023-02-16 13:41:24 +01:00
*dynamic-order*: ++
typeof: []string ++
default: ["title", "artist", "album", "position", "length"] ++
Order of the tags shown by Dynamic tag. The position and length tags ++
will always be combined in the format [{position}/{length}]. The order ++
of these tags in relation to other tags will be determined based on the ++
declaration of the first among the two tags. Absence in this list means ++
force exclusion.
*dynamic-importance-order*: ++
2023-02-16 13:41:24 +01:00
typeof: []string ++
default: ["title", "artist", "album", "position", "length"] ++
Priority of the tags when truncating the Dynamic tag. The final ones ++
will be the first to be truncated. Absence in this list means force ++
inclusion.
2023-02-16 13:41:24 +01:00
*dynamic-separator*: ++
typeof: string ++
default: " - " ++
These characters will be used to separate two different tags, except ++
when one of these tags is position and length.
*truncate-hours*: ++
typeof: bool ++
default: true ++
2023-02-17 09:50:07 +01:00
Whether to hide hours when media duration is less than an hour long.
2023-02-16 13:41:24 +01:00
*enable-tooltip-len-limits*: ++
typeof: bool ++
default: false ++
2023-02-17 09:50:07 +01:00
Option to enable the length limits for the tooltip as well. By default
the tooltip ignores all length limits.
*ellipsis*: ++
typeof: string ++
default: "…" ++
2023-02-17 09:50:07 +01:00
This character will be used when any of the tags exceed their maximum
length. If you don't want to use an ellipsis, set this to empty string.
2023-02-16 13:41:24 +01:00
*rotate*: ++
typeof: integer ++
Positive value to rotate the text label.
*max-length*: ++
typeof: integer ++
The maximum length in character the module should display.
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
*align*: ++
typeof: float ++
The alignment of the text, where 0 is left-aligned and 1 is right-aligned.
If the module is rotated, it will follow the flow of the text.
*on-click*: ++
typeof: string ++
default: play-pause ++
Overwrite default action toggles.
*on-middle-click*: ++
typeof: string ++
default: previous track ++
Overwrite default action toggles.
*on-right-click*: ++
typeof: string ++
default: next track ++
Overwrite default action toggles.
*player-icons*: ++
typeof: map[string]string ++
Allows setting _{player-icon}_ based on player-name property.
*status-icons*: ++
typeof: map[string]string ++
Allows setting _{status-icon}_ based on player status (playing, paused,
stopped).
# FORMAT REPLACEMENTS
*{player}*: The name of the current media player
*{status}*: The current status (playing, paused, stopped)
*{artist}*: The artist of the current track
*{album}*: The album title of the current track
*{title}*: The title of the current track
*{length}*: Length of the track, formatted as HH:MM:SS
*{dynamic}*: Use _{artist}_, _{album}_, _{title}_ and _{length}_, automatically omit++
empty values
*{player_icon}*: Chooses an icon from _player-icons_ based on _{player}_
*{status_icon}*: Chooses an icon from _status-icons_ based on _{status}_
# EXAMPLES
```
"mpris": {
2023-02-16 13:41:24 +01:00
"format": "{player_icon} {dynamic}",
"format-paused": "{status_icon} <i>{dynamic}</i>",
"player-icons": {
"default": "▶",
"mpv": "🎵"
},
"status-icons": {
"paused": "⏸"
},
// "ignored-players": ["firefox"]
}
```
# STYLE
- *#mpris*
- *#mpris.${status}*
- *#mpris.${player}*