.\" 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-wireplumber" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - WirePlumber module
.PP
.SH DESCRIPTION
.PP
The \fBwireplumber\fR module displays the current volume reported by WirePlumber.\&
.PP
.SH CONFIGURATION
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: \fB{volume}%\fR 
.br
	The format, how information should be displayed.\& This format is used when other formats aren'\&t specified.\&
.PP
\fBformat-muted\fR: 
.br
	typeof: string 
.br
	This format is used when the sound is muted.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: \fBtrue\fR 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	default: \fB{node_name}\fR 
.br
	The format of information displayed in the tooltip.\&
.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
\fBmax-volume\fR: 
.br
	typeof: float 
.br
	default: 100 
.br
	The maximum volume that can be set, in percentage.\&
.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{volume}\fR: Volume in percentage.\&
.PP
\fB{node_name}\fR: The node'\&s nickname as reported by WirePlumber (\fBnode.\&nick\fR property)
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"wireplumber": {
	"format": "{volume}%",
	"format-muted": "",
	"on-click": "helvum"
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#wireplumber\fR
.IP \(bu 4
\fB#wireplumber.\&muted\fR