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: array
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       scroll-step:
58            typeof: float
59            default: 1.0
60            The speed in which to change the volume when scrolling.
61
62       on-click:
63            typeof: string
64            Command to execute when clicked on the module.
65
66       on-click-middle:
67            typeof: string
68            Command to execute when middle-clicked on the module using mouse‐
69       wheel.
70
71       on-click-right:
72            typeof: string
73            Command to execute when you right clicked on the module.
74
75       on-update:
76            typeof: string
77            Command to execute when the module is updated.
78
79       on-scroll-up:
80            typeof: string
81            Command to execute when scrolling up on the module. This replaces
82       the default behaviour of volume control.
83
84       on-scroll-down:
85            typeof: string
86            Command to execute when scrolling down on the module. This
87       replaces the default behaviour of volume control.
88
89       smooth-scrolling-threshold:
90            typeof: double
91            Threshold to be used when scrolling.
92
93       tooltip:
94            typeof: bool
95            default: true
96            Option to disable tooltip on hover.
97

FORMAT REPLACEMENTS

99       {desc}: Pulseaudio port's description, for bluetooth it'll be the
100       device name.
101
102       {volume}: Volume in percentage.
103
104       {icon}: Icon, as defined in format-icons.
105
106       {format_source}: Source format, format-source, format-source-muted.
107

ICONS:

109       The following strings for format-icons are supported. If they are found
110       in the current PulseAudio port name, the corresponding icons will be
111       selected.
112
113       ·   default (Shown, when no other port is found)
114       ·   headphone
115       ·   speaker
116       ·   hdmi
117       ·   headset
118       ·   hands-free
119       ·   portable
120       ·   car
121       ·   hifi
122       ·   phone
123
124

EXAMPLES

126           "pulseaudio": {
127                "format": "{volume}% {icon}",
128                "format-bluetooth": "{volume}% {icon}",
129                "format-muted": "",
130                "format-icons": {
131                     "headphones": "",
132                     "handsfree": "",
133                     "headset": "",
134                     "phone": "",
135                     "portable": "",
136                     "car": "",
137                     "default": ["", ""]
138                },
139                "scroll-step": 1,
140                "on-click": "pavucontrol"
141           }
142

STYLE

144       ·   #pulseaudio
145       ·   #pulseaudio.bluetooth
146       ·   #pulseaudio.muted
147
148
149
150                                  2021-02-10              waybar-pulseaudio(5)