.\" 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::Item::Song 3pm"
.TH Audio::MPD::Common::Item::Song 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::Item::Song \- a song object with some audio tags
.SH "VERSION"
.IX Header "VERSION"
version 2.003
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Audio::MPD::Common::Item::Song is more a placeholder with some
attributes. Those attributes are taken from the song tags, so some of
them can be empty depending on the file.
.PP
The constructor should only be called by Audio::MPD::Common::Item's
constructor.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "album"
.IX Subsection "album"
Album of the song. (format code: \f(CW%d\fR)
.SS "artist"
.IX Subsection "artist"
Artist of the song. (format code: \f(CW%a\fR)
.SS "albumartist"
.IX Subsection "albumartist"
Artist of the album. (format code: \f(CW%A\fR)
.SS "composer"
.IX Subsection "composer"
Song composer. (format code: \f(CW%C\fR)
.SS "date"
.IX Subsection "date"
Last modification date of the song. (format code: \f(CW%M\fR)
.SS "disc"
.IX Subsection "disc"
Disc number of the album. This is a string to allow tags such as \f(CW\*(C`1/2\*(C'\fR.
(format code: \f(CW%D\fR)
.SS "file"
.IX Subsection "file"
Path to the song. Only attribute which will always be defined. (format
code: \f(CW%f\fR)
.SS "genre"
.IX Subsection "genre"
Genre of the song. (format code: \f(CW%g\fR)
.SS "id"
.IX Subsection "id"
Id of the song in \s-1MPD\s0's database. (format code: \f(CW%i\fR)
.SS "last_modified"
.IX Subsection "last_modified"
Last time the song was modified. (format code: \f(CW%m\fR)
.SS "name"
.IX Subsection "name"
Name of the song (for http streams). (format code: \f(CW%N\fR)
.SS "performer"
.IX Subsection "performer"
Song performer. (format code: \f(CW%P\fR)
.SS "pos"
.IX Subsection "pos"
Position of the song in the playlist. (format code: \f(CW%p\fR)
.SS "title"
.IX Subsection "title"
Title of the song. (format code: \f(CW%t\fR)
.SS "track"
.IX Subsection "track"
Track number of the song. (format code: \f(CW%n\fR)
.SS "time"
.IX Subsection "time"
Length of the song in seconds. (format code: \f(CW%l\fR)
.SH "METHODS"
.IX Header "METHODS"
.SS "as_string"
.IX Subsection "as_string"
.Vb 1
\&    my $str = $song\->as_string( [$format] );
.Ve
.PP
Return a string representing \f(CW$song\fR. If \f(CW$format\fR is specified, use it
to format the string. Otherwise, the string returned will be:
.ie n .IP "either ""album = track = artist = title""" 4
.el .IP "either ``album = track = artist = title''" 4
.IX Item "either album = track = artist = title"
.PD 0
.ie n .IP "or ""artist = title""" 4
.el .IP "or ``artist = title''" 4
.IX Item "or artist = title"
.ie n .IP "or ""title""" 4
.el .IP "or ``title''" 4
.IX Item "or title"
.ie n .IP "or ""file""" 4
.el .IP "or ``file''" 4
.IX Item "or file"
.PD
.PP
(in this order), depending on the existing tags of the song. The last
possibility always exist of course, since it's a path.
.PP
This method is also used to automatically stringify the \f(CW$song\fR.
.PP
\&\fB\s-1WARNING:\s0\fR the format codes are not yet definitive and may be subject
to change!
.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.