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-scroll-up:
76            typeof: string
77            Command to execute when scrolling up on the module. This replaces
78       the default behaviour of volume control.
79
80       on-scroll-down:
81            typeof: string
82            Command to execute when scrolling down on the module. This
83       replaces the default behaviour of volume control.
84
85       smooth-scrolling-threshold:
86            typeof: double
87            Threshold to be used when scrolling.
88
89       tooltip:
90            typeof: bool
91            default: true
92            Option to disable tooltip on hover.
93

FORMAT REPLACEMENTS

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

ICONS:

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

EXAMPLES

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

STYLE

140       ·   #pulseaudio
141       ·   #pulseaudio.bluetooth
142       ·   #pulseaudio.muted
143
144
145
146                                  2020-04-11              waybar-pulseaudio(5)
Impressum