.\" Generated by scdoc 1.11.3
.\" 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 "waybar-pulseaudio" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - pulseaudio module
.PP
.SH DESCRIPTION
.PP
The \fBpulseaudio\fR module displays the current volume reported by PulseAudio.\&
.PP
Additionally, you can control the volume by scrolling \fBup\fR or \fBdown\fR while the cursor is over the module.\&
.PP
.SH CONFIGURATION
.PP
\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.\&
.PP
\fBformat-bluetooth\fR: 
.br
	typeof: string 
.br
	This format is used when using bluetooth speakers.\&
.PP
\fBformat-muted\fR: 
.br
	typeof: string 
.br
	This format is used when the sound is muted.\&
.PP
\fBformat-source\fR: 
.br
	typeof: string 
.br
	default: {volume}% 
.br
	This format used for the source.\&
.PP
\fBformat-source-muted\fR: 
.br
	typeof: string 
.br
	This format is used when the source is muted.\&
.PP
\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.\&
.PP
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.PP
\fBstates\fR: 
.br
	typeof: object 
.br
	A number of volume states which get activated on certain volume levels.\& See \fBwaybar-states(5)\fR.\&
.PP
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.PP
\fBmin-length\fR: 
.br
	typeof: integer 
.br
	The minimum length in characters the module should accept.\&
.PP
\fBalign\fR: 
.br
	typeof: float 
.br
	The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned.\& If the module is rotated, it will follow the flow of the text.\&
.PP
\fBjustify\fR: 
.br
	typeof: string 
.br
	The alignment of the text within the module'\&s label, allowing options '\&left'\&, '\&right'\&, or '\&center'\& to define the positioning.\&
.PP
\fBscroll-step\fR: 
.br
	typeof: float 
.br
	default: 1.\&0 
.br
	The speed at which to change the volume when scrolling.\&
.PP
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.PP
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.PP
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right-click on the module.\&
.PP
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.PP
\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.\&
.PP
\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.\&
.PP
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.PP
\fBreverse-scrolling\fR: 
.br
	typeof: bool 
.br
	Option to reverse the scroll direction.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.PP
\fBmax-volume\fR: 
.br
	typeof: integer 
.br
	default: 100 
.br
	The maximum volume that can be set, in percentage.\&
.PP
\fBignored-sinks\fR: 
.br
	typeof: array 
.br
	Sinks in this list will not be shown as active sink by Waybar.\& Entries should be the sink'\&s description field.\&
.PP
\fBmenu\fR: 
.br
	typeof: string 
.br
	Action that popups the menu.\&
.PP
\fBmenu-file\fR: 
.br
	typeof: string 
.br
	Location of the menu descriptor file.\& There need to be an element of type
.RS 4
GtkMenu with id \fBmenu\fR
.PP
.RE
\fBmenu-actions\fR: 
.br
	typeof: array 
.br
	The actions corresponding to the buttons of the menu.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{desc}\fR: Pulseaudio port'\&s description, for bluetooth it'\&ll be the device name.\&
.PP
\fB{volume}\fR: Volume in percentage.\&
.PP
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR.\&
.PP
\fB{format_source}\fR: Source format, \fBformat-source\fR, \fBformat-source-muted\fR.\&
.PP
.SH ICONS:
.PP
The following strings for \fBformat-icons\fR are supported.\&
.PP
.PD 0
.IP \(bu 4
the device name
.PD
.PP
If they are found in the current PulseAudio port name, the corresponding icons will be selected.\&
.PP
.PD 0
.IP \(bu 4
\fBdefault\fR (Shown, when no other port is found)
.IP \(bu 4
\fBheadphone\fR
.IP \(bu 4
\fBspeaker\fR
.IP \(bu 4
\fBhdmi\fR
.IP \(bu 4
\fBheadset\fR
.IP \(bu 4
\fBhands-free\fR
.IP \(bu 4
\fBportable\fR
.IP \(bu 4
\fBcar\fR
.IP \(bu 4
\fBhifi\fR
.IP \(bu 4
\fBphone\fR
.PD
.PP
Additionally, suffixing a device name or port with \fB-muted\fR will cause the icon
to be selected when the corresponding audio device is muted.\& This applies to \fBdefault\fR as well.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"pulseaudio": {
	"format": "{volume}% {icon}",
	"format-bluetooth": "{volume}% {icon}",
	"format-muted": "",
	"format-icons": {
		"alsa_output\&.pci-0000_00_1f\&.3\&.analog-stereo": "",
		"alsa_output\&.pci-0000_00_1f\&.3\&.analog-stereo-muted": "",
		"headphones": "",
		"handsfree": "",
		"headset": "",
		"phone": "",
		"phone-muted": "",
		"portable": "",
		"car": "",
		"default": ["", ""]
	},
	"scroll-step": 1,
	"on-click": "pavucontrol"
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#pulseaudio\fR
.IP \(bu 4
\fB#pulseaudio.\&bluetooth\fR
.IP \(bu 4
\fB#pulseaudio.\&muted\fR