com.echonest.api.v4
Class DynamicPlaylistParams

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

public class DynamicPlaylistParams
extends PlaylistParams

Nested Class Summary

Nested classes/interfaces inherited from class com.echonest.api.v4.PlaylistParams

PlaylistParams.PlaylistSort, PlaylistParams.PlaylistType

Constructor Summary

DynamicPlaylistParams()

Method Summary

void	banArtist() Bands the current artist
void	banSong() Bans the current song
void	banTerm(java.lang.String term) Bans the given term from appearing on the session
void	requireTerm(java.lang.String term) Requires a term to be present in the session
void	setChainXSPF(boolean chain)
void	setRating(int rating)
void	setResults(int results) Set the maximum number of songs to return in the playlist
void	setSteerDescription(java.lang.String term, float boost) Sets the boost for a particular term
void	steerDanceability(float boost) Steer by dancability.
void	steerEnergy(float boost) Steer by energy.
void	steerHotttnesss(float boost) Steer by hotttnesss.
void	steerLoudness(float boost) Steer by loudness.
void	steerTempo(float boost) Steer by tempo.

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

addArtist, addArtistID, addDescription, addIDSpace, addMood, addSeedCatalog, addStyle, includeArtistFamiliarity, includeArtistHotttnesss, includeArtistLocation, includeAudioSummary, includeSongHotttnesss, includeTracks, setAdventurousness, setArtistEndYearAfter, setArtistEndYearBefore, setArtistMaxFamiliarity, setArtistMaxHotttnesss, setArtistMaxLatitude, setArtistMaxLongitude, setArtistMinFamiliarity, setArtistMinHotttnesss, setArtistMinLatitude, setArtistMinLongitude, setArtistPick, setArtistStartYearAfter, setArtistStartYearBefore, setDMCA, setKey, setLimit, setMaxDanceability, setMaxDuration, setMaxEnergy, setMaxFamiliarity, setMaxLoudness, setMaxTempo, setMinDanceability, setMinDuration, setMinEnergy, setMinLoudness, setMinTempo, setMode, setSongMaxHotttnesss, setSongMinHotttnesss, setType, setVariety, sortBy

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

DynamicPlaylistParams

public DynamicPlaylistParams()

Method Detail

setRating

public void setRating(int rating)

setChainXSPF

public void setChainXSPF(boolean chain)

setResults

public void setResults(int results)

Description copied from class: PlaylistParams

Set the maximum number of songs to return in the playlist

Overrides:

setResults in class PlaylistParams

Parameters:

results - the results

setSteerDescription

public void setSteerDescription(java.lang.String term,
                                float boost)

Sets the boost for a particular term

Parameters:

term - the term to boost

boost - the boost

banTerm

public void banTerm(java.lang.String term)

Bans the given term from appearing on the session

Parameters:

term - the term to ban

requireTerm

public void requireTerm(java.lang.String term)

Requires a term to be present in the session

Parameters:

term - the term of interest

steerTempo

public void steerTempo(float boost)

Steer by tempo. Using the previously played track as the basis, make all future tracks some multiplier of the selected attribute(s). required terms use a multiplier in a boost-like format - e.g. energy^.5 to make all future songs have half the energy of the previously played song, or loudness^1.3 to add 30%.

Parameters:

boost -

steerLoudness

public void steerLoudness(float boost)

Steer by loudness. Using the previously played track as the basis, make all future tracks some multiplier of the selected attribute(s). required terms use a multiplier in a boost-like format - e.g. energy^.5 to make all future songs have half the energy of the previously played song, or loudness^1.3 to add 30%.

Parameters:

boost -

steerDanceability

public void steerDanceability(float boost)

Steer by dancability. Using the previously played track as the basis, make all future tracks some multiplier of the selected attribute(s). required terms use a multiplier in a boost-like format - e.g. energy^.5 to make all future songs have half the energy of the previously played song, or loudness^1.3 to add 30%.

Parameters:

boost -

steerEnergy

public void steerEnergy(float boost)

Steer by energy. Using the previously played track as the basis, make all future tracks some multiplier of the selected attribute(s). required terms use a multiplier in a boost-like format - e.g. energy^.5 to make all future songs have half the energy of the previously played song, or loudness^1.3 to add 30%.

Parameters:

boost -

steerHotttnesss

public void steerHotttnesss(float boost)

Steer by hotttnesss. Using the previously played track as the basis, make all future tracks some multiplier of the selected attribute(s). required terms use a multiplier in a boost-like format - e.g. energy^.5 to make all future songs have half the energy of the previously played song, or loudness^1.3 to add 30%.

Parameters:

boost -

banSong

public void banSong()

Bans the current song

banArtist

public void banArtist()

Bands the current artist