.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 "POE::Component::Client::MPD::Collection 3pm"
.TH POE::Component::Client::MPD::Collection 3pm "2019-01-19" "perl v5.28.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"
POE::Component::Client::MPD::Collection \- module handling collection commands
.SH "VERSION"
.IX Header "VERSION"
version 2.001
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::Client::MPD::Collection is responsible for handling
general purpose commands. They are in a dedicated module to achieve
easier code maintenance.
.PP
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.
.PP
Read POE::Component::Client::MPD's pod to learn how to deal with
answers from those commands.
.PP
Following is a list of collection-related events accepted by \s-1POCOCM.\s0
.SH "RETRIEVING SONGS & DIRECTORIES"
.IX Header "RETRIEVING SONGS & DIRECTORIES"
.SS "coll.all_items( [$path] )"
.IX Subsection "coll.all_items( [$path] )"
Return all 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 "coll.all_items_simple( [$path] )"
.IX Subsection "coll.all_items_simple( [$path] )"
Return all 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 attribute file filled. Any other attribute will be empty, so
don't use this sub for any other thing than a quick scan!
.SS "coll.items_in_dir( [$path] )"
.IX Subsection "coll.items_in_dir( [$path] )"
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 "coll.all_albums( )"
.IX Subsection "coll.all_albums( )"
Return the list of all albums (strings) currently known by mpd.
.SS "coll.all_artists( )"
.IX Subsection "coll.all_artists( )"
Return the list of all artists (strings) currently known by mpd.
.SS "coll.all_titles( )"
.IX Subsection "coll.all_titles( )"
Return the list of all titles (strings) currently known by mpd.
.SS "coll.all_files( )"
.IX Subsection "coll.all_files( )"
Return a mpd_result event with the list of all filenames (strings)
currently known by mpd.
.SH "PICKING A SONG"
.IX Header "PICKING A SONG"
.ie n .SS "coll.song( $path )"
.el .SS "coll.song( \f(CW$path\fP )"
.IX Subsection "coll.song( $path )"
Return the Audio::MPD::Common::Item::Song which correspond to
\&\f(CW$path\fR.
.ie n .SS "coll.songs_with_filename_partial( $string )"
.el .SS "coll.songs_with_filename_partial( \f(CW$string\fP )"
.IX Subsection "coll.songs_with_filename_partial( $string )"
Return the Audio::MPD::Common::Item::Songs containing \f(CW$string\fR in
their path.
.SH "SONGS, ALBUMS & ARTISTS RELATIONS"
.IX Header "SONGS, ALBUMS & ARTISTS RELATIONS"
.ie n .SS "coll.albums_by_artist( $artist )"
.el .SS "coll.albums_by_artist( \f(CW$artist\fP )"
.IX Subsection "coll.albums_by_artist( $artist )"
Return all albums (strings) performed by \f(CW$artist\fR or where \f(CW$artist\fR
participated.
.ie n .SS "coll.songs_by_artist( $artist )"
.el .SS "coll.songs_by_artist( \f(CW$artist\fP )"
.IX Subsection "coll.songs_by_artist( $artist )"
Return all Audio::MPD::Common::Item::Songs performed by \f(CW$artist\fR.
.ie n .SS "coll.songs_by_artist_partial( $artist )"
.el .SS "coll.songs_by_artist_partial( \f(CW$artist\fP )"
.IX Subsection "coll.songs_by_artist_partial( $artist )"
Return all Audio::MPD::Common::Item::Songs performed by \f(CW$artist\fR.
.ie n .SS "coll.songs_from_album( $album )"
.el .SS "coll.songs_from_album( \f(CW$album\fP )"
.IX Subsection "coll.songs_from_album( $album )"
Return all Audio::MPD::Common::Item::Songs appearing in \f(CW$album\fR.
.ie n .SS "coll.songs_from_album_partial( $string )"
.el .SS "coll.songs_from_album_partial( \f(CW$string\fP )"
.IX Subsection "coll.songs_from_album_partial( $string )"
Return all Audio::MPD::Common::Item::Songs appearing in album
containing \f(CW$string\fR.
.ie n .SS "coll.songs_with_title( $title )"
.el .SS "coll.songs_with_title( \f(CW$title\fP )"
.IX Subsection "coll.songs_with_title( $title )"
Return all Audio::MPD::Common::Item::Songs which title is exactly
\&\f(CW$title\fR.
.ie n .SS "coll.songs_with_title_partial( $string )"
.el .SS "coll.songs_with_title_partial( \f(CW$string\fP )"
.IX Subsection "coll.songs_with_title_partial( $string )"
Return all Audio::MPD::Common::Item::Songs where \f(CW$string\fR is part
of the title.
.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.