Audio::MPD::Playlist(3)

NAME
Audio::MPD::Playlist - an object to mess MPD's playlist

SYNOPSIS
    my $song = $mpd->playlist->randomize;

DESCRIPTION
"Audio::MPD::Playlist" is a class meant to access & update MPD's playlist.

PUBLIC METHODS

  Constructor

new( $mpd )
    This will create the object, holding a back-reference to the "Audio::MPD" object itself (for communication purposes). But in order to play safe and to free the memory in time, this reference is weakened.

    Note that you're not supposed to call this constructor yourself, an "Audio::MPD::Playlist" is automatically created for you during the creation of an "Audio::MPD" object.

  Retrieving information

$pl->as_items()
    Return an array of "Audio::MPD::Common::Item::Song"s, one for each of the songs in the current playlist.

$pl->items_changed_since( $plversion )
    Return a list with all the songs (as AMC::Item::Song objects) added to the playlist since playlist $plversion.

  Adding / removing songs

$pl->add( $path [, $path [...] ] )
    Add the songs identified by $path (relative to MPD's music directory) to the current playlist. No return value.

$pl->delete( $song [, $song [...] ] )
    Remove the specified $song numbers (starting from 0) from the current playlist. No return value.

$pl->deleteid( $songid [, $songid [...] ] )
    Remove the specified $songids (as assigned by mpd when inserted in playlist) from the current playlist. No return value.

$pl->clear()
    Remove all the songs from the current playlist. No return value.

$pl->crop()
    Remove all of the songs from the current playlist except the song currently playing.

  Changing playlist order

$pl->shuffle()
    Shuffle the current playlist. No return value.

$pl->swap( $song1, $song2 )
    Swap positions of song number $song1 and $song2 in the current playlist. No return value.

$pl->swapid( $songid1, $songid2 )
    Swap the postions of song ID $songid1 with song ID $songid2 in the current playlist. No return value.

$pl->move( $song, $newpos )
    Move song number $song to the position $newpos. No return value.

$pl->moveid( $songid, $newpos )
    Move song ID $songid to the position $newpos. No return value.

  Managing playlists

$pl->load( $playlist )
    Load list of songs from specified $playlist file. No return value.

$pl->save( $playlist )
    Save the current playlist to a file called $playlist in MPD's playlist directory. No return value.

$pl->rm( $playlist )
    Delete playlist named $playlist from MPD's playlist directory. No return value.

SEE ALSO
For all related information (bug reporting, mailing-list, pointers to MPD, etc.), refer to "Audio::MPD"'s pod, section "SEE ALSO"

AUTHOR
Jerome Quelin, "<jquelin@cpan.org>"

COPYRIGHT & LICENSE
Copyright (c) 2007-2009 Jerome Quelin, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.