Module: PulseAudio

The pulseaudio module displays the current volume reported by PulseAudio.

Additionally you can control the volume by scrolling up or down while the cursor is over the module.

Config

option	typeof	default	description
format	string	{volume}%	The format, how information should be displayed. This format is used when other formats aren't specified.
format-bluetooth	string		This format is used when using bluetooth speakers.
format-muted	string		This format is used when the sound is muted.
format-icons	array		Based on the current port-name and volume, the corresponding icon gets selected. The order is low to high. See Icons
max-length	integer		The maximum length in character the module should display.
scroll-step	integer	1	The speed in which to change the volume when scrolling.
on-click	string		Command to execute when clicked on the module.
on-click-right	string		Command to execute when you right clicked on the module.
on-scroll-up	string		Command to execute when scrolling up on the module. This replaces the default beaviour of volume control.
on-scroll-down	string		Command to execute when scrolling down on the module. This replaces the default beaviour of volume control.

Format replacements:

string	replacement
{volume}	Volume in percentage
{icon}	Icon, as defined in format-icons.

Icons:

The folowing strings for format-icons are supported. If they are found in the current PulseAudio port name, the corresponding icons will be selected.

string	note
default	Will be shown, when no other port is found.
headphones
speaker
hdmi
headset
handsfree
portable
car
hifi
phone

Example:

"pulseaudio": {
    "format": "{volume}% {icon}",
    "format-bluetooth": "{volume}% {icon}",
    "format-muted": "",
    "format-icons": {
        "headphones": "",
        "handsfree": "",
        "headset": "",
        "phone": "",
        "portable": "",
        "car": "",
        "default": ["", ""]
    },
    "scroll-step": 1,
    "on-click": "pavucontrol"
}

Style

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