mirror of
https://codeberg.org/dnkl/yambar.git
synced 2025-04-22 12:25:38 +02:00
README: document the alsa module
This commit is contained in:
parent
a5980cd3d3
commit
b99e3d8ea2
1 changed files with 28 additions and 1 deletions
29
README.md
29
README.md
|
@ -135,7 +135,6 @@ The value of each item in the `left`, `center` and `right` lists is a _module_.
|
|||
- [xwindow](#xwindow)
|
||||
|
||||
|
||||
### Alsae
|
||||
### Generic Configuration
|
||||
|
||||
**All** modules support the following attributes:
|
||||
|
@ -146,6 +145,34 @@ The value of each item in the `left`, `center` and `right` lists is a _module_.
|
|||
| anchors | dict | Free-to-use dictionary, where you can put yaml anchor definitions
|
||||
|
||||
|
||||
### 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
|
||||
| muted | bool | True if muted
|
||||
|
||||
|
||||
#### Configuration
|
||||
|
||||
| Name | Type | Req. | Description
|
||||
|---------------|--------|------|------------
|
||||
| card | string | yes | The soundcard name. _Default_ might work.
|
||||
| mixer | String | yes | Mixer channel to watch. _Master_ might work.
|
||||
|
||||
|
||||
#### Example
|
||||
|
||||
alsa:
|
||||
card: hw:PCH
|
||||
mixer: Master
|
||||
content: {string: {text: "{volume}"}}
|
||||
|
||||
|
||||
### Backlight
|
||||
### Battery
|
||||
### Clock
|
||||
|
|
Loading…
Add table
Reference in a new issue