.\" Generated by scdoc 1.10.0
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "waybar-pulseaudio" "5" "2019-12-31"
.P
.SH NAME
.P
waybar - pulseaudio module
.P
.SH DESCRIPTION
.P
The \fBpulseaudio\fR module displays the current volume reported by PulseAudio.
.P
Additionally you can control the volume by scrolling \fBup\fR or \fBdown\fR while the cursor is over the module.
.P
.SH CONFIGURATION
.P
\fBformat\fR: 
.br
	typeof: string  
.br
	default: {volume}% 
.br
	The format, how information should be displayed. This format is used when other formats aren't specified.
.P
\fBformat-bluetooth\fR: 
.br
	typeof: string 
.br
	This format is used when using bluetooth speakers.
.P
\fBformat-muted\fR: 
.br
	typeof: string 
.br
	This format is used when the sound is muted.
.P
\fBformat-source\fR: 
.br
	typeof: string 
.br
	default: {volume}% 
.br
	This format used for the source.
.P
\fBformat-source-muted\fR: 
.br
	typeof: string 
.br
	This format is used when the source is muted.
.P
\fBformat-icons\fR: 
.br
	typeof: array 
.br
	Based on the current port-name and volume, the corresponding icon gets selected. The order is \fBlow\fR to \fBhigh\fR. See \fBIcons\fR.
.P
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.
.P
\fBstates\fR: 
.br
	typeof: array 
.br
	A number of volume states which get activated on certain volume levels. See \fBwaybar-states(5)\fR
.P
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.
.P
\fBscroll-step\fR: 
.br
	typeof: float 
.br
	default: 1.0 
.br
	The speed in which to change the volume when scrolling.
.P
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.
.P
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right clicked on the module.
.P
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module. This replaces the default behaviour of volume control.
.P
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module. This replaces the default behaviour of volume control.
.P
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.
.P
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.
.P
.SH FORMAT REPLACEMENTS
.P
\fB{desc}\fR: Pulseaudio port's description, for bluetooth it'll be the device name.
.P
\fB{volume}\fR: Volume in percentage.
.P
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR.
.P
\fB{format_source}\fR: Source format, \fBformat-source\fR, \fBformat-source-muted\fR.
.P
.SH ICONS:
.P
The following strings for \fBformat-icons\fR are supported.
If they are found in the current PulseAudio port name, the corresponding icons will be selected.
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBdefault\fR (Shown, when no other port is found)
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBheadphones\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBspeaker\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBhdmi\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBheadset\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBhandsfree\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBportable\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBcar\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBhifi\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBphone\fR

.RE
.P
.SH EXAMPLES
.P
.nf
.RS 4
"pulseaudio": {
	"format": "{volume}% {icon}",
	"format-bluetooth": "{volume}% {icon}",
	"format-muted": "",
	"format-icons": {
		"headphones": "",
		"handsfree": "",
		"headset": "",
		"phone": "",
		"portable": "",
		"car": "",
		"default": ["", ""]
	},
	"scroll-step": 1,
	"on-click": "pavucontrol"
}
.fi
.RE
.P
.SH STYLE
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#pulseaudio\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#pulseaudio.bluetooth\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#pulseaudio.muted\fR
.RE