Module: WirePlumber

The wireplumber module displays the current volume reported by WirePlumber.

Additionally you can control the volume by scrolling up or down while the cursor is over the module.

Config

option	typeof	default	description
format	string	{volume}%	The format, how information should be displayed. This format is used when other formats aren't specified.
format-muted	string		This format is used when the sound is muted.
rotate	integer		Positive value to rotate the text label.
states	array		A number of volume states which get activated on certain volume levels. See States
max-length	integer		The maximum length in character the module should display.
scroll-step	float	1.0	The speed in which to change the volume when scrolling.
on-click	string		Command to execute when clicked on the module.
on-click-middle	string		Command to execute when you middle clicked on the module using mousewheel.
on-click-right	string		Command to execute when you right clicked on the module.
on-scroll-up	string		Command to execute when scrolling up on the module. This replaces the default beaviour of volume control.
on-scroll-down	string		Command to execute when scrolling down on the module. This replaces the default beaviour of volume control.
tooltip	bool	true	Option to enable tooltip on hover.
tooltip-format	string	{node_name}	Tooltip on hover.
max-volume	float	100.0	The maximum volume that can be set, in percentage.
reverse-scrolling	integer		If set to 1, moving the mouse wheel up will increase the volume (the default is to decrease) and moving the mouse wheel down will decrease the volume.

Format replacements:

string	replacement
{volume}	Volume in percentage
{node_name}	The node's nickname (WirePlumber's node.nick property)

Example:

"wireplumber": {
    "format": "{volume}%",
    "format-muted": "",
    "on-click": "helvum",
    "max-volume": 150,
    "scroll-step": 0.2
}

With icon support:

"wireplumber": {
    "format": "{volume}% {icon}",
    "format-muted": "",
    "on-click": "helvum",
    "format-icons": ["", "", ""]
}

Style

• #wireplumber
• #wireplumber.muted