.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .. .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 "Audio::MPD::Collection 3pm" .TH Audio::MPD::Collection 3pm "2022-06-08" "perl v5.34.0" "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::Collection \- class to query MPD's collection .SH "VERSION" .IX Header "VERSION" version 2.004 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& my @songs = $mpd\->collection\->all_songs; \& # and lots of other methods .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Audio::MPD::Collection is a class meant to access & query \s-1MPD\s0's collection. You will be able to use those high-level methods instead of using the low-level methods provided by mpd itself. .PP Note that you're not supposed to call the constructor yourself, an Audio::MPD::Collection is automatically created for you during the creation of an Audio::MPD object \- it can then be used with the \&\f(CW\*(C`collection()\*(C'\fR accessor. .SH "RETRIEVING SONGS & DIRECTORIES" .IX Header "RETRIEVING SONGS & DIRECTORIES" .SS "all_items" .IX Subsection "all_items" .Vb 1 \& my @items = $coll\->all_items( [$path] ); .Ve .PP Return \fBall\fR Audio::MPD::Common::Items (both songs & directories) currently known by mpd. .PP If \f(CW$path\fR is supplied (relative to mpd root), restrict the retrieval to songs and dirs in this directory. .SS "all_items_simple" .IX Subsection "all_items_simple" .Vb 1 \& my @items = $coll\->all_items_simple( [$path] ); .Ve .PP Return \fBall\fR Audio::MPD::Common::Items (both songs & directories) currently known by mpd. .PP If \f(CW$path\fR is supplied (relative to mpd root), restrict the retrieval to songs and dirs in this directory. .PP \&\fB/!\e Warning\fR: the Audio::MPD::Common::Item::Song objects will only have their tag \f(CW\*(C`file\*(C'\fR filled. Any other tag will be empty, so don't use this sub for any other thing than a quick scan! .SS "items_in_dir" .IX Subsection "items_in_dir" .Vb 1 \& my @items = $coll\->items_in_dir( [$path] ); .Ve .PP Return the items in the given \f(CW$path\fR. If no \f(CW$path\fR supplied, do it on mpd's root directory. .PP Note that this sub does not work recusrively on all directories. .SH "RETRIEVING THE WHOLE COLLECTION" .IX Header "RETRIEVING THE WHOLE COLLECTION" .SS "all_songs" .IX Subsection "all_songs" .Vb 1 \& my @songs = $coll\->all_songs( [$path] ); .Ve .PP Return \fBall\fR Audio::MPD::Common::Item::Songs currently known by mpd. .PP If \f(CW$path\fR is supplied (relative to mpd root), restrict the retrieval to songs and dirs in this directory. .SS "all_albums" .IX Subsection "all_albums" .Vb 1 \& my @albums = $coll\->all_albums; .Ve .PP Return the list of all albums (strings) currently known by mpd. .SS "all_artists" .IX Subsection "all_artists" .Vb 1 \& my @artists = $coll\->all_artists; .Ve .PP Return the list of all artists (strings) currently known by mpd. .SS "all_titles" .IX Subsection "all_titles" .Vb 1 \& my @titles = $coll\->all_titles; .Ve .PP Return the list of all song titles (strings) currently known by mpd. .SS "all_pathes" .IX Subsection "all_pathes" .Vb 1 \& my @pathes = $coll\->all_pathes; .Ve .PP Return the list of all pathes (strings) currently known by mpd. .SS "all_playlists" .IX Subsection "all_playlists" .Vb 1 \& my @lists = $coll\->all_playlists; .Ve .PP Return the list of all playlists (strings) currently known by mpd. .SS "all_genres" .IX Subsection "all_genres" .Vb 1 \& my @genres = $coll\->all_genres; .Ve .PP Return the list of all genres (strings) currently known by mpd. .SH "PICKING A SONG" .IX Header "PICKING A SONG" .SS "song" .IX Subsection "song" .Vb 1 \& my $song = $coll\->song( $path ); .Ve .PP Return the Audio::MPD::Common::Item::Song which correspond to \f(CW$path\fR. .SS "songs_with_filename_partial" .IX Subsection "songs_with_filename_partial" .Vb 1 \& my @songs = $coll\->songs_with_filename_partial( $string ); .Ve .PP Return the Audio::MPD::Common::Item::Songs containing \f(CW$string\fR in their path. .SH "SONGS, ALBUMS, ARTISTS & GENRES RELATIONS" .IX Header "SONGS, ALBUMS, ARTISTS & GENRES RELATIONS" .SS "albums_by_artist" .IX Subsection "albums_by_artist" .Vb 1 \& my @albums = $coll\->albums_by_artist( $artist ); .Ve .PP Return all albums (strings) performed by \f(CW$artist\fR or where \f(CW$artist\fR participated. .SS "songs_by_artist" .IX Subsection "songs_by_artist" .Vb 1 \& my @songs = $coll\->songs_by_artist( $artist ); .Ve .PP Return all Audio::MPD::Common::Item::Songs performed by \f(CW$artist\fR. .SS "songs_by_artist_partial" .IX Subsection "songs_by_artist_partial" .Vb 1 \& my @songs = $coll\->songs_by_artist_partial( $string ); .Ve .PP Return all Audio::MPD::Common::Item::Songs performed by an artist with \f(CW$string\fR in her name. .SS "songs_from_album" .IX Subsection "songs_from_album" .Vb 1 \& my @songs = $coll\->songs_from_album( $album ); .Ve .PP Return all Audio::MPD::Common::Item::Songs appearing in \f(CW$album\fR. .SS "songs_from_album_partial" .IX Subsection "songs_from_album_partial" .Vb 1 \& my @songs = $coll\->songs_from_album_partial( $string ); .Ve .PP Return all Audio::MPD::Common::Item::Songs appearing in album containing \f(CW$string\fR. .SS "songs_with_title" .IX Subsection "songs_with_title" .Vb 1 \& my @songs = $coll\->songs_with_title( $title ); .Ve .PP Return all Audio::MPD::Common::Item::Songs which title is exactly \&\f(CW$title\fR. .SS "songs_with_title_partial" .IX Subsection "songs_with_title_partial" .Vb 1 \& my @songs = $coll\->songs_with_title_partial( $string ); .Ve .PP Return all Audio::MPD::Common::Item::Songs where \f(CW$string\fR is part of the title. .SS "artists_by_genre" .IX Subsection "artists_by_genre" .Vb 1 \& my @artists = $coll\->artists_by_genre( $genre ); .Ve .PP Return all artists (strings) of \f(CW$genre\fR. .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.