Module: MPRIS

The mpris module displays currently playing media via libplayerctl.

Config

option	typeof	default	description
player	string	playerctld	Name of the MPRIS player to attach to. Using the default value always follows the currenly active player.
ignored-players	[]string		Ignore updates of the listed players, when using playerctld.
interval	integer		Refresh MPRIS information on a timer.
format	string	{player} ({status}) {dynamic}	The text format.
format-[status]	string		The status-specific text format.
on-click	string	play-pause	Overwrite default action toggles.
on-middle-click	string	previous track	Overwrite default action toggles.
on-right-click	string	next track	Overwrite default action toggles.
player-icons	map[string]string		Allows setting {player-icon} based on player-name property.
status-icons	map[string]string		Allows setting {status-icon} based on player status (playing, paused, stopped).

Format replacements

When playing/paused:

string	replacement
{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}

Example

"mpris": {
	"format": "DEFAULT: {player_icon} {dynamic}",
	"format-paused": "DEFAULT: {status_icon} <i>{dynamic}</i>",
	"player-icons": {
		"default": "▶",
		"mpv": "🎵"
	},
	"status-icons": {
		"paused": "⏸"
	},
	// "ignored-players": ["firefox"]
}

Style

• #mpris
• #mpris.${status}
• #mpris.${player}