.\" Automatically generated by Pod::Man 4.09 (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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" 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 "WebService::MusicBrainz 3pm" .TH WebService::MusicBrainz 3pm "2018-03-09" "perl v5.26.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" WebService::MusicBrainz .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use WebService::MusicBrainz; \& \& my $mb = WebService::MusicBrainz\->new(); \& \& my $result = $mb\->search($resource => { $search_key => \*(Aqsearch value\*(Aq }); \& my $result = $mb\->search($resource => { $search_key => \*(Aqsearch value\*(Aq, fmt => \*(Aqjson\*(Aq }); # fmt => \*(Aqjson\*(Aq is default \& \& my $result_dom = $mb\->search($resource => { $search_key => \*(Aqsearch value\*(Aq, fmt => \*(Aqxml\*(Aq }); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\s-1API\s0 to search the musicbrainz.org database .SH "VERSION" .IX Header "VERSION" Version 1.0 and future releases are not backward compatible with pre\-1.0 releases. This is a complete re-write using version 2.0 of the MusicBrainz \s-1API\s0 and Mojolicious. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" .Vb 1 \& my $mb = WebService::MusicBrainz\->new(); .Ve .SS "search" .IX Subsection "search" .Vb 1 \& my $result_list = $mb\->search($resource => { param1 => \*(Aqvalue1\*(Aq }); \& \& my $result = $mb\->search($resource => { mbid => \*(Aqmbid\*(Aq }); \& \& my $result_more = $mb\->search($resource => { mbid => \*(Aqmbid\*(Aq, inc => \*(Aqextra stuff\*(Aq }); \& \& Valid values for $resource are: area, artist, event, instrument, label, recording, release, release\-group, series, work, url \&The default is to return decoded JSON as a perl data structure. Specify format => \*(Aqxml\*(Aq to return the results as an instance of Mojo::DOM. .Ve .PP \fISearch by \s-1MBID\s0\fR .IX Subsection "Search by MBID" .PP .Vb 1 \& my $result = $mb\->search($resource => { mbid => \*(Aqxxxxxx\*(Aq }); .Ve .PP The \*(L"inc\*(R" search parameter is only allowed when searching for any particular \*(L"mbid\*(R". .PP \fISearch area\fR .IX Subsection "Search area" .PP .Vb 5 \& my $area_list_results = $mb_ws\->search(area => { iso => \*(AqUS\-OH\*(Aq }); \& my $area_list_results = $mb_ws\->search(area => { area => \*(Aqcincinnati\*(Aq }); \& my $area_list_results = $mb_ws\->search(area => { alias => \*(Aqnew york\*(Aq }); \& my $area_list_results = $mb_ws\->search(area => { sortname => \*(Aqnew york\*(Aq }); \& my $area_list_results = $mb_ws\->search(area => { area => \*(Aqnew york\*(Aq, type => \*(Aqcity\*(Aq }); \& \& my $area_result = $mb_ws\->search(area => { mbid => \*(Aq0573177b\-9ff9\-4643\-80bc\-ed2513419267\*(Aq }); \& my $area_result = $mb_ws\->search(area => { mbid => \*(Aq0573177b\-9ff9\-4643\-80bc\-ed2513419267\*(Aq, inc => \*(Aqarea\-rels\*(Aq }); .Ve .PP \fISearch artist\fR .IX Subsection "Search artist" .PP .Vb 3 \& # JSON example \& my $artists = $mb\->search(artist => { artist => \*(AqRyan Adams\*(Aq }); \& my $artists = $mb\->search(artist => { artist => \*(AqRyan Adams\*(Aq, type => \*(Aqperson\*(Aq }); \& \& my $artist_country = $artists\->{artists}\->[0]\->{country}; \& \& # XML example \& my $artists = $mb\->search(artist => { artist => \*(AqRyan Adams\*(Aq, type => \*(Aqperson\*(Aq, fmt => \*(Aqxml\*(Aq }); \& \& my $artist_country = $artists\->at(\*(Aqcountry\*(Aq)\->text; \& \& # find this particular artist \& my $artist = $mb\->search(artist => { mbid => \*(Aq5c2d2520\-950b\-4c78\-84fc\-78a9328172a3\*(Aq }); \& \& # find this particular artist and include release and artist relations (members of the band) \& my $artist = $mb\->search(artist => { mbid => \*(Aq5c2d2520\-950b\-4c78\-84fc\-78a9328172a3\*(Aq, inc => [\*(Aqreleases\*(Aq,\*(Aqartist\-rels\*(Aq] }); \& \& # artists that started in Cincinnati \& my $artists = $mb\->search(artist => { beginarea => \*(AqCincinnati\*(Aq }); .Ve .PP \fISearch label\fR .IX Subsection "Search label" .PP .Vb 1 \& my $labels = $mb\->search(label => { label => \*(AqDeath\*(Aq }); .Ve .PP \fISearch recording\fR .IX Subsection "Search recording" .PP .Vb 1 \& my $recordings = $mb\->search(recording => { artist => \*(AqTaylor Swift\*(Aq }); .Ve .PP \fISearch release\fR .IX Subsection "Search release" .PP .Vb 2 \& my $releases = $mb\->search(release => { release => \*(AqLove Is Hell\*(Aq, status => \*(Aqofficial\*(Aq }); \& print "RELEASE COUNT: ", $releases\->{count}, "\en"; .Ve .SH "DEBUG" .IX Header "DEBUG" Set environment variable MUSICBRAINZ_DEBUG=1 .IP "\(bu" 1 The \s-1URL\s0 that is generated for the search will output to \s-1STDOUT.\s0 .IP "\(bu" 1 The formatted output (\s-1JSON\s0 or \s-1XML\s0) will be output to \s-1STDOUT\s0 .SH "AUTHOR" .IX Header "AUTHOR" .IP "Bob Faist " 4 .IX Item "Bob Faist " .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2006\-2017 by Bob Faist .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" http://musicbrainz.org/doc/Development/XML_Web_Service/Version_2