.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Audio::MPD::Common::Status 3pm"
.TH Audio::MPD::Common::Status 3pm "2022-11-19" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Audio::MPD::Common::Status \- class representing MPD status
.SH "VERSION"
.IX Header "VERSION"
version 2.003
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \s-1MPD\s0 server maintains some information on its current state. Those
information can be queried with mpd modules. Some of those information
are served to you as an Audio::MPD::Common::Status object.
.PP
An Audio::MPD::Common::Status object does \fBnot\fR update itself
regularly, and thus should be used immediately.
.PP
Note: one should \fBnever\fR ever instantiate an Audio::MPD::Common::Status
object directly \- use the mpd modules instead.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .SS "$status\->audio;"
.el .SS "\f(CW$status\fP\->audio;"
.IX Subsection "$status->audio;"
A string with the sample rate of the song currently playing, number of
bits of the output and number of channels (2 for stereo) \- separated
by a colon.
.ie n .SS "$status\->bitrate;"
.el .SS "\f(CW$status\fP\->bitrate;"
.IX Subsection "$status->bitrate;"
The instantaneous bitrate in kbps.
.ie n .SS "$status\->error;"
.el .SS "\f(CW$status\fP\->error;"
.IX Subsection "$status->error;"
May appear in special error cases, such as when disabling output.
.ie n .SS "$status\->playlist;"
.el .SS "\f(CW$status\fP\->playlist;"
.IX Subsection "$status->playlist;"
The playlist version number, that changes every time the playlist
is updated.
.ie n .SS "$status\->playlistlength;"
.el .SS "\f(CW$status\fP\->playlistlength;"
.IX Subsection "$status->playlistlength;"
The number of songs in the playlist.
.ie n .SS "$status\->random;"
.el .SS "\f(CW$status\fP\->random;"
.IX Subsection "$status->random;"
Whether the playlist is read randomly or not.
.ie n .SS "$status\->repeat;"
.el .SS "\f(CW$status\fP\->repeat;"
.IX Subsection "$status->repeat;"
Whether the song is repeated or not.
.ie n .SS "$status\->song;"
.el .SS "\f(CW$status\fP\->song;"
.IX Subsection "$status->song;"
The offset of the song currently played in the playlist.
.ie n .SS "$status\->songid;"
.el .SS "\f(CW$status\fP\->songid;"
.IX Subsection "$status->songid;"
The song id (\s-1MPD\s0 id) of the song currently played.
.ie n .SS "$status\->state;"
.el .SS "\f(CW$status\fP\->state;"
.IX Subsection "$status->state;"
The state of \s-1MPD\s0 server. Either \f(CW\*(C`play\*(C'\fR, \f(CW\*(C`stop\*(C'\fR or \f(CW\*(C`pause\*(C'\fR.
.ie n .SS "$status\->time;"
.el .SS "\f(CW$status\fP\->time;"
.IX Subsection "$status->time;"
An Audio::MPD::Common::Time object, representing the time elapsed /
remainging and total. See the associated pod for more details.
.ie n .SS "$status\->updating_db;"
.el .SS "\f(CW$status\fP\->updating_db;"
.IX Subsection "$status->updating_db;"
An integer, representing the current update job.
.ie n .SS "$status\->volume;"
.el .SS "\f(CW$status\fP\->volume;"
.IX Subsection "$status->volume;"
The current \s-1MPD\s0 volume \- an integer between 0 and 100.
.ie n .SS "$status\->xfade;"
.el .SS "\f(CW$status\fP\->xfade;"
.IX Subsection "$status->xfade;"
The crossfade in seconds.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jerome Quelin
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2007 by Jerome Quelin.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.