1
0
Fork 0
mirror of https://github.com/Yetangitu/ampache synced 2025-10-04 10:19:25 +02:00
ampache/modules/EchoNest/Api/Song.php
2013-12-28 17:11:16 +01:00

63 lines
2 KiB
PHP

<?php
/**
* Api calls for getting data about songs.
*
* @link http://developer.echonest.com/docs/v4/song.html
* @author Brent Shaffer <bshafs at gmail dot com>
* @license MIT License
*/
class EchoNest_Api_Song extends EchoNest_Api
{
/**
* Search for songs given different query types
* http://developer.echonest.com/docs/v4/song.html#search
*
* @param array $options see the EchoNest documentation for a list of options
* @return array list of search results
*/
public function search($options)
{
$response = $this->client->get('song/search', $options);
return $this->returnResponse($response, 'songs');
}
/**
* Get info about songs given a list of ids
* http://developer.echonest.com/docs/v4/song.html#profile
*
* @param string|array $id the rosetta ID of the song (can be an array of ids)
* @param string|array $bucket indicates what data should be returned with each artist
* @param bool $limit if true artists will be limited to those that appear in the catalog specified by the id: bucket
* @return array list of search results
*/
public function profile($id, $bucket = null, $limit = false)
{
$response = $this->client->get('song/profile', array(
'id' => $id,
'bucket' => $bucket,
'limit' => $limit,
));
return $this->returnResponse($response, 'songs');
}
/**
* Identifies a song given Echo Nest Musical Fingerpint hash codes.
* http://developer.echonest.com/docs/v4/song.html#indentify
*
* @param array $options see the EchoNest documentation for a list of options
* @return array list of search results
*/
public function identify($options)
{
if (isset($options['query'])) {
$response = $this->client->post('song/identify', $options);
}
else {
$response = $this->client->get('song/identify', $options);
}
return $this->returnResponse($response, 'songs');
}
}