modules: add pulse

The pulse module shows information about PulseAudio sinks and sources.

doc/meson.build

@@ -10,6 +10,7 @@ foreach man_src : ['yambar.1.scd', 'yambar.5.scd', 'yambar-decorations.5.scd',
                    'yambar-modules-foreign-toplevel.5.scd',
                    'yambar-modules-i3.5.scd', 'yambar-modules-label.5.scd',
                    'yambar-modules-mpd.5.scd', 'yambar-modules-network.5.scd',
+                   'yambar-modules-pulse.5.scd',
                    'yambar-modules-removables.5.scd', 'yambar-modules-river.5.scd',
                    'yambar-modules-script.5.scd', 'yambar-modules-sway-xkb.5.scd',
                    'yambar-modules-sway.5.scd', 'yambar-modules-xkb.5.scd',

doc/yambar-modules-pulse.5.scd

@@ -0,0 +1,67 @@
+yambar-modules-pulse(5)
+
+# NAME
+pulse - Monitors a PulseAudio source and/or sink
+
+# TAGS
+
+[[ *Name*
+:[ *Type*
+:[ *Description*
+|  online
+:  bool
+:  True when connected to the PulseAudio server
+|  sink_online
+:  bool
+:  True when the sink is present
+|  source_online
+:  bool
+:  True when the source is present
+|  sink_percent
+:  range
+:  Sink volume level, as a percentage
+|  source_percent
+:  range
+:  Source volume level, as a percentage
+|  sink_muted
+:  bool
+:  True if the sink is muted, otherwise false
+|  source_muted
+:  bool
+:  True if the source is muted, otherwise false
+|  sink_port
+:  string
+:  Description of the active sink port
+|  source_port
+:  string
+:  Description of the active source port
+
+# CONFIGURATION
+
+[[ *Name*
+:[ *Type*
+:[ *Req*
+:[ *Description*
+|  sink
+:  string
+:  no
+:  Name of sink to monitor (default: _@DEFAULT\_SINK@_).
+|  source
+:  string
+:  no
+:  Name of source to monitor (default: _@DEFAULT\_SOURCE@_).
+
+# EXAMPLES
+
+```
+bar:
+  left:
+    - pulse:
+	    content: 
+		  string: {text: "{sink_percent}% ({sink_port})"}
+```
+
+# SEE ALSO
+
+*yambar-modules*(5), *yambar-particles*(5), *yambar-tags*(5), *yambar-decorations*(5)
+

doc/yambar-modules.5.scd

@@ -150,6 +150,8 @@ Available modules have their own pages:
 
 *yambar-modules-network*(5)
 
+*yambar-modules-pulse*(5)
+
 *yambar-modules-removables*(5)
 
 *yambar-modules-river*(5)