audio::mpd::playlist(3pm) [debian man page]
Audio::MPD::Playlist(3pm) User Contributed Perl Documentation Audio::MPD::Playlist(3pm) NAME
Audio::MPD::Playlist - class to mess MPD's playlist VERSION
version 1.120610 SYNOPSIS
$mpd->playlist->shuffle; # and lots of other methods DESCRIPTION
Audio::MPD::Playlist is a class meant to access & update MPD's playlist. 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 "playlist()" accessor. RETRIEVING INFORMATION
as_items my @items = $pl->as_items; Return an array of Audio::MPD::Common::Item::Songs, one for each of the songs in the current playlist. items_changed_since my @items = $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 $plversion. ADDING
/ REMOVING SONGS add $pl->add( $path [, $path [...] ] ); Add the songs identified by $path (relative to MPD's music directory) to the current playlist. No return value. delete $pl->delete( $song [, $song [...] ] ); Remove the specified $song numbers (starting from 0) from the current playlist. No return value. deleteid $pl->deleteid( $songid [, $songid [...] ] ); Remove the specified $songids (as assigned by mpd when inserted in playlist) from the current playlist. No return value. clear $pl->clear; Remove all the songs from the current playlist. No return value. crop $pl->crop; Remove all of the songs from the current playlist except the song currently playing. CHANGING PLAYLIST ORDER
shuffle $pl->shuffle; Shuffle the current playlist. No return value. swap $pl->swap( $song1, $song2 ); Swap positions of song number $song1 and $song2 in the current playlist. No return value. swapid $pl->swapid( $songid1, $songid2 ); Swap the postions of song ID $songid1 with song ID $songid2 in the current playlist. No return value. move $pl->move( $song, $newpos ); Move song number $song to the position $newpos. No return value. moveid $pl->moveid( $songid, $newpos ); Move song ID $songid to the position $newpos. No return value. MANAGING PLAYLISTS
load $pl->load( $playlist ); Load list of songs from specified $playlist file. No return value. save $pl->save( $playlist ); Save the current playlist to a file called $playlist in MPD's playlist directory. No return value. rm $pl->rm( $playlist ); Delete playlist named $playlist from MPD's playlist directory. No return value. AUTHOR
Jerome Quelin COPYRIGHT AND LICENSE
This software is copyright (c) 2007 by Jerome Quelin. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. perl v5.14.2 2012-03-01 Audio::MPD::Playlist(3pm)
Check Out this Related Man Page
POE::Component::Client::MPD::Collection(3pm) User Contributed Perl Documentation POE::Component::Client::MPD::Collection(3pm) NAME
POE::Component::Client::MPD::Collection - module handling collection commands VERSION
version 1.121670 DESCRIPTION
POE::Component::Client::MPD::Collection is responsible for handling general purpose commands. They are in a dedicated module to achieve easier code maintenance. To achieve those commands, send the corresponding event to the POE::Component::Client::MPD 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. Read POE::Component::Client::MPD's pod to learn how to deal with answers from those commands. Following is a list of collection-related events accepted by POCOCM. RETRIEVING SONGS &; DIRECTORIES coll.all_items( [$path] ) Return all Audio::MPD::Common::Items (both songs & directories) currently known by mpd. If $path is supplied (relative to mpd root), restrict the retrieval to songs and dirs in this directory. coll.all_items_simple( [$path] ) Return all Audio::MPD::Common::Items (both songs & directories) currently known by mpd. If $path is supplied (relative to mpd root), restrict the retrieval to songs and dirs in this directory. /! Warning: the Audio::MPD::Common::Item::Song objects will only have their attribute file filled. Any other attribute will be empty, so don't use this sub for any other thing than a quick scan! coll.items_in_dir( [$path] ) Return the items in the given $path. If no $path supplied, do it on mpd's root directory. Note that this sub does not work recusrively on all directories. RETRIEVING THE WHOLE COLLECTION
coll.all_albums( ) Return the list of all albums (strings) currently known by mpd. coll.all_artists( ) Return the list of all artists (strings) currently known by mpd. coll.all_titles( ) Return the list of all titles (strings) currently known by mpd. coll.all_files( ) Return a mpd_result event with the list of all filenames (strings) currently known by mpd. PICKING A SONG
coll.song( $path ) Return the Audio::MPD::Common::Item::Song which correspond to $path. coll.songs_with_filename_partial( $string ) Return the Audio::MPD::Common::Item::Songs containing $string in their path. SONGS, ALBUMS &; ARTISTS RELATIONS coll.albums_by_artist( $artist ) Return all albums (strings) performed by $artist or where $artist participated. coll.songs_by_artist( $artist ) Return all Audio::MPD::Common::Item::Songs performed by $artist. coll.songs_by_artist_partial( $artist ) Return all Audio::MPD::Common::Item::Songs performed by $artist. coll.songs_from_album( $album ) Return all Audio::MPD::Common::Item::Songs appearing in $album. coll.songs_from_album_partial( $string ) Return all Audio::MPD::Common::Item::Songs appearing in album containing $string. coll.songs_with_title( $title ) Return all Audio::MPD::Common::Item::Songs which title is exactly $title. coll.songs_with_title_partial( $string ) Return all Audio::MPD::Common::Item::Songs where $string is part of the title. AUTHOR
Jerome Quelin COPYRIGHT AND LICENSE
This software is copyright (c) 2007 by Jerome Quelin. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. perl v5.14.2 2012-06-15 POE::Component::Client::MPD::Collection(3pm)