waybar/man/waybar-pulseaudio.5.scd

169 lines
3.8 KiB
Plaintext
Raw Permalink Normal View History

2019-08-26 18:50:16 +02:00
waybar-pulseaudio(5)
# NAME
waybar - pulseaudio module
# DESCRIPTION
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.
# CONFIGURATION
*format*: ++
typeof: string ++
default: {volume}% ++
The format, how information should be displayed. This format is used when other formats aren't specified.
*format-bluetooth*: ++
typeof: string ++
This format is used when using bluetooth speakers.
*format-muted*: ++
typeof: string ++
This format is used when the sound is muted.
*format-source*: ++
typeof: string ++
default: {volume}% ++
This format used for the source.
*format-source-muted*: ++
typeof: string ++
This format is used when the source is muted.
*format-icons*: ++
typeof: array ++
2019-09-03 11:34:12 +02:00
Based on the current port-name and volume, the corresponding icon gets selected. The order is *low* to *high*. See *Icons*.
2019-08-26 18:50:16 +02:00
*rotate*: ++
typeof: integer ++
Positive value to rotate the text label.
*states*: ++
2022-11-07 08:30:01 +01:00
typeof: object ++
A number of volume states which get activated on certain volume levels. See *waybar-states(5)*.
2019-08-26 18:50:16 +02:00
*max-length*: ++
typeof: integer ++
The maximum length in character the module should display.
2021-02-01 17:34:51 +01:00
*min-length*: ++
2023-06-06 11:01:25 +02:00
typeof: integer ++
The minimum length in characters the module should take up.
2021-02-01 17:34:51 +01:00
*align*: ++
2023-06-06 11:01:25 +02:00
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.
2021-02-01 17:34:51 +01:00
2019-08-26 18:50:16 +02:00
*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.
2019-12-29 05:21:59 +01:00
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2019-08-26 18:50:16 +02:00
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
2020-04-12 18:35:41 +02:00
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
2019-08-26 18:50:16 +02:00
*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.
*smooth-scrolling-threshold*: ++
typeof: double ++
Threshold to be used when scrolling.
*reverse-scrolling*: ++
typeof: bool ++
Option to reverse the scroll direction.
2019-08-26 18:50:16 +02:00
*tooltip*: ++
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
*max-volume*: ++
typeof: integer ++
default: 100 ++
The maximum volume that can be set, in percentage.
*ignored-sinks*: ++
typeof: array ++
Sinks in this list will not be shown as the active sink by Waybar. Entries should be the sink's description field.
2019-08-26 18:50:16 +02:00
# FORMAT REPLACEMENTS
*{desc}*: Pulseaudio port's description, for bluetooth it'll be the device name.
2019-08-26 18:50:16 +02:00
*{volume}*: Volume in percentage.
2019-09-03 11:34:12 +02:00
*{icon}*: Icon, as defined in *format-icons*.
2019-08-26 18:50:16 +02:00
2019-09-03 11:34:12 +02:00
*{format_source}*: Source format, *format-source*, *format-source-muted*.
2019-08-26 18:50:16 +02:00
# ICONS:
2019-09-03 11:34:12 +02:00
The following strings for *format-icons* are supported.
2021-07-15 08:52:02 +02:00
- the device name
2019-08-26 18:50:16 +02:00
If they are found in the current PulseAudio port name, the corresponding icons will be selected.
- *default* (Shown, when no other port is found)
2020-02-04 12:16:50 +01:00
- *headphone*
2019-08-26 18:50:16 +02:00
- *speaker*
- *hdmi*
- *headset*
2020-02-04 12:16:50 +01:00
- *hands-free*
2019-08-26 18:50:16 +02:00
- *portable*
- *car*
- *hifi*
- *phone*
2020-02-04 12:16:50 +01:00
2019-08-26 18:50:16 +02:00
# EXAMPLES
```
"pulseaudio": {
"format": "{volume}% {icon}",
"format-bluetooth": "{volume}% {icon}",
"format-muted": "",
"format-icons": {
2021-07-15 08:52:02 +02:00
"alsa_output.pci-0000_00_1f.3.analog-stereo": "",
2019-08-26 18:50:16 +02:00
"headphones": "",
"handsfree": "",
"headset": "",
"phone": "",
"portable": "",
"car": "",
"default": ["", ""]
},
"scroll-step": 1,
"on-click": "pavucontrol"
}
```
# STYLE
- *#pulseaudio*
- *#pulseaudio.bluetooth*
- *#pulseaudio.muted*