.\" Generated by scdoc 1.11.2
.\" 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-alsa" "5" "2022-12-17"
.P
.SH NAME
alsa - Monitors an alsa soundcard for volume and mute/unmute changes
.P
.SH TAGS
.P
.TS
allbox;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 the ALSA device has successfully been opened
T}
T{
dB
T}	T{
range
T}	T{
Volume level (in dB), with min and max as start and end range values.\&
T}
T{
volume
T}	T{
range
T}	T{
Volume level (raw), with min and max as start and end range values
T}
T{
percent
T}	T{
range
T}	T{
Volume level, as a percentage.\& This value is based on the \fBdB\fR tag if available, otherwise the \fBvolume\fR tag.\&
T}
T{
muted
T}	T{
bool
T}	T{
True if muted, otherwise false
T}
.TE
.sp 1
.P
.SH CONFIGURATION
.P
.TS
allbox;l l l lx
l l l lx
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{
card
T}	T{
string
T}	T{
yes
T}	T{
The soundcard name.\& \fBdefault\fR might work.\&
T}
T{
mixer
T}	T{
string
T}	T{
yes
T}	T{
Mixer channel to monitor.\& \fIMaster\fR might work.\&
T}
T{
volume
T}	T{
string
T}	T{
no
T}	T{
The name of the channel to use as source for the volume level (default: first available channel, usually "Front Left").\&
T}
T{
muted
T}	T{
string
T}	T{
no
T}	T{
The name of the channel to use as source for the muted state (default: first available channel, usually "Front Left").\&
T}
.TE
.sp 1
.P
.SH EXAMPLES
.P
.nf
.RS 4
bar:
  left:
    - alsa:
        card: hw:PCH
        mixer: Master
        content: {string: {text: "{volume}"}}
.fi
.RE
.P
.SH SEE ALSO
.P
\fByambar-modules\fR(5), \fByambar-particles\fR(5), \fByambar-tags\fR(5), \fByambar-decorations\fR(5)
.P