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  │
13       │        │       │ device has success‐ │
14       │        │       │ fully been opened   │
15       ├────────┼───────┼─────────────────────┤
16       │volume  │ range │ Volume level, with  │
17       │        │       │ min and max as      │
18       │        │       │ start and end range │
19       │        │       │ values              │
20       ├────────┼───────┼─────────────────────┤
21       │percent │ range │ Volume level, as a  │
22       │        │       │ percentage          │
23       ├────────┼───────┼─────────────────────┤
24       │muted   │ bool  │ True if muted, oth‐ │
25       │        │       │ erwise false        │
26       └────────┴───────┴─────────────────────┘
27

CONFIGURATION

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

EXAMPLES

60           bar:
61             left:
62               - alsa:
63                   card: hw:PCH
64                   mixer: Master
65                   content: {string: {text: "{volume}"}}
66

SEE ALSO

68       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
69       tions(5)
70
71                                  2022-08-26            yambar-modules-alsa(5)
Impressum