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

NAME

6       waybar - pulseaudio module
7

DESCRIPTION

9       The pulseaudio module displays the current volume reported by PulseAu‐
10       dio.
11
12       Additionally you can control the volume by scrolling up or down while
13       the cursor is over the module.
14

CONFIGURATION

16       format:
17            typeof: string
18            default: {volume}%
19            The format, how information should be displayed. This format is
20       used when other formats aren't specified.
21
22       format-bluetooth:
23            typeof: string
24            This format is used when using bluetooth speakers.
25
26       format-muted:
27            typeof: string
28            This format is used when the sound is muted.
29
30       format-source:
31            typeof: string
32            default: {volume}%
33            This format used for the source.
34
35       format-source-muted:
36            typeof: string
37            This format is used when the source is muted.
38
39       format-icons:
40            typeof: array
41            Based on the current port-name and volume, the corresponding icon
42       gets selected. The order is low to high. See Icons.
43
44       rotate:
45            typeof: integer
46            Positive value to rotate the text label.
47
48       states:
49            typeof: object
50            A number of volume states which get activated on certain volume
51       levels. See waybar-states(5).
52
53       max-length:
54            typeof: integer
55            The maximum length in character the module should display.
56
57       min-length:
58            typeof: integer
59            The minimum length in characters the module should take up.
60
61       align:
62            typeof: float
63            The alignment of the text, where 0 is left-aligned and 1 is right-
64       aligned. If the module is rotated, it will follow the flow of the text.
65
66       scroll-step:
67            typeof: float
68            default: 1.0
69            The speed in which to change the volume when scrolling.
70
71       on-click:
72            typeof: string
73            Command to execute when clicked on the module.
74
75       on-click-middle:
76            typeof: string
77            Command to execute when middle-clicked on the module using mouse‐
78       wheel.
79
80       on-click-right:
81            typeof: string
82            Command to execute when you right clicked on the module.
83
84       on-update:
85            typeof: string
86            Command to execute when the module is updated.
87
88       on-scroll-up:
89            typeof: string
90            Command to execute when scrolling up on the module. This replaces
91       the default behaviour of volume control.
92
93       on-scroll-down:
94            typeof: string
95            Command to execute when scrolling down on the module. This re‐
96       places the default behaviour of volume control.
97
98       smooth-scrolling-threshold:
99            typeof: double
100            Threshold to be used when scrolling.
101
102       reverse-scrolling:
103            typeof: bool
104            Option to reverse the scroll direction.
105
106       tooltip:
107            typeof: bool
108            default: true
109            Option to disable tooltip on hover.
110
111       max-volume:
112            typeof: integer
113            default: 100
114            The maximum volume that can be set, in percentage.
115
116       ignored-sinks:
117            typeof: array
118            Sinks in this list will not be shown as the active sink by Waybar.
119       Entries should be the sink's description field.
120

FORMAT REPLACEMENTS

122       {desc}: Pulseaudio port's description, for bluetooth it'll be the de‐
123       vice name.
124
125       {volume}: Volume in percentage.
126
127       {icon}: Icon, as defined in format-icons.
128
129       {format_source}: Source format, format-source, format-source-muted.
130

ICONS:

132       The following strings for format-icons are supported.
133
134       •   the device name
135
136
137       If they are found in the current PulseAudio port name, the correspond‐
138       ing icons will be selected.
139
140default (Shown, when no other port is found)
141headphone
142speaker
143hdmi
144headset
145hands-free
146portable
147car
148hifi
149phone
150
151

EXAMPLES

153           "pulseaudio": {
154                "format": "{volume}% {icon}",
155                "format-bluetooth": "{volume}% {icon}",
156                "format-muted": "",
157                "format-icons": {
158                     "alsa_output.pci-0000_00_1f.3.analog-stereo": "",
159                     "headphones": "",
160                     "handsfree": "",
161                     "headset": "",
162                     "phone": "",
163                     "portable": "",
164                     "car": "",
165                     "default": ["", ""]
166                },
167                "scroll-step": 1,
168                "on-click": "pavucontrol"
169           }
170

STYLE

172#pulseaudio
173#pulseaudio.bluetooth
174#pulseaudio.muted
175
176
177
178                                  2023-08-16              waybar-pulseaudio(5)
Impressum