Module: PulseAudio Slider

Note

This page is auto-generated from man/waybar-pulseaudio-slider.5.scd on the master branch. Do not edit it here — changes will be overwritten on the next sync. To update it, edit the man page(s) and open a PR.

DESCRIPTION

The pulseaudio slider module displays and controls the current volume of the default sink or source as a bar.

The volume can be controlled by dragging the slider across the bar or clicking on a specific position.

CONFIGURATION

Option	Typeof	Default	Description
min	int	0	The minimum volume value the slider should display and set.
max	int	100	The maximum volume value the slider should display and set.
target	string	sink	Whether the slider will control the default audio source or default audio sink. Valid values are either "sink" or "source".
orientation	string	horizontal	The orientation of the slider. Can be either `horizontal` or `vertical`.
expand	bool	false	Enables this module to consume all left over space dynamically.
zero-on-mute	bool	true	`true` = The slider will be set to `min` when the source/sink is muted. `false` = The slider will continue to show the unmuted volume level when the source/sink is muted.
unmute-on-volume-change	bool	true	Specifies whether to unmute a muted souce/sink when its volume is changed by the user moving the slider.
target	string	sink	The audio target to control. Can be either `sink` (output/speakers) or `source` (input/microphone).
ignored-sinks	array	empty	A list of sink descriptions to ignore when tracking the default sink, so switching to those sinks does not update the slider.
sink-mapping	object		Sinks named by the values of this mapping will be considered to be the current sink instead of the sinks named by the respective keys.

EXAMPLES

"modules-right": [
    "pulseaudio/slider#out",
    "pulseaudio/slider#in",
],
"pulseaudio/slider#out": {
    "min": 0,
    "max": 100,
    "orientation": "horizontal",
    "zero-on-mute": false,
    "unmute-on-volume-change": false
},
"pulseaudio/slider#in": {
    "min": 0,
    "max": 100,
    "orientation": "horizontal",
    "target": "source"
}

STYLE

Unlike most modules, the slider modules require styling to display correctly. In particular you need to set min-width and/or min-height (depending on whether the slider is vertical or horizontal) on the trough node, otherwise the slider renders too small to be usable. This is a GTK detail, not a Waybar issue.

The slider is a component with multiple CSS Nodes, of which the following are exposed:

#pulseaudio-slider:
Controls the style of the box around the slider and bar.

#pulseaudio-slider.muted:
Controls the style when the audio source/sink is muted.

#pulseaudio-slider slider:
Controls the style of the slider handle.

#pulseaudio-slider trough:
Controls the style of the part of the bar that has not been filled.

#pulseaudio-slider highlight:
Controls the style of the part of the bar that has been filled.

STYLE EXAMPLE

#pulseaudio-slider slider {
    min-height: 0px;
    min-width: 0px;
    opacity: 0;
    background-image: none;
    border: none;
    box-shadow: none;
}

#pulseaudio-slider trough {
    min-height: 80px;
    min-width: 10px;
    border-radius: 5px;
    background: black;
}

#pulseaudio-slider highlight {
    min-width: 10px;
    border-radius: 5px;
    background: green;
}

#pulseaudio-slider.muted highlight {
    background-color: orange;
}