Skip to content

Module: WirePlumber

Sasha Moak edited this page Nov 26, 2022 · 9 revisions

The wireplumber module displays the current volume reported by WirePlumber.

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.
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.
tooltip bool true Option to enable tooltip on hover.
tooltip-format string {node_name} Tooltip on hover.

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"
}

With icon support:

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

Style

  • #wireplumber
  • #wireplumber.muted
Clone this wiki locally