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

NAME

6       pulse - Monitors a PulseAudio source and/or sink
7

TAGS

9       ┌───────────────┬────────┬─────────────────────────────────────────────┐
10       │Name           │ Type   │ Description                                 │
11       ├───────────────┼────────┼─────────────────────────────────────────────┤
12       │online         │ bool   │ True when connected to the PulseAudio       │
13       │               │        │ server                                      │
14       ├───────────────┼────────┼─────────────────────────────────────────────┤
15       │sink_online    │ bool   │ True when the sink is present               │
16       ├───────────────┼────────┼─────────────────────────────────────────────┤
17       │source_online  │ bool   │ True when the source is present             │
18       ├───────────────┼────────┼─────────────────────────────────────────────┤
19       │sink_percent   │ range  │ Sink volume level, as a percentage          │
20       ├───────────────┼────────┼─────────────────────────────────────────────┤
21       │source_percent │ range  │ Source volume level, as a percentage        │
22       ├───────────────┼────────┼─────────────────────────────────────────────┤
23       │sink_muted     │ bool   │ True if the sink is muted, otherwise false  │
24       ├───────────────┼────────┼─────────────────────────────────────────────┤
25       │source_muted   │ bool   │ True if the source is muted, otherwise      │
26       │               │        │ false                                       │
27       ├───────────────┼────────┼─────────────────────────────────────────────┤
28       │sink_port      │ string │ Description of the active sink port         │
29       ├───────────────┼────────┼─────────────────────────────────────────────┤
30       │source_port    │ string │ Description of the active source port       │
31       └───────────────┴────────┴─────────────────────────────────────────────┘
32

CONFIGURATION

34       ┌───────┬────────┬─────┬───────────────────────────────────────────────┐
35       │Name   │ Type   │ Req │ Description                                   │
36       ├───────┼────────┼─────┼───────────────────────────────────────────────┤
37       │sink   │ string │ no  │ Name of sink to monitor (default: @DE‐        │
38       │       │        │     │ FAULT_SINK@).                                 │
39       ├───────┼────────┼─────┼───────────────────────────────────────────────┤
40       │source │ string │ no  │ Name of source to monitor (default: @DE‐      │
41       │       │        │     │ FAULT_SOURCE@).                               │
42       └───────┴────────┴─────┴───────────────────────────────────────────────┘
43

EXAMPLES

45           bar:
46             left:
47               - pulse:
48                    content:
49                       string: {text: "{sink_percent}% ({sink_port})"}
50

SEE ALSO

52       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
53       tions(5)
54
55                                  2023-07-22           yambar-modules-pulse(5)
Impressum