Skip to content

Latest commit

 

History

History
149 lines (112 loc) · 3.47 KB

waybar-wireplumber.5.scd

File metadata and controls

149 lines (112 loc) · 3.47 KB

waybar-wireplumber(5)

NAME

waybar - WirePlumber module

DESCRIPTION

The wireplumber module displays the current volume reported by WirePlumber.

CONFIGURATION

format: ++ typeof: string ++ default: {volume}% ++ The format, how information should be displayed. This format is used when other formats aren't specified.

format-muted: ++ typeof: string ++ This format is used when the sound is muted.

node-type: ++ typeof: string ++ default: Audio/Sink ++ The WirePlumber node type to attach to. Use Audio/Source to manage microphones etc.

tooltip: ++ typeof: bool ++ default: true ++ Option to disable tooltip on hover.

tooltip-format: ++ typeof: string ++ default: {node_name} ++ The format of information displayed in the tooltip.

rotate: ++ typeof: integer ++ Positive value to rotate the text label (in 90 degree increments).

states: ++ typeof: object ++ A number of volume states which get activated on certain volume levels. See waybar-states(5).

max-length: ++ typeof: integer ++ The maximum length in character the module should display.

min-length: ++ typeof: integer ++ The minimum length in characters the module should accept.

align: ++ typeof: float ++ 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.

justify: ++ typeof: string ++ The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.

scroll-step: ++ typeof: float ++ default: 1.0 ++ The speed at which to change the volume when scrolling.

on-click: ++ typeof: string ++ Command to execute when clicked on the module.

on-click-middle: ++ typeof: string ++ Command to execute when middle-clicked on the module using mousewheel.

on-click-right: ++ typeof: string ++ Command to execute when you right-click on the module.

on-update: ++ typeof: string ++ Command to execute when the module is updated.

on-scroll-up: ++ typeof: string ++ Command to execute when scrolling up on the module. This replaces the default behaviour of volume control.

on-scroll-down: ++ typeof: string ++ Command to execute when scrolling down on the module. This replaces the default behaviour of volume control.

max-volume: ++ typeof: float ++ default: 100 ++ The maximum volume that can be set, in percentage.

menu: ++ typeof: string ++ Action that popups the menu.

menu-file: ++ typeof: string ++ Location of the menu descriptor file. There need to be an element of type GtkMenu with id menu

menu-actions: ++ typeof: array ++ The actions corresponding to the buttons of the menu.

FORMAT REPLACEMENTS

{volume}: Volume in percentage.

{node_name}: The node's nickname as reported by WirePlumber (node.nick property)

EXAMPLES

Basic:

"wireplumber": {
	"format": "{volume}%",
	"format-muted": "",
	"on-click": "helvum"
}

Separate Sink and Source Widgets

"wireplumber#sink": {
    "format": "{volume}% {icon}",
    "format-muted": "",
    "format-icons": ["", "", ""],
    "on-click": "helvum",
    "on-click-right": "wpctl set-mute @DEFAULT_AUDIO_SINK@ toggle",
    "scroll-step": 5
},
"wireplumber#source": {
    "node-type": "Audio/Source",
    "format": "{volume}% ",
    "format-muted": "",
    "on-click-right": "wpctl set-mute @DEFAULT_AUDIO_SOURCE@ toggle",
    "scroll-step": 5
}

STYLE

  • #wireplumber
  • #wireplumber.muted