com.echonest.api.v4
Class PlaylistParams

java.lang.Object
  com.echonest.api.v4.Params
      com.echonest.api.v4.PlaylistParams

Direct Known Subclasses:

DynamicPlaylistParams

public class PlaylistParams
extends Params

Nested Class Summary

static class	PlaylistParams.PlaylistSort
static class	PlaylistParams.PlaylistType

Constructor Summary

PlaylistParams()

Method Summary

void	addArtist(java.lang.String artist) Adds the name of a seed artist
void	addArtistID(java.lang.String artistID) Adds an ID of a seed artist
void	addDescription(java.lang.String desc) Adds a description of the type of artists that can be included in the playlist
void	addIDSpace(java.lang.String idspace)
void	addMood(java.lang.String mood) Adds a mood of the type of artists that can be included in the playlist
void	addSeedCatalog(java.lang.String id) Adds a seed catalog
void	addStyle(java.lang.String style) Adds a style of the type of artists that can be included in the playlist
void	includeArtistFamiliarity()
void	includeArtistHotttnesss()
void	includeArtistLocation()
void	includeAudioSummary()
void	includeSongHotttnesss()
void	includeTracks()
void	setAdventurousness(float adventure) Sets the desired adventurousness for the playlist.
void	setArtistEndYearAfter(int year) Constrains results to artists that have a latest end year after the given year
void	setArtistEndYearBefore(int year) Constrains results to artists that have a latest end year before the given year
void	setArtistMaxFamiliarity(float val)
void	setArtistMaxHotttnesss(float val)
void	setArtistMaxLatitude(float val)
void	setArtistMaxLongitude(float val)
void	setArtistMinFamiliarity(float val)
void	setArtistMinHotttnesss(float val)
void	setArtistMinLatitude(float val)
void	setArtistMinLongitude(float val)
void	setArtistPick(java.lang.String songSort, boolean ascending, int count) How songs are to be picked for artist-type playlists.
void	setArtistStartYearAfter(int year) Constrains results to artists that have an earliest start year after the given year
void	setArtistStartYearBefore(int year) Constrains results to artists that have an earliest start year before the given year
void	setDMCA(boolean dmca)
void	setKey(int key)
void	setLimit(boolean limit)
void	setMaxDanceability(float val)
void	setMaxDuration(float val)
void	setMaxEnergy(float val)
void	setMaxFamiliarity(float val)
void	setMaxLoudness(float val)
void	setMaxTempo(float tempo)
void	setMinDanceability(float val)
void	setMinDuration(float val)
void	setMinEnergy(float val)
void	setMinLoudness(float val)
void	setMinTempo(float tempo)
void	setMode(int mode)
void	setResults(int results) Set the maximum number of songs to return in the playlist
void	setSongMaxHotttnesss(float val)
void	setSongMinHotttnesss(float val)
void	setType(PlaylistParams.PlaylistType type) Sets the type of the playlist.
void	setVariety(float variety) the variety of artists to be represented in the playlist.
void	sortBy(PlaylistParams.PlaylistSort sortType, boolean ascending)

Methods inherited from class com.echonest.api.v4.Params

add, add, add, add, add, add, getMap, set, set, set, set, size, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlaylistParams

public PlaylistParams()

Method Detail

setType

public void setType(PlaylistParams.PlaylistType type)

Sets the type of the playlist. Default is ARTIST

Parameters:

type - the type of the playlist.

setArtistPick

public void setArtistPick(java.lang.String songSort,
                          boolean ascending,
                          int count)

How songs are to be picked for artist-type playlists. After songs have been filtered by any constraints, artist_pick is used to determined which song is to be picked for an artist. There are two components to the artist_pick, separated by a tilde - a song sort and a value. An artist_pick of hotttnesss-desc~10 means to pick a track at random from the top 10 hotttest tracks.

Parameters:

songSort - the song sort

ascending - if true, ascending sort

count - the number of songs to pick from

setVariety

public void setVariety(float variety)

