.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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 "POE::Component::Client::MPD::Playlist 3pm"
.TH POE::Component::Client::MPD::Playlist 3pm "2016-05-24" "perl v5.22.2" "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"
POE::Component::Client::MPD::Playlist \- module handling playlist commands
.SH "VERSION"
.IX Header "VERSION"
version 2.001
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::Client::MPD::Playlist is responsible for handling
general purpose commands. They are in a dedicated module to achieve
easier code maintenance.
.PP
To achieve those commands, send the corresponding event to the \s-1POCOCM\s0
session you created: it will be responsible for dispatching the event
where it is needed. Under no circumstance should you call directly subs
or methods from this module directly.
.PP
Read \s-1POCOCM\s0's pod to learn how to deal
with answers from those commands.
.PP
Following is a list of playlist-related events accepted by \s-1POCOCM.\s0
.SH "RETRIEVING INFORMATION"
.IX Header "RETRIEVING INFORMATION"
.SS "pl.as_items( )"
.IX Subsection "pl.as_items( )"
Return an array of Audio::MPD::Common::Item::Songs, one for each of
the songs in the current playlist.
.ie n .SS "pl.items_changed_since( $plversion )"
.el .SS "pl.items_changed_since( \f(CW$plversion\fP )"
.IX Subsection "pl.items_changed_since( $plversion )"
Return a list with all the songs (as Audio::MPD::Common::Item::Song
objects) added to the playlist since playlist \f(CW$plversion\fR.
.SH "ADDING / REMOVING SONGS"
.IX Header "ADDING / REMOVING SONGS"
.ie n .SS "pl.add( $path, $path, ... )"
.el .SS "pl.add( \f(CW$path\fP, \f(CW$path\fP, ... )"
.IX Subsection "pl.add( $path, $path, ... )"
Add the songs identified by \f(CW$path\fR (relative to \s-1MPD\s0's music directory)
to the current playlist.
.ie n .SS "pl.delete( $number, $number, ... )"
.el .SS "pl.delete( \f(CW$number\fP, \f(CW$number\fP, ... )"
.IX Subsection "pl.delete( $number, $number, ... )"
Remove song \f(CW$number\fR (starting from 0) from the current playlist.
.ie n .SS "pl.deleteid( $songid, $songid, ... )"
.el .SS "pl.deleteid( \f(CW$songid\fP, \f(CW$songid\fP, ... )"
.IX Subsection "pl.deleteid( $songid, $songid, ... )"
Remove the specified \f(CW$songid\fR (as assigned by mpd when inserted in
playlist) from the current playlist.
.SS "pl.clear( )"
.IX Subsection "pl.clear( )"
Remove all the songs from the current playlist.
.SS "pl.crop( )"
.IX Subsection "pl.crop( )"
Remove all of the songs from the current playlist *except* the current one.
.SH "CHANGING PLAYLIST ORDER"
.IX Header "CHANGING PLAYLIST ORDER"
.SS "pl.shuffle( )"
.IX Subsection "pl.shuffle( )"
Shuffle the current playlist.
.ie n .SS "pl.swap( $song1, $song2 )"
.el .SS "pl.swap( \f(CW$song1\fP, \f(CW$song2\fP )"
.IX Subsection "pl.swap( $song1, $song2 )"
Swap positions of song number \f(CW$song1\fR and \f(CW$song2\fR in the current
playlist.
.ie n .SS "pl.swapid( $songid1, $songid2 )"
.el .SS "pl.swapid( \f(CW$songid1\fP, \f(CW$songid2\fP )"
.IX Subsection "pl.swapid( $songid1, $songid2 )"
Swap positions of song id \f(CW$songid1\fR and \f(CW$songid2\fR in the current
playlist.
.ie n .SS "pl.move( $song, $newpos )"
.el .SS "pl.move( \f(CW$song\fP, \f(CW$newpos\fP )"
.IX Subsection "pl.move( $song, $newpos )"
Move song number \f(CW$song\fR to the position \f(CW$newpos\fR.
.ie n .SS "pl.moveid( $songid, $newpos )"
.el .SS "pl.moveid( \f(CW$songid\fP, \f(CW$newpos\fP )"
.IX Subsection "pl.moveid( $songid, $newpos )"
Move song id \f(CW$songid\fR to the position \f(CW$newpos\fR.
.SH "MANAGING PLAYLISTS"
.IX Header "MANAGING PLAYLISTS"
.ie n .SS "pl.load( $playlist )"
.el .SS "pl.load( \f(CW$playlist\fP )"
.IX Subsection "pl.load( $playlist )"
Load list of songs from specified \f(CW$playlist\fR file.
.ie n .SS "pl.save( $playlist )"
.el .SS "pl.save( \f(CW$playlist\fP )"
.IX Subsection "pl.save( $playlist )"
Save the current playlist to a file called \f(CW$playlist\fR in \s-1MPD\s0's
playlist directory.
.ie n .SS "pl.rm( $playlist )"
.el .SS "pl.rm( \f(CW$playlist\fP )"
.IX Subsection "pl.rm( $playlist )"
Delete playlist named \f(CW$playlist\fR from \s-1MPD\s0's playlist directory.
.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.