yambar/doc/yambar-modules-alsa.5.scd
novakne 646ad0b0eb
doc: add empty line a the end of files
fix yambar-modules-sway
fix reference in *-xkb files
2021-02-23 16:25:29 +01:00

51 lines
779 B
Markdown

yambar-modules-alsa(5)
# NAME
alsa - Monitors an alsa soundcard for volume and mute/unmute changes
# TAGS
[[ *Name*
:[ *Type*
:[ *Description*
| volume
: range
: Volume level, with min and max as start and end range values
| percent
: range
: Volume level, as a percentage
| muted
: bool
: True if muted, otherwise false
# CONFIGURATION
[[ *Name*
:[ *Type*
:[ *Req*
:[ *Description*
| card
: string
: yes
: The soundcard name. _Default_ might work.
| mixer
: string
: yes
: Mixer channel to monitor. _Master_ might work.
# EXAMPLES
```
bar:
left:
- alsa:
card: hw:PCH
mixer: Master
content: {string: {text: "{volume}"}}
```
# SEE ALSO
*yambar-modules*(5), *yambar-particles*(5), *yambar-tags*(5), *yambar-decorations*(5)