Alex
1afb1a5229
Sync man pages with the code for options that were read but undocumented: - sway/workspaces: ignore-workspaces - niri/workspaces: sort-by-number, hide-empty - wayfire/workspaces: disable-scroll, enable-bar-scroll - river/tags: set-tags, toggle-tags - hyprland/workspaces: persistent-workspaces (formalized) - hyprland/window: fallback, tooltip-format - cpu: format-<state>, tooltip-format, tooltip-format-<state> - pulseaudio/slider: ignored-sinks - hyprland/niri/mango language: format-<lang>-<variant> (+ hyprland tooltip variant)
126 lines
2.9 KiB
Scdoc
126 lines
2.9 KiB
Scdoc
waybar-pulseaudio-slider(5)
|
|
|
|
# NAME
|
|
|
|
waybar - pulseaudio slider module
|
|
|
|
# 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
|
|
|
|
*min*: ++
|
|
typeof: int ++
|
|
default: 0 ++
|
|
The minimum volume value the slider should display and set.
|
|
|
|
*max*: ++
|
|
typeof: int ++
|
|
default: 100 ++
|
|
The maximum volume value the slider should display and set.
|
|
|
|
*orientation*: ++
|
|
typeof: string ++
|
|
default: horizontal ++
|
|
The orientation of the slider. Can be either `horizontal` or `vertical`.
|
|
|
|
*expand*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Enables this module to consume all left over space dynamically.
|
|
|
|
*zero-on-mute*: ++
|
|
typeof: bool ++
|
|
default: 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*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Specifies whether to unmute a muted souce/sink when its volume is changed by the user moving the slider.
|
|
|
|
*target*: ++
|
|
typeof: string ++
|
|
default: sink ++
|
|
The audio target to control. Can be either `sink` (output/speakers) or `source` (input/microphone).
|
|
|
|
*ignored-sinks*: ++
|
|
typeof: array ++
|
|
default: empty ++
|
|
A list of sink descriptions to ignore when tracking the default sink, so switching to those sinks does not update the slider.
|
|
|
|
# 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
|
|
|
|
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;
|
|
}
|
|
```
|