yambar-modules-pulse(5)

yambar-modules-pulse5

Monitors a pulseaudio source and/or sink

Tags

NameTypeDescription
onlineboolTrue when connected to the PulseAudio server
sink_onlineboolTrue when the sink is present
source_onlineboolTrue when the source is present
sink_percentrangeSink volume level, as a percentage
source_percentrangeSource volume level, as a percentage
sink_mutedboolTrue if the sink is muted, otherwise false
source_mutedboolTrue if the source is muted, otherwise false
sink_portstringDescription of the active sink port
source_portstringDescription of the active source port

Configuration

NameTypeReqDescription
sinkstringnoName of sink to monitor (default: @DEFAULT_SINK@).
sourcestringnoName of source to monitor (default: @DEFAULT_SOURCE@).

Examples

bar:
  left:
    - pulse:
	    content: 
		  string: {text: "{sink_percent}% ({sink_port})"}

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

From yambar 1.11.0-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.