1yambar-modules-alsa(5)        File Formats Manual       yambar-modules-alsa(5)
2
3
4

NAME

6       alsa - Monitors an alsa soundcard for volume and mute/unmute changes
7

TAGS

9       ┌────────┬───────┬─────────────────────────────────────────────────────┐
10Name    Type  Description                                         
11       ├────────┼───────┼─────────────────────────────────────────────────────┤
12       │online  │ bool  │ True when the ALSA device has successfully been     │
13       │        │       │ opened                                              │
14       ├────────┼───────┼─────────────────────────────────────────────────────┤
15       │dB      │ range │ Volume level (in dB), with min and max as start and │
16       │        │       │ end range values.                                   │
17       ├────────┼───────┼─────────────────────────────────────────────────────┤
18       │volume  │ range │ Volume level (raw), with min and max as start and   │
19       │        │       │ end range values                                    │
20       ├────────┼───────┼─────────────────────────────────────────────────────┤
21       │percent │ range │ Volume level, as a percentage. This value is based  │
22       │        │       │ on the dB tag if available, otherwise the volume    
23       │        │       │ tag.                                                │
24       ├────────┼───────┼─────────────────────────────────────────────────────┤
25       │muted   │ bool  │ True if muted, otherwise false                      │
26       └────────┴───────┴─────────────────────────────────────────────────────┘
27

CONFIGURATION

29       ┌───────┬────────┬─────┬───────────────────────────────────────────────┐
30Name   Type   Req Description                                   
31       ├───────┼────────┼─────┼───────────────────────────────────────────────┤
32       │card   │ string │ yes │ The soundcard name. default might work.       │
33       ├───────┼────────┼─────┼───────────────────────────────────────────────┤
34       │mixer  │ string │ yes │ Mixer channel to monitor. Master might work.  │
35       ├───────┼────────┼─────┼───────────────────────────────────────────────┤
36       │volume │ string │ no  │ The name of the channel to use as source for  │
37       │       │        │     │ the volume level (default: first available    │
38       │       │        │     │ channel, usually "Front Left").               │
39       ├───────┼────────┼─────┼───────────────────────────────────────────────┤
40       │muted  │ string │ no  │ The name of the channel to use as source for  │
41       │       │        │     │ the muted state (default: first available     │
42       │       │        │     │ channel, usually "Front Left").               │
43       └───────┴────────┴─────┴───────────────────────────────────────────────┘
44

EXAMPLES

46           bar:
47             left:
48               - alsa:
49                   card: hw:PCH
50                   mixer: Master
51                   content: {string: {text: "{volume}"}}
52

SEE ALSO

54       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
55       tions(5)
56
57                                  2023-07-14            yambar-modules-alsa(5)
Impressum