.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "waybar-mpris" "5" "2025-02-21"
.PP
.SH NAME
.PP
waybar - MPRIS module
.PP
.SH DESCRIPTION
.PP
The \fBmpris\fR module displays currently playing media via libplayerctl.\&
.PP
.SH CONFIGURATION
.PP
\fBplayer\fR: 
.br
	typeof: string 
.br
	default: playerctld 
.br
	Name of the MPRIS player to attach to.\& Using the default value always follows the currently active player.\&
.PP
\fBignored-players\fR: 
.br
	typeof: []string 
.br
	Ignore updates of the listed players, when using playerctld.\&
.PP
\fBinterval\fR: 
.br
	typeof: integer 
.br
	default: 0 
.br
	Refresh MPRIS information on a timer.\&
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {player} ({status}) {dynamic} 
.br
	The text format.\&
.PP
\fBformat-[status]\fR: 
.br
	typeof: string 
.br
	The status-specific text format.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	default: {player} ({status}) {dynamic} 
.br
	The tooltip text format.\&
.PP
\fBtooltip-format-[status]\fR: 
.br
	typeof: string 
.br
	The status-specific tooltip format.\&
.PP
\fBartist-len\fR: 
.br
	typeof: integer 
.br
	Maximum length of the Artist tag (Wide/Fullwidth Unicode characters count as two).\& Set to zero to hide the artist in `{dynamic}` tag.\&
.PP
\fBalbum-len\fR: 
.br
	typeof: integer 
.br
	Maximum length of the Album tag (Wide/Fullwidth Unicode characters count as two).\& Set to zero to hide the album in `{dynamic}` tag.\&
.PP
\fBtitle-len\fR: 
.br
	typeof: integer 
.br
	Maximum length of the Title tag (Wide/Fullwidth Unicode characters count as two).\& Set to zero to hide the title in `{dynamic}` tag.\&
.PP
\fBdynamic-len\fR: 
.br
	typeof: integer 
.br
	Maximum length of the Dynamic tag (Wide/Fullwidth Unicode characters 
.br
	count as two).\& The dynamic tag will not truncate any tags beyond their 
.br
	set length limits, instead, it will attempt to fit as much of the 
.br
	available tags as possible.\& It is recommended you set title-len to 
.br
	something less than or equal to this value, so the title will always be 
.br
	displayed.\&
.PP
\fBdynamic-order\fR: 
.br
	typeof: []string 
.br
	default: ["title", "artist", "album", "position", "length"] 
.br
	Order of the tags shown by Dynamic tag.\& The position and length tags 
.br
	will always be combined in the format [{position}/{length}].\& The order 
.br
	of these tags in relation to other tags will be determined based on the 
.br
	declaration of the first among the two tags.\& Absence in this list means 
.br
	force exclusion.\&
.PP
\fBdynamic-importance-order\fR: 
.br
	typeof: []string 
.br
	default: ["title", "artist", "album", "position", "length"] 
.br
	Priority of the tags when truncating the Dynamic tag.\& The final ones 
.br
	will be the first to be truncated.\& Absence in this list means force 
.br
	inclusion.\&
.PP
\fBdynamic-separator\fR: 
.br
	typeof: string 
.br
	default: " - " 
.br
	These characters will be used to separate two different tags, except 
.br
	when one of these tags is position and length.\&
.PP
\fBtruncate-hours\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Whether to hide hours when media duration is less than an hour long.\&
.PP
\fBenable-tooltip-len-limits\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	Option to enable the length limits for the tooltip as well.\& By default, the tooltip ignores all length limits.\&
.PP
\fBellipsis\fR: 
.br
	typeof: string 
.br
	default: "…" 
.br
	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.\&
.PP
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label (in 90 degree increments).\&
.PP
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.PP
\fBmin-length\fR: 
.br
	typeof: integer 
.br
	The minimum length in characters the module should accept.\&
.PP
\fBalign\fR: 
.br
	typeof: float 
.br
	The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned.\& If the module is rotated, it will follow the flow of the text.\&
.PP
\fBjustify\fR: 
.br
	typeof: string 
.br
	The alignment of the text within the module'\&s label, allowing options '\&left'\&, '\&right'\&, or '\&center'\& to define the positioning.\&
.PP
\fBon-click\fR: 
.br
	typeof: string 
.br
	default: play-pause 
.br
	Overwrite default action toggles.\&
.PP
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	default: previous track 
.br
	Overwrite default action toggles.\&
.PP
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	default: next track 
.br
	Overwrite default action toggles.\&
.PP
\fBplayer-icons\fR: 
.br
	typeof: map[string]string 
.br
	Allows setting \fI{player_icon}\fR based on player-name property.\&
.PP
\fBstatus-icons\fR: 
.br
	typeof: map[string]string 
.br
	Allows setting \fI{status_icon}\fR based on player status (playing, paused, stopped).\&
.PP
\fBexpand\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	Enables this module to consume all left over space dynamically.\&
.PP
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{player}\fR: The name of the current media player
.PP
\fB{status}\fR: The current status (playing, paused, stopped)
.PP
\fB{artist}\fR: The artist of the current track
.PP
\fB{album}\fR: The album title of the current track
.PP
\fB{title}\fR: The title of the current track
.PP
\fB{length}\fR: Length of the track, formatted as HH:MM:SS
.PP
\fB{dynamic}\fR: Use \fI{artist}\fR, \fI{album}\fR, \fI{title}\fR and \fI{length}\fR, automatically omit
.br
	empty values
.PP
\fB{player_icon}\fR: Chooses an icon from \fIplayer-icons\fR based on \fI{player}\fR
.PP
\fB{status_icon}\fR: Chooses an icon from \fIstatus-icons\fR based on \fI{status}\fR
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"mpris": {
	"format": "{player_icon} {dynamic}",
	"format-paused": "{status_icon} <i>{dynamic}</i>",
	"player-icons": {
		"default": "▶",
		"mpv": "🎵"
	},
	"status-icons": {
		"paused": "⏸"
	},
	// "ignored-players": ["firefox"]
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#mpris\fR
.IP \(bu 4
\fB#mpris.\&${status}\fR
.IP \(bu 4
\fB#mpris.\&${player}\fR