waybar-pulseaudio(5)

✨ NAME ✨

waybar-pulseaudio — bestie, this is the pulseaudio module of waybar, and it's serving cunt while reporting your volume 💖👑

---

🫶 DESCRIPTION 🫶

okay so. the pulseaudio module displays the current volume that PulseAudio is reporting. that's the whole gig. it just sits there in your bar looking cute and telling you how loud you're being. 🎀

and ALSO — plot twist, keep up — you can control the volume by scrolling up or down while the cursor is over the module. yes bestie, your scroll wheel is a volume knob now. slay. 🖱️✨

---

💅 CONFIGURATION 💅

every option, all of them, no skips, we're doing this properly:

• format — typeof: string, default: {volume}% — the format, like, how the info should actually be displayed. this one's the fallback format: it gets used whenever no other format is specified. 🌸
• format-bluetooth — typeof: string — this format is used when you're on bluetooth speakers. bluetooth girlies, this one's for you 💙
• format-muted — typeof: string — this format is used when the sound is muted. 🤫
• format-source — typeof: string, default: {volume}% — this format is used for the source.
• format-source-muted — typeof: string — this format is used when the source is muted.
• format-icons — typeof: array — based on the current port name and volume, the corresponding icon gets selected. the order goes low to high. see Icons below 👀
• rotate — typeof: integer — positive value to rotate the text label (in 90 degree increments). only positive, no spinning backwards, that's the rule 📐
• 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. crank it for chaos 🌀
• 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. so if you set it, no more free volume knob, it's your command now periodt.
• on-scroll-down — typeof: string — command to execute when scrolling down on the module. ⚠️ also replaces the default behaviour of volume control. same deal bestie.
• smooth-scrolling-threshold — typeof: double — threshold to be used when scrolling.
• reverse-scrolling — typeof: bool — option to reverse the scroll direction for touchpads.
• reverse-mouse-scrolling — typeof: bool — option to reverse the scroll direction for mice. 🐭
• tooltip — typeof: bool, default: true — option to disable tooltip on hover.
• max-volume — typeof: integer, default: 100 — the maximum volume that can be set, in percentage. 📈
• ignored-sinks — typeof: array — sinks in this list will not be shown as active sink by Waybar. entries should be the sink's description field.
• 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.
• expand — typeof: bool, default: false — enables this module to consume all left over space dynamically. greedy little module, love that for it 🫶

---

🌈 FORMAT REPLACEMENTS 🌈

these are the lil placeholders you can drop into your formats:

• {desc} — Pulseaudio port's description; for bluetooth it'll be the device name.
• {volume} — volume in percentage.
• {icon} — icon, as defined in format-icons.
• {format_source} — source format, format-source, format-source-muted.

---

🦋 ICONS 🦋

the following strings for format-icons are supported.

• the device name

if they are found in the current PulseAudio port name, the corresponding icons will be selected. ✨

• default (shown, when no other port is found)
• headphone
• speaker
• hdmi
• headset
• hands-free
• portable
• car
• hifi
• phone

additionally, suffixing a device name or port with -muted will cause the icon to be selected when the corresponding audio device is muted. this applies to default as well. so yes, you can have a muted-default icon too, iconic 🌸

---

💅 EXAMPLES 💅

look at this config, it ate:

    "pulseaudio": {
        "format": "{volume}% {icon}",
        "format-bluetooth": "{volume}% {icon}",
        "format-muted": "",
        "format-icons": {
            "alsa_output.pci-0000_00_1f.3.analog-stereo": "",
            "alsa_output.pci-0000_00_1f.3.analog-stereo-muted": "",
            "headphone": "",
            "hands-free": "",
            "headset": "",
            "phone": "",
            "phone-muted": "",
            "portable": "",
            "car": "",
            "default": ["", ""]
        },
        "scroll-step": 1,
        "on-click": "pavucontrol"
    }

ngl some of those strings look empty in a terminal — that's just icon glyphs doing their shy lil thing. the config is exactly as written up there, don't come for me 🙈

---

⭐ STYLE ⭐

these are the CSS selectors you get to play with, go off:

• #pulseaudio
• #pulseaudio.bluetooth
• #pulseaudio.muted

---

and that's the whole page bestie 💖 this was waybar-pulseaudio(5), from waybar's File Formats Manual, dated 2026-02-08. now go crank your volume responsibly. mwah 🎀🦋✨