.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" 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::Playlist 3pm"
.TH Audio::MPD::Playlist 3pm "2016-12-11" "perl v5.24.1" "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::Playlist \- class to mess MPD's playlist
.SH "VERSION"
.IX Header "VERSION"
version 2.004
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    $mpd\->playlist\->shuffle;
\&    # and lots of other methods
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Audio::MPD::Playlist is a class meant to access & update \s-1MPD\s0's
playlist.
.PP
Note that you're not supposed to call the constructor yourself, an
Audio::MPD::Playlist is automatically created for you during the
creation of an Audio::MPD object \- it can then be used with the
\&\f(CW\*(C`playlist()\*(C'\fR accessor.
.SH "RETRIEVING INFORMATION"
.IX Header "RETRIEVING INFORMATION"
.SS "as_items"
.IX Subsection "as_items"
.Vb 1
\&    my @items = $pl\->as_items;
.Ve
.PP
Return an array of Audio::MPD::Common::Item::Songs, one for each of the
songs in the current playlist.
.SS "items_changed_since"
.IX Subsection "items_changed_since"
.Vb 1
\&    my @items = $pl\->items_changed_since( $plversion );
.Ve
.PP
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"
.SS "add"
.IX Subsection "add"
.Vb 1
\&    $pl\->add( $path [, $path [...] ] );
.Ve
.PP
Add the songs identified by \f(CW$path\fR (relative to \s-1MPD\s0's music directory) to the
current playlist. No return value.
.SS "delete"
.IX Subsection "delete"
.Vb 1
\&    $pl\->delete( $song [, $song [...] ] );
.Ve
.PP
Remove the specified \f(CW$song\fR numbers (starting from 0) from the current
playlist. No return value.
.SS "deleteid"
.IX Subsection "deleteid"
.Vb 1
\&    $pl\->deleteid( $songid [, $songid [...] ] );
.Ve
.PP
Remove the specified \f(CW$songid\fRs (as assigned by mpd when inserted in playlist)
from the current playlist. No return value.
.SS "clear"
.IX Subsection "clear"
.Vb 1
\&    $pl\->clear;
.Ve
.PP
Remove all the songs from the current playlist. No return value.
.SS "crop"
.IX Subsection "crop"
.Vb 1
\&    $pl\->crop;
.Ve
.PP
Remove all of the songs from the current playlist \fBexcept\fR the
song currently playing.
.SH "CHANGING PLAYLIST ORDER"
.IX Header "CHANGING PLAYLIST ORDER"
.SS "shuffle"
.IX Subsection "shuffle"
.Vb 1
\&    $pl\->shuffle;
.Ve
.PP
Shuffle the current playlist. No return value.
.SS "swap"
.IX Subsection "swap"
.Vb 1
\&    $pl\->swap( $song1, $song2 );
.Ve
.PP
Swap positions of song number \f(CW$song1\fR and \f(CW$song2\fR in the current
playlist. No return value.
.SS "swapid"
.IX Subsection "swapid"
.Vb 1
\&    $pl\->swapid( $songid1, $songid2 );
.Ve
.PP
Swap the positions of song \s-1ID \s0\f(CW$songid1\fR with song \s-1ID \s0\f(CW$songid2\fR in the
current playlist. No return value.
.SS "move"
.IX Subsection "move"
.Vb 1
\&    $pl\->move( $song, $newpos );
.Ve
.PP
Move song number \f(CW$song\fR to the position \f(CW$newpos\fR. No return value.
.SS "moveid"
.IX Subsection "moveid"
.Vb 1
\&    $pl\->moveid( $songid, $newpos );
.Ve
.PP
Move song \s-1ID \s0\f(CW$songid\fR to the position \f(CW$newpos\fR. No return value.
.SH "MANAGING PLAYLISTS"
.IX Header "MANAGING PLAYLISTS"
.SS "load"
.IX Subsection "load"
.Vb 1
\&    $pl\->load( $playlist );
.Ve
.PP
Load list of songs from specified \f(CW$playlist\fR file. No return value.
.SS "save"
.IX Subsection "save"
.Vb 1
\&    $pl\->save( $playlist );
.Ve
.PP
Save the current playlist to a file called \f(CW$playlist\fR in \s-1MPD\s0's playlist
directory. No return value.
.SS "rm"
.IX Subsection "rm"
.Vb 1
\&    $pl\->rm( $playlist );
.Ve
.PP
Delete playlist named \f(CW$playlist\fR from \s-1MPD\s0's playlist directory. No
return value.
.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.