1waybar-wireplumber(5)         File Formats Manual        waybar-wireplumber(5)
2
3
4

NAME

6       waybar - WirePlumber module
7

DESCRIPTION

9       The wireplumber module displays the current volume reported by Wire‐
10       Plumber.
11

CONFIGURATION

13       format:
14            typeof: string
15            default: {volume}%
16            The format, how information should be displayed. This format is
17       used when other formats aren't specified.
18
19       format-muted:
20            typeof: string
21            This format is used when the sound is muted.
22
23       tooltip:
24            typeof: bool
25            default: true
26            Option to disable tooltip on hover.
27
28       tooltip-format:
29            typeof: string
30            default: {node_name}
31            The format of information displayed in the tooltip.
32
33       rotate:
34            typeof: integer
35            Positive value to rotate the text label.
36
37       states:
38            typeof: object
39            A number of volume states which get activated on certain volume
40       levels. See waybar-states(5).
41
42       max-length:
43            typeof: integer
44            The maximum length in character the module should display.
45
46       min-length:
47            typeof: integer
48            The minimum length in characters the module should accept.
49
50       align:
51            typeof: float
52            The alignment of the text, where 0 is left-aligned and 1 is right-
53       aligned. If the module is rotated, it will follow the flow of the text.
54
55       scroll-step:
56            typeof: float
57            default: 1.0
58            The speed at which to change the volume when scrolling.
59
60       on-click:
61            typeof: string
62            Command to execute when clicked on the module.
63
64       on-click-middle:
65            typeof: string
66            Command to execute when middle-clicked on the module using mouse‐
67       wheel.
68
69       on-click-right:
70            typeof: string
71            Command to execute when you right-click on the module.
72
73       on-update:
74            typeof: string
75            Command to execute when the module is updated.
76
77       on-scroll-up:
78            typeof: string
79            Command to execute when scrolling up on the module. This replaces
80       the default behaviour of volume control.
81
82       on-scroll-down:
83            typeof: string
84            Command to execute when scrolling down on the module. This re‐
85       places the default behaviour of volume control.
86
87       max-volume:
88            typeof: float
89            default: 100
90            The maximum volume that can be set, in percentage.
91

FORMAT REPLACEMENTS

93       {volume}: Volume in percentage.
94
95       {node_name}: The node's nickname as reported by WirePlumber (node.nick
96       property)
97

EXAMPLES

99           "wireplumber": {
100                "format": "{volume}%",
101                "format-muted": "",
102                "on-click": "helvum"
103           }
104

STYLE

106       •   #wireplumber
107       •   #wireplumber.muted
108
109
110
111                                  2023-11-05             waybar-wireplumber(5)
Impressum