Document new wireplumber module functionality

This commit is contained in:
Evyatar Stalinsky 2023-06-06 11:44:17 +03:00
parent e397f568b7
commit d61b1d54de
1 changed files with 47 additions and 29 deletions

View File

@ -49,6 +49,11 @@ The *wireplumber* module displays the current volume reported by WirePlumber.
typeof: float ++
The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
*scroll-step*: ++
typeof: float ++
default: 1.0 ++
The speed in which to change the volume when scrolling.
*on-click*: ++
typeof: string ++
Command to execute when clicked on the module.
@ -65,6 +70,19 @@ The *wireplumber* module displays the current volume reported by WirePlumber.
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.
*on-scroll-down*: ++
typeof: string ++
Command to execute when scrolling down on the module. This replaces the default behaviour of volume control.
*max-volume*: ++
typeof: float ++
default: 100 ++
The maximum volume that can be set, in percentage.
# FORMAT REPLACEMENTS
*{volume}*: Volume in percentage.