.\" Generated by scdoc 1.11.5
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "yambar\-modules\-pulse" "5" "2026\-09\-18"
.PP
.SH NAME
pulse \- Monitors a PulseAudio source and/or sink
.PP
.SH TAGS
.PP
.TS
allbox;l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
online
T}	T{
bool
T}	T{
True when connected to the PulseAudio server
T}
T{
sink_online
T}	T{
bool
T}	T{
True when the sink is present
T}
T{
source_online
T}	T{
bool
T}	T{
True when the source is present
T}
T{
sink_percent
T}	T{
range
T}	T{
Sink volume level, as a percentage
T}
T{
source_percent
T}	T{
range
T}	T{
Source volume level, as a percentage
T}
T{
sink_muted
T}	T{
bool
T}	T{
True if the sink is muted, otherwise false
T}
T{
source_muted
T}	T{
bool
T}	T{
True if the source is muted, otherwise false
T}
T{
sink_port
T}	T{
string
T}	T{
Description of the active sink port
T}
T{
source_port
T}	T{
string
T}	T{
Description of the active source port
T}
.TE
.sp 1
.SH CONFIGURATION
.PP
.TS
allbox;l l l lx
l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
sink
T}	T{
string
T}	T{
no
T}	T{
Name of sink to monitor (default: \fI@DEFAULT_SINK@\fR).\&
T}
T{
source
T}	T{
string
T}	T{
no
T}	T{
Name of source to monitor (default: \fI@DEFAULT_SOURCE@\fR).\&
T}
.TE
.sp 1
.SH EXAMPLES
.PP
.nf
.RS 4
bar:
  left:
    \- pulse:
	    content: 
		  string: {text: "{sink_percent}% ({sink_port})"}
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fByambar\-modules\fR(5), \fByambar\-particles\fR(5), \fByambar\-tags\fR(5), \fByambar\-decorations\fR(5)
.PP