.\" Generated by scdoc 1.11.2
.\" 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" "2023-02-28"
.P
.SH NAME
.P
waybar - MPRIS module
.P
.SH DESCRIPTION
.P
The \fBmpris\fR module displays currently playing media via libplayerctl.\&
.P
.SH CONFIGURATION
.P
\fBplayer\fR: 
.br
	typeof: string 
.br
	default: playerctld 
.br
	Name of the MPRIS player to attach to.\& Using the default value always
.RS 4
follows the currenly active player.\&
.P
.RE
\fBignored-players\fR: 
.br
	typeof: []string 
.br
	Ignore updates of the listed players, when using playerctld.\&
.P
\fBinterval\fR: 
.br
	typeof: integer 
.br
	Refresh MPRIS information on a timer.\&
.P
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {player} ({status}) {dynamic} 
.br
	The text format.\&
.P
\fBformat-[status]\fR: 
.br
	typeof: string 
.br
	The status-specific text format.\&
.P
\fBon-click\fR: 
.br
	typeof: string 
.br
	default: play-pause 
.br
	Overwrite default action toggles.\&
.P
\fBon-middle-click\fR: 
.br
	typeof: string 
.br
	default: previous track 
.br
	Overwrite default action toggles.\&
.P
\fBon-right-click\fR: 
.br
	typeof: string 
.br
	default: next track 
.br
	Overwrite default action toggles.\&
.P
\fBplayer-icons\fR: 
.br
	typeof: map[string]string
.RS 4
Allows setting \fI{player-icon}\fR based on player-name property.\&
.P
.RE
\fBstatus-icons\fR: 
.br
	typeof: map[string]string
.RS 4
Allows setting \fI{status-icon}\fR based on player status (playing, paused,
stopped).\&
.P
.P
.RE
.SH FORMAT REPLACEMENTS
.P
\fB{player}\fR: The name of the current media player
.P
\fB{status}\fR: The current status (playing, paused, stopped)
.P
\fB{artist}\fR: The artist of the current track
.P
\fB{album}\fR: The album title of the current track
.P
\fB{title}\fR: The title of the current track
.P
\fB{length}\fR: Length of the track, formatted as HH:MM:SS
.P
\fB{dynamic}\fR: Use \fI{artist}\fR, \fI{album}\fR, \fI{title}\fR and \fI{length}\fR, automatically omit
.br
           empty values
.P
\fB{player-icon}\fR: Chooses an icon from \fIplayer-icons\fR based on \fI{player}\fR
.P
\fB{status-icon}\fR: Chooses an icon from \fIstatus-icons\fR based on \fI{status}\fR
.P
.SH EXAMPLES
.P
.nf
.RS 4
"mpris": {
	"format": "DEFAULT: {player_icon} {dynamic}",
	"format-paused": "DEFAULT: {status_icon} <i>{dynamic}</i>",
	"player-icons": {
		"default": "▶",
		"mpv": "🎵"
	},
	"status-icons": {
		"paused": "⏸"
	},
	// "ignored-players": ["firefox"]
}
.fi
.RE
.P
.SH STYLE
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#mpris\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#mpris.\&${status}\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#mpris.\&${player}\fR
.RE