the variety of artists to be represented in the playlist. A higher number will allow for more variety in the artists. Appropriate for playlists of type artist-radio, artist-path, artist-walk, artist-description

Parameters:

variety - a value between 0 and 1

setAdventurousness

public void setAdventurousness(float adventure)

Sets the desired adventurousness for the playlist. A value between 0 and 1. A higher value indicates that a more adventurous playlist should be generated.

Parameters:

adventure - a value between 0 and 1

addSeedCatalog

public void addSeedCatalog(java.lang.String id)

Adds a seed catalog

Parameters:

id - the ID of the seed catalog

addArtistID

public void addArtistID(java.lang.String artistID)

Adds an ID of a seed artist

Parameters:

artistID - an ID of the seed artist

addArtist

public void addArtist(java.lang.String artist)

Adds the name of a seed artist

Parameters:

artist - the name of the seed artist

addDescription

public void addDescription(java.lang.String desc)

Adds a description of the type of artists that can be included in the playlist

Parameters:

desc -

addStyle

public void addStyle(java.lang.String style)

Adds a style of the type of artists that can be included in the playlist

Parameters:

style - the style

addMood

public void addMood(java.lang.String mood)

Adds a mood of the type of artists that can be included in the playlist

Parameters:

mood - the mood

setResults

public void setResults(int results)

Set the maximum number of songs to return in the playlist

Parameters:

results - the results

setMaxTempo

public void setMaxTempo(float tempo)

setMinTempo

public void setMinTempo(float tempo)

setMaxDuration

public void setMaxDuration(float val)

setMinDuration

public void setMinDuration(float val)

setMaxLoudness

public void setMaxLoudness(float val)

setMinLoudness

public void setMinLoudness(float val)

setMaxFamiliarity

public void setMaxFamiliarity(float val)

setMaxDanceability

public void setMaxDanceability(float val)

setMinDanceability

public void setMinDanceability(float val)

setMaxEnergy

public void setMaxEnergy(float val)

setMinEnergy

public void setMinEnergy(float val)

setArtistMaxFamiliarity

public void setArtistMaxFamiliarity(float val)

setArtistMinFamiliarity

public void setArtistMinFamiliarity(float val)

setArtistMaxHotttnesss

public void setArtistMaxHotttnesss(float val)

setArtistMinHotttnesss

public void setArtistMinHotttnesss(float val)

setSongMaxHotttnesss

public void setSongMaxHotttnesss(float val)

setSongMinHotttnesss

public void setSongMinHotttnesss(float val)

setArtistMaxLongitude

public void setArtistMaxLongitude(float val)

setArtistMinLongitude

public void setArtistMinLongitude(float val)

setArtistMaxLatitude

public void setArtistMaxLatitude(float val)

setArtistMinLatitude

public void setArtistMinLatitude(float val)

setMode

public void setMode(int mode)

setKey

public void setKey(int key)

setLimit

public void setLimit(boolean limit)

setArtistStartYearBefore

public void setArtistStartYearBefore(int year)

Constrains results to artists that have an earliest start year before the given year

Parameters:

year -

setArtistStartYearAfter

public void setArtistStartYearAfter(int year)

Constrains results to artists that have an earliest start year after the given year

Parameters:

year -

setArtistEndYearBefore

public void setArtistEndYearBefore(int year)

Constrains results to artists that have a latest end year before the given year

Parameters:

year -

setArtistEndYearAfter

public void setArtistEndYearAfter(int year)

Constrains results to artists that have a latest end year after the given year

Parameters:

year -

includeAudioSummary

public void includeAudioSummary()

includeTracks

public void includeTracks()

includeSongHotttnesss

public void includeSongHotttnesss()

includeArtistHotttnesss

public void includeArtistHotttnesss()

includeArtistFamiliarity

public void includeArtistFamiliarity()

includeArtistLocation

public void includeArtistLocation()

addIDSpace

public void addIDSpace(java.lang.String idspace)

sortBy

public void sortBy(PlaylistParams.PlaylistSort sortType,
                   boolean ascending)

setDMCA

public void setDMCA(boolean dmca)