WebService::Jamendo - Perl API for jamendo.get2
This document refers to jamendo version 0.01
WebService::Jamendo provides some methods for getting informations about Jamendo artist, albums, tracks etc. It will return the data in the formats plain, JSON or JSON pretty.
I tried to get the best out of the jamendo.get2 API but some of the results just makes me wonder ;-) Please visit the the offical documentation of the jamendo.get2 API for more informations.
To get the JSON formatted data of a jamendo artist by his artist_id just follow these simply steps:
# Step 0
use WebService::Jamendo;
# Step 1
my $jamendo = WebService::Jamendo->new;
# Step 2
my %hParams = ('artist_id' => '22');
# Step 3
my $sArtistString = $jamendo->getArtistInfos(\%hParams);
# Step 4
print "$sArtistString\n";
In version 0.01 jamendo provides the following public methods
new()
getAlbumInfos()
getAlbumSearch()
getAlbumTracks()
getArtistInfos()
getArtistSearch()
getTrackInfos()
getTrackSearch()
getTrackStreamingFile()
getUserAlbums()
getUserFriends()
getUserInfos()
getUserSearch()
getUserTracks()
In version 0.01 jamendo provides the following private methods
__getDataSet()
__getParams()
Create a new jamendo object
use WebService::Jamendo;
my $jamendo = WebService::Jamendo->new;
Get informations for an album
This method returns:
artist_id
album_id
album_name
album_url
album_genre
album_mbgid
album_image
album_duration
foreach matching album. Default return format is json.
This method expects at least one of these parameters:
artist_id
album_id
album_name
album_url
album_genre
album_mbgid
album_image
album_duration
Optional parameters may be:
format
n
order
Example:
# Return informations about the album with id = 50 in plain text (default is json)
my %hParams = ('album_id' => '50', 'format' => 'plain');
my $sAlbumString = $jamendo->getAlbumInfos(\%hParams);
print "$sAlbumString\n";
Search for Albums
This method returns:
artist_id
album_id
album_name
album_url
album_genre
album_mbgid
album_image
album_duration
foreach found album. Default return format is json.
This method expects at least one of these parameters:
searchquery
Optional parameters may be:
artist_id
album_id
album_name
album_url
album_genre
album_mbgid
album_image
album_duration
format
n
order
Example:
# Return informations about 5 albums with love inside in jsonpretty format (default is json), order descending
my %hParams = ('searchquery' => 'love', 'n' => '5', 'order' => 'desc', 'format' => 'jsonpretty');
my $sAlbumString = $jamendo->getAlbumSearch(\%hParams);
print "$sAlbumSting\n";
Get the tracks of an album
This method returns:
artist_id
album_id
album_name
album_url
album_genre
album_mbgid
album_image
album_duration
track_id
track_name
track_filename
track_numalbum
track_duration
foreach track on the albums. Default return format is json.
This method expects at least one of these parameters:
artist_id
album_id
album_name
album_url
album_genre
album_mbgid
album_image
album_duration
track_id
track_name
track_filename
track_numalbum
track_duration
Optional parameters may be:
format
n
order
Example:
# Get informations about the tracks from the album with image url http://imgjam.com/albums/1114/covers/1.100.jpg in json pretty format (default is json) my %hParams = ('album_image' => 'http://imgjam.com/albums/1114/covers/1.100.jpg', 'format' => 'jsonpretty'); my $sTrackString = jamendo->getAlbumTracks(\%hParams); print "$sTrackString\n";
Get informations about artists
This method returns:
artist_id
artist_name
artist_url
artist_image
artist_mbgid
location_country
location_state
location_city
foreach matching artist. Default return format is json.
This method expects at least one of these parameters:
artist_id
artist_name
artist_url
artist_image
artist_mbgid
location_country
location_state
location_city
Optional parameters may be:
format
n
order
Example:
# Get infos about artists living in Hamburg, Germany in JSON format
my %hParams = ('location_city' => 'hamburg', 'location_country' => 'DEU');
my $sArtistString = $jamendo->getArtistInfos(\%hParams);
print "$sArtistString\n";
Search for artists
This method returns:
artist_id
artist_name
artist_url
artist_image
artist_mbgid
location_country
location_state
location_city
foreach found artist. Default return format is json.
This method expects at least one of these parameters:
searchquery
Optional parameters may be:
artist_id
artist_id
artist_name
artist_url
artist_image
artist_mbgid
location_country
location_state
location_city
format
n
order
Example:
# Search for artists named felixaltona living in Hamburg
my %hParams = ('searchquery' => 'felixaltona', 'location_state' => 'HH');
my $sArtistString = $jamendo->getArtistSearch(\%hParams);
print "$sArtistString\n";
Get information about tracks
This method returns:
album_id
track_id
track_name
track_filename
track_numalbum
track_duration
foreach matching track. Default return format is json.
This method expects at least one of these parameters:
album_id
track_id
track_name
track_filename
track_numalbum
track_duration
Optional parameters may be:
format
n
order
Example:
# Get informations about all tracks from the album with id = 50
my %hParams = ('album_id' => '50');
my $sTrackString = $jamendo->getTrackInfos(\%hParams);
print "$sTrackString\n";
Search for tracks
This method returns:
album_id
track_id
track_name
track_filename
track_numalbum
track_duration
foreach found track. Default return format is json.
This method expects at least one of these parameters:
searchquery
Optional parameters may be:
album_id
track_id
track_name
track_filename
track_numalbum
track_duration
format
n
order
Example:
# Search for tracks with love inside
my %hParams = ('searchquery' => 'love');
my $sTrackString = $jamendo->getTrackSearch(\%hParams);
print "$sTrackString\n";
This method returns the URL to the streaming media of tracks.
This method returns:
stream
Default return format is plain. Default return streamencoding is ogg2.
This method expects at least one of these parameters:
track_id
track_name
track_filename
Optional parameters may be:
streamencoding
format
n
order
Example:
# get the the streaming url for the track "Broken Hearts & Credit Cards" in 128k mp3 (default is ogg2)
my %hParams = ('track_name' => 'Broken Hearts & Credit Cards', 'streamencoding' => 'mp31');
my $sTrackURL = $jamendo->getTrackStreamingFile(\%hParams);
print "$sTrackURL\n";
Get the albums a user has starred
This method returns:
user_id
user_idstr
artist_id
album_id
album_name
album_url
album_genre
album_mbgid
album_image
album_duration
Default return format is json.
This method expects at least one of these parameters:
user_id
user_idstr
Optional parameters may be:
artist_id
album_id
album_name
album_url
album_genre
album_mbgid
album_image
album_duration
format
n
order
Example:
# get the albums user sylvinus has starred
my %hParams = ('user_idstr' => 'sylvinus');
my $sAlbumString = $jamendo->getUserAlbums(\%hParams);
print "$sAlbumString\n";
Get the friends of a user (hopefully he got some) Please notice that the user we search for here uses the user2_* fields, the user_* fields returning belong to his friends
This method returns:
user_id
user_name
user_idstr
user_url
user_image
user_mbgid
location_country
location_state
location_city
Default return format is json.
This method expects at least one of these parameters:
user2_id
user2_idstr
Optional parameters may be:
user_name
user_idstr
user_url
user_image
user_mbgid
location_country
location_state
location_city
format
n
order
Example:
# get all the friends of user sylvinus
my %hParams = ('user2_idstr' => 'sylvinus');
my $sFriendsString = $jamendo->getUserFriends(\%hParams);
print "$sFriendsString\n";
Get informations about users
This method returns:
user_id
user_name
user_idstr
user_url
user_image
user_mbgid
location_country
location_state
location_city
foreach matching user. Default return format is json.
This method expects at least one of these parameters:
user_id
user_name
user_idstr
user_url
user_image
user_mbgid
location_country
location_state
location_city
Optional parameters may be:
format
n
order
Example:
# get informations about user in Hamburg, Germany in json pretty format (default is json)
my %hParams = ('location_city' => 'hamburg', 'location_country' => 'DEU', 'format' => 'jsonpretty');
my $sUserString = $jamendo->getUserInfos(\%hParams);
print "$sUserString\n";
Search for user
This method returns:
user_id
user_name
user_idstr
user_url
user_image
user_mbgid
location_country
location_state
location_city
foreach found user. Default return format is json.
This method expects at least one of these parameters:
searchquery
Optional parameters may be:
user_id
user_name
user_idstr
user_url
user_image
user_mbgid
location_country
location_state
location_city
format
n
order
Example:
# search for the user sylvinus
my %hParams = ('searchquery' => 'sylvinus');
my $sUserString = $jamendo->getUserSearch(\%hParams);
print "$sUserString\n";
Get the tracks a user has starred. I dont know if this works, I didnt find a user who has starred tracks. At least it doesnt return any error messages but this method may be useless.
This method should return:
user_id
user_idstr
album_id
track_id
track_name
track_filename
track_numalbum
track_duration
foreach track. Default return format is json.
This method should expect at least one of these parameters:
user_id
user_idstr
Optional parameters may be:
album_id
track_id
track_name
track_filename
track_numalbum
track_duration
format
n
order
Example:
# get the starred tracks of user sylvinus
my %hParams = ('user_idstr' => 'sylvinus');
my $sTrackString = $jamendo->getUserTracks(\%hParams);
print "$sTrackString\n";
If you find bugs please report me via email.
Tags, most rated etc. If you have suggestions please tell me via email.
HTTP::Request http://search.cpan.org/~gaas/libwww-perl-5.828/lib/HTTP/Request.pm
LWP::UserAgent http://search.cpan.org/~gaas/libwww-perl-5.828/lib/LWP/UserAgent.pm
Jamendo web2API documentation http://developer.jamendo.com/de/wiki/Musiclist2Api
Because this software is licensed free of charge, there is no warranty for the software, to the extent permitted by applicable law. Except when otherwise stated in writing the copyright holders and/or other parties provide the software "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the software is with you. Should the software prove defective, you assume the cost of all necessary servicing, repair, or correction. In no event unless required by applicable law or agreed to in writing will any copyright holder, or any other party who may modify and/or redistribute the software as permitted by the above licence, be liable to you for damages, including any general, special, incidental, or consequential damages arising out of the use or inability to use the software (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the software to operate with any other software), even if such holder or other party has been advised of the possibility of such damages.
Christoph Glaß christoph.glass@gmail.com
Copyright (C) 2009 by Christoph Glaß This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.
