Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

poe::component::client::mpd::collection(3pm) [debian 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)

Check Out this Related Man Page

POE::Component::Client::MPD::Playlist(3pm)		User Contributed Perl Documentation		POE::Component::Client::MPD::Playlist(3pm)

NAME
POE::Component::Client::MPD::Playlist - module handling playlist commands VERSION
version 1.121670 DESCRIPTION
POE::Component::Client::MPD::Playlist 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 POCOCM 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 POCOCM's pod to learn how to deal with answers from those commands. Following is a list of playlist-related events accepted by POCOCM. RETRIEVING INFORMATION
pl.as_items( ) Return an array of Audio::MPD::Common::Item::Songs, one for each of the songs in the current playlist. 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 pl.add( $path, $path, ... ) Add the songs identified by $path (relative to MPD's music directory) to the current playlist. pl.delete( $number, $number, ... ) Remove song $number (starting from 0) from the current playlist. pl.deleteid( $songid, $songid, ... ) Remove the specified $songid (as assigned by mpd when inserted in playlist) from the current playlist. pl.clear( ) Remove all the songs from the current playlist. pl.crop( ) Remove all of the songs from the current playlist *except* the current one. CHANGING PLAYLIST ORDER
pl.shuffle( ) Shuffle the current playlist. pl.swap( $song1, $song2 ) Swap positions of song number $song1 and $song2 in the current playlist. pl.swapid( $songid1, $songid2 ) Swap positions of song id $songid1 and $songid2 in the current playlist. pl.move( $song, $newpos ) Move song number $song to the position $newpos. pl.moveid( $songid, $newpos ) Move song id $songid to the position $newpos. MANAGING PLAYLISTS
pl.load( $playlist ) Load list of songs from specified $playlist file. pl.save( $playlist ) Save the current playlist to a file called $playlist in MPD's playlist directory. pl.rm( $playlist ) Delete playlist named $playlist from MPD's playlist directory. 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::Playlist(3pm)
Man Page

Featured Tech Videos