2020-09-06 14:44:13 -03:00
waybar-sndio(5)
# NAME
waybar - sndio module
# DESCRIPTION
The * sndio * module displays the current volume reported by sndio(7).
Additionally, you can control the volume by scrolling * up * or * down * while the
cursor is over the module, and clicking on the module toggles mute.
# CONFIGURATION
* format * : ++
typeof: string ++
default: {volume}% ++
The format for how information should be displayed.
* rotate * : ++
typeof: integer ++
2024-09-08 13:33:52 +02:00
Positive value to rotate the text label (in 90 degree increments).
2020-09-06 14:44:13 -03:00
* max-length * : ++
typeof: integer ++
The maximum length in character the module should display.
2021-02-01 08:34:51 -08:00
* min-length * : ++
2023-07-30 17:33:02 +02:00
typeof: integer ++
2023-10-21 21:15:25 +05:30
The minimum length in characters the module should accept.
2021-02-01 08:34:51 -08:00
* align * : ++
2023-07-30 17:33:02 +02:00
typeof: float ++
2024-03-04 20:00:57 +01:00
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.
2021-02-01 08:34:51 -08:00
2020-09-06 14:44:13 -03:00
* scroll-step * : ++
typeof: int ++
default: 5 ++
2023-10-21 21:15:25 +05:30
The speed at which to change the volume when scrolling.
2020-09-06 14:44:13 -03:00
* on-click * : ++
typeof: string ++
Command to execute when clicked on the module.
This replaces the default behaviour of toggling mute.
* on-click-middle * : ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
* on-click-right * : ++
typeof: string ++
2023-10-21 21:15:25 +05:30
Command to execute when you right-click on the module.
2020-09-06 14:44:13 -03:00
* on-update * : ++
typeof: string ++
Command to execute when the module is updated.
* on-scroll-up * : ++
typeof: string ++
2023-07-30 17:33:02 +02:00
Command to execute when scrolling up on the module. ++
2020-09-06 14:44:13 -03:00
This replaces the default behaviour of volume control.
* on-scroll-down * : ++
typeof: string ++
2023-07-30 17:33:02 +02:00
Command to execute when scrolling down on the module. ++
2020-09-06 14:44:13 -03:00
This replaces the default behaviour of volume control.
* smooth-scrolling-threshold * : ++
typeof: double ++
Threshold to be used when scrolling.
2024-05-28 20:42:12 +02:00
* 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.
2024-10-30 17:04:13 +01:00
* expand * : ++
typeof: bool ++
default: false ++
Enables this module to consume all left over space dynamically.
2020-09-06 14:44:13 -03:00
# FORMAT REPLACEMENTS
* {volume} * : Volume in percentage.
* {raw_value} * : Volume as value reported by sndio.
# EXAMPLES
```
"sndio": {
2023-07-30 17:33:02 +02:00
"format": "{raw_value} 🎜",
"scroll-step": 3
2020-09-06 14:44:13 -03:00
}
```
# STYLE
- * #sndio *
- * #sndio.muted *
