external/yambar
1
0
Fork 1
mirror of https://codeberg.org/dnkl/yambar.git synced 2025-04-22 20:25:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: document the alsa module

Browse source
This commit is contained in:
Daniel Eklöf 2019-01-21 19:58:17 +01:00
parent a5980cd3d3
commit b99e3d8ea2
1 changed files with 28 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -135,7 +135,6 @@ The value of each item in the `left`, `center` and `right` lists is a _module_.
- [xwindow](#xwindow) - [xwindow](#xwindow)
### Alsae
### Generic Configuration ### Generic Configuration
**All** modules support the following attributes: **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 | 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 ### Backlight
### Battery ### Battery
### Clock ### Clock