Module: Echowrap::API::Playlist

Includes:
Utils
Included in:
Client
Defined in:
lib/echowrap/api/playlist.rb

Constant Summary

Constants included from Utils

Utils::API_KEY_CANNOT_CALL_THIS_METHOD, Utils::INVALID_PARAMETER, Utils::MISSING_OR_INVALID_KEY, Utils::MISSING_PARAMETER, Utils::RATE_LIMIT_EXCEEDED, Utils::SUCCESS

Instance Method Summary collapse

Instance Method Details

#playlist_basic(options = {}) ⇒ Array, Array<Echowrap::Song>

Returns a basic playlist. A basic playlist is generated once from an initial set of parameters, and returned as an ordered list of songs. Basic playlist functionality is supported, see the static and dynamic playlist APIs for advanced contextual and personalized playlisting. Some properties of a basic playlist:

Songs are never repeated
Artists may be repeated

A number of different algorithms can be used to select songs for the playlist. These are specified with the type parameter.

Examples:

Return an array of songs with artist ‘Daft Punk’

Echowrap.playlist_basic(:artist => "Daft Punk")

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :type (String) —

    The type of the playlist to be generated. Not required, must be one of [‘artist-radio’, ‘song-radio’, ‘genre-radio’]

  • :artist_id (String) —

    ID(s) of seed artist(s) for the playlist. Echo Nest or Rosetta IDs. Not required, may use multiple, no more than 5 total artist_id, artist, track_id, and song_id parameters. Example: ‘ARH6W4X1187B99274F’ or ‘7digital-US:artist:304’.

  • :artist (String) —

    Name(s) of seed artist(s) for the playlist. Not required, may use multiple, no more than 5 total artist_id, artist, track_id, and song_id parameters. Example: ‘Weezer, the+beatles’.

  • :song_id (String) —

    ID(s) of seed song(s) for the playlist. Echo Nest or Rosetta IDs. Not required, may use multiple, no more than 5 total artist_id, artist, track_id, and song_id parameters. Example: ‘SOCZMFK12AC468668F’.

  • :genre (String) —

    A musical genre such as rock, jazz, or dance pop. See the artist method list_genres for details on what genres are currently available, only allowed for genre-radio playlist types and required for genre-radio playlist types. Example: ‘jazz, metal’.

  • :track_id (String) —

    ID(s) of seed track(s) for the playlist. Echo Nest or Rosetta IDs. Not required, may use multiple, no more than 5 total artist_id, artist, track_id, and song_id parameters. Example: ‘TRTLKZV12E5AC92E11’.

  • :results (Integer) —

    The desired number of songs in the playlist, the valid range is 0 to 100, with 15 as the default

  • :bucket (String) —

    Specifies which extra information should be returned in the playlist. Not require, may use multiple, must be one of [‘id:catalog-name’, ‘tracks’]. When specifying idspace buckets (those starting with “id:”) the results will be returned in a “foreign_ids” key/element. See Project Rosetta Stone for more information on ID spaces. Example: “tracks”.

  • :limit (String) —

    If ‘true’, limit the results to any of the given rosetta id space. Must be on of [‘true’, ‘false’] with ‘false’ as the default. If limit is set to anything but false, at least one idspace must also be provided in the bucket parameter.

  • :dmca (String) —

    If true or ‘styleb’ the playlist delivered will meet the DMCA rules. When the DMCA parameter is set to true, the playlist will conform to the following rules: No more than 2 songs in a row from the same album, no more than 3 songs from an album in a 3 hour period, no more than 3 different songs in a row by the same artist, no more than 4 songs by the same artist in a 3 hour period. Skipped songs are not considered to have been played for DMCA conformance purposes. If dmca is set to ‘styleb’, skipped songs are considered to have been played for DMCA purposes.

Returns:

Raises:

See Also:



31
32
33
 
# File 'lib/echowrap/api/playlist.rb', line 31

def playlist_basic(options={})
  objects_from_response(Echowrap::Song, :get, '/api/v4/playlist/basic', :songs, options)
end

#playlist_dynamic_create(options = {}) ⇒ Echowrap::Playlist

Creates a new dynamic playlist session. A dynamic playlist is created with an initial set of parameters that define rules for generating the playlist. A session identifier is returned that can be used with other dynamic methods to get new songs, provide feedback or to steer the playlist. Songs in the playlist can be fetched, one at a time, using the dynamic/next method. The playlist is dynamic in that it is adapted dynamically based on the listener’s feedback and steering. The dynamic playlist will adapt the playlist session based upon a number of factors:

Played songs
Skipped songs
Rated songs/artists
Favorited songs/artists
Banned songs/artists
Playlist steering

The dynamic/create method accepts the same set of parameters as the playlist/static method with the exception of the results parameter.

Examples:

Return a playlist with a session ID

Echowrap.playlist_dynamic_create(:artist => "Daft Punk")

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  • (Hash) —

    a customizable set of options

Options Hash (options):

  • :session_catalog (String) —

    The IDs of catalogs that should be updated with session information (plays, skips, ratings,bans, favorites, etc). Multiple session catalogs can be listed and all will be updated with the same information. The session catalogs must have been previously created using the same API key as used in this call. May use muliple up to 5. Example: ‘CAKSMUX1321A708AA4’

Returns:

Raises:

See Also:



122
123
124
 
# File 'lib/echowrap/api/playlist.rb', line 122

def playlist_dynamic_create(options={})
  object_from_response(Echowrap::Playlist, :get, '/api/v4/playlist/dynamic/create', nil, options)
end

#playlist_dynamic_delete(options = {}) ⇒ Boolean

Deletes a previously created session. A non-commercial API can have, at most 1,000 active playlist sessions.

Examples:

Return boolean with status of response

Echowrap.playlist_dynamic_delete(:session_id => 7bf982d80ed8421c8c94dbd6de565e9d')

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  • (Hash) —

    a customizable set of options

Options Hash (options):

  • :session_id (String) —

    ID of session. Required. Example: ‘7bf982d80ed8421c8c94dbd6de565e9d’

Returns:

  • (Boolean)
  • (Boolean)

Raises:

See Also:



243
244
245
 
# File 'lib/echowrap/api/playlist.rb', line 243

def playlist_dynamic_delete(options={})
  boolean_from_response(:get, '/api/v4/playlist/dynamic/delete', options)
end

#playlist_dynamic_feedback(options = {}) ⇒ Boolean

Give feedback on the given items (artists or songs) or the last played song. This method allows you to give user feedback such as rating, favoriting, banning of a song or artist. Feedback is applied to the item specified by the given song_id or track_id. If no song_id or track_id is specified, then the feedback is applied to the most recent song returned by dynamic/next. Multiple feedbacks can be given at any time. Specified songs need not be in the session history. This allows the pre-seeding of a session with played tracks, skipped tracks, favorites, ratings and bans.

Examples:

Return boolean with status of response

Echowrap.playlist_dynamic_feedback(:session_id => 7bf982d80ed8421c8c94dbd6de565e9d', :favorite_song => 'SOCZMFK12AC468668F')

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  • (Hash) —

    a customizable set of options

Options Hash (options):

  • :session_id (String) —

    ID of session. Required. Example: ‘7bf982d80ed8421c8c94dbd6de565e9d’

  • :ban_artist (String) —

    The given artist, or the artist associated with the given song or track is banned from the session and will never appear again. Use ‘last’ to ban the artist of the most recently returned song. Examples: ‘ARH6W4X1187B99274F’ or ‘SOCZMFK12AC468668F’ or ‘TRTLKZV12E5AC92E11’ or ‘last’.

  • :favorite_artist (String) —

    The given artist, or the artist associated with the given song or track is favorited. Use ‘last’ to favorite the artist of the most recently returned song. Examples: ‘ARH6W4X1187B99274F’ or ‘SOCZMFK12AC468668F’ or ‘TRTLKZV12E5AC92E11’ or ‘last’.

  • :ban_song (String) —

    The given song is banned from the session and will never appear again. Use ‘last’ to ban the most recently returned song. Examples: ‘SOCZMFK12AC468668F’ or ‘TRTLKZV12E5AC92E11’ or ‘last’.

  • :skip_song (String) —

    If the given song is in the session history, it is considered to be skipped. The play timestamp of subsequent songs in the session history are adjusted to reflect the skipped song. The skipped song will never appear again in the session. Use last to skip the most recently returned song. Use ‘last’ to ban the most recently returned song. Examples: ‘SOCZMFK12AC468668F’ or ‘TRTLKZV12E5AC92E11’ or ‘last’.

  • :favorite_song (String) —

    The given song is favorited. Use ‘last’ to favorite the most recently returned song. Examples: ‘SOCZMFK12AC468668F’ or ‘TRTLKZV12E5AC92E11’ or ‘last’.

  • :unplay_song (String) —

    This given song is considered not played. Unlike the skip_song operation, the song may appear again in the session. This operation is typically used when a song is retrieved by the dynamic/next call but for whatever reason is not actually played in the client. Use ‘last’ to unplay the most recently returned song. Examples: ‘SOCZMFK12AC468668F’ or ‘TRTLKZV12E5AC92E11’ or ‘last’.

  • :rate_song (String) —

    The given rating is applied to the song Ratings are of the form: song_id^rating where rating is a value between 0 and 10. Use ‘last’ to rate the most recently returned song. Examples: ‘SOCZMFK12AC468668F^5’ or ‘TRTLKZV12E5AC92E11^8’ or ‘last^1’.

  • :update_catalog (String) —

    This parameter controls whether or not this given feedback is pushed to the seed_catalog. By default, all feedback is pushed to the seed_catalog. If this parameter is false then feedback is not pushed to the catalog. This parameter has no effect if there is no seed_catalog associated with the playlist session. Not required must be one of [‘true’, ‘false’].

  • :invalidate_song (String) —

    The given song is removed from the play history and will never appear again in the playlist session. This feedback is typically used to discard a song that is unplayable. Examples: ‘ARH6W4X1187B99274F’ or ‘SOCZMFK12AC468668F’ or ‘TRTLKZV12E5AC92E11’ or ‘last’.

  • :invalidate_artist (String) —

    The given artist, or the artist associated with the given song or track is removed from the play history and will never appear again in this playlist session. This feedback is typically used to discard an artist that is unplayable. Examples: ‘ARH6W4X1187B99274F’ or ‘SOCZMFK12AC468668F’ or ‘TRTLKZV12E5AC92E11’ or ‘last’.

Returns:

  • (Boolean)
  • (Boolean)

Raises:

See Also:



182
183
184
 
# File 'lib/echowrap/api/playlist.rb', line 182

def playlist_dynamic_feedback(options={})
  boolean_from_response(:get, '/api/v4/playlist/dynamic/feedback', options)
end

#playlist_dynamic_info(options = {}) ⇒ Echowrap::Playlist

Returns information about a dynamic playlist session

Examples:

Return boolean with status of response

Echowrap.playlist_dynamic_info(:session_id => 7bf982d80ed8421c8c94dbd6de565e9d')

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  • (Hash) —

    a customizable set of options

Options Hash (options):

  • :session_id (String) —

    ID of session. Required. Example: ‘7bf982d80ed8421c8c94dbd6de565e9d’

Returns:

Raises:

See Also:



227
228
229
 
# File 'lib/echowrap/api/playlist.rb', line 227

def playlist_dynamic_info(options={})
  object_from_response(Echowrap::Playlist, :get, '/api/v4/playlist/dynamic/info', nil, options)
end

#playlist_dynamic_next(options = {}) ⇒ Echowrap::Playlist

Returns the next songs in the playlist. Results includes two lists of songs - one list (called next) contains the next songs to play, the other (called lookahead) contains the lookahead songs (controlled via the lookahead parameter). The next songs returned by this method will be considered to be played starting at the time the call returns. Use the dynamic/feedback method to indicate that the song was skipped or not played.

Examples:

Return a playlist with songs and lookaheads

Echowrap.playlist_dynamic_next(:session_id => 7bf982d80ed8421c8c94dbd6de565e9d')

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  • (Hash) —

    a customizable set of options

Options Hash (options):

  • :session_id (String) —

    ID of session. Required. Example: ‘7bf982d80ed8421c8c94dbd6de565e9d’

  • :results (Integer) —

    The desired number of next songs returned. Maybe be one of [0, 1, 5]. Requesting zero results, when combined with a non-zero lookahead, allows you to retrieve the next 1-5 songs without any assumptions about songs being played. Requesting zero results returns the lookahead only, no ‘results’ will be returned. No songs are assumed played nor are any added to the history or any associated session catalogs. The playlist is not advanced. Making consecutive dynamic/next calls with zero results will return the exact same set of lookahead tracks. You must provide feedback (via the dynamic/feedback api), to explicitly play and/or skip songs in the playlist in order to advance the playlist when ‘results’ is set to zero.

  • :lookahead (Integer) —

    Number of lookahead songs to return. Lookahead songs are the next songs that will be returned to be played if no user feedback or steering occurs before the next dynamic/next method call. Not required, may be 0 to 5.

Returns:

Raises:

See Also:



156
157
158
 
# File 'lib/echowrap/api/playlist.rb', line 156

def playlist_dynamic_next(options={})
  object_from_response(Echowrap::Playlist, :get, '/api/v4/playlist/dynamic/next', nil, options)
end

#playlist_dynamic_restart(options = {}) ⇒ Echowrap::Playlist

Restarts a playlist session. Given the session ID and a new set of playlist parameters, this method restarts the playlist session based upon the new parameters. The session history is maintained. Everything else is reset. This method takes all the same parameters as dynamic/create, plus the session ID. Returns the given session ID.

Examples:

Return a playlist with a session ID

Echowrap.playlist_dynamic_restart(:session_id => '7bf982d80ed8421c8c94dbd6de565e9d', :artist => "Daft Punk")

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  • (Hash) —

    a customizable set of options

Options Hash (options):

  • :session_id (String) —

    ID of session. Required. Example: ‘7bf982d80ed8421c8c94dbd6de565e9d’

Returns:

Raises:

See Also:



138
139
140
 
# File 'lib/echowrap/api/playlist.rb', line 138

def playlist_dynamic_restart(options={})
  object_from_response(Echowrap::Playlist, :get, '/api/v4/playlist/dynamic/restart', nil, options)
end

#playlist_dynamic_steer(options = {}) ⇒ Boolean

Steers the playlist based upon the given constraints. Steerings are additive and can be reset with the reset parameter.

Examples:

Return boolean with status of response

Echowrap.playlist_dynamic_steer(:session_id => 7bf982d80ed8421c8c94dbd6de565e9d', :min_danceability => 0.4)

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  • (Hash) —

    a customizable set of options

Options Hash (options):

  • :session_id (String) —

    ID of session. Required. Example: ‘7bf982d80ed8421c8c94dbd6de565e9d’

  • :min_xxx (Float) —

    Prefer songs that have a value for xxx that is greater than or equal to the given value where xxx can be tempo, loudness, danceability, energy, liveness, speechiness, song_hotttnesss, artist_hotttnesss, artist_familiarity. Not required, may send multiple. Examples ‘min_song_hotness=0.0’, ‘min_artist_hotttnesss’ => 0.2.

  • :max_xxx (Float) —

    Prefer songs that have a value for xxx that is less than or equal to the given value where xxx can be tempo, loudness, danceability, energy, liveness, speechiness, song_hotttnesss, artist_hotttnesss, artist_familiarity.

  • :target_xxx (String) —

    Pefer songs that have a value for xxx that are closer to the given value where xxx can be tempo, loudness, danceability, energy, liveness, speechiness, song_hotttnesss, artist_hotttnesss, artist_familiarity.

  • :more_like_this (String) —

    Prefer songs that are more similar to the given song ID with the given optional boost. song_id can be last to use the most recently returned song. Boost can be an integer between 0 and 5. The default is 1. Examples: ‘SO12341234^2’, ‘SO123412341234^5’.

  • :less_like_this (String) —

    Prefer songs that are less similar to the given song ID with the given optional boost. song_id can be last to use the most recently returned song. Boost can be an integer between 0 and 5. The default is 1. Examples: ‘SO12341234^2’, ‘SO123412341234^5’.

  • :adventerousness (Float) —

    Adjust the adventurousness of the session. A value of 0 means no adventurousness, only known and preferred music will be played. A value of 1 means high adventurousness, mostly unknown music will be played. This parameter only applies to catalog and catalog-radio type playlists. Examples: ‘0.14’, ‘0.7’, ‘1.0’.

  • :variety (Float) —

    Adjust the variety of the session. A higher number will allow for more variety in the artists. Examples: ‘0.14’, ‘0.7’, ‘1.0’.

  • :description (String) —

    Prefer songs by artists that match the given general description. Not required, may use multiple. Example: ‘alt-rock,-emo,harp^2’.

  • :style (String) —

    Prefer songs by artists that match the given style some examples are: ‘jazz’, ‘metal^2’.

  • :song_type (String) —

    Prefers songs that match the given song type. Supported song_types are: ‘christmas’, ‘live’ and ‘studio’. A song type can optionally be followed by ‘:’ and a state, where the state can be one of ‘true’, ‘false’ or ‘any’. If no state is given, the desired state is assumed to be ‘true’.

  • :mood (String) —

    Prefer songs by artists that match the given mood, some examples are: ‘happy’, ‘sad^.5’.

  • :reset (String) —

    Resets any playlist steering that has been done on this session to the default state. False is default.

Returns:

  • (Boolean)
  • (Boolean)

Raises:

See Also:



211
212
213
 
# File 'lib/echowrap/api/playlist.rb', line 211

def playlist_dynamic_steer(options={})
  boolean_from_response(:get, '/api/v4/playlist/dynamic/steer', options)
end

#playlist_static(options = {}) ⇒ Array, Array<Echowrap::Song>

Returns a static playlist. A static playlist is generated once from an initial set of parameters, and returned as an ordered list of songs. Some properties of a static playlist:

Songs are never repeated
Artist may be repeated

A number of different algorithms can be used to select songs for the playlist. These are specified with the type parameter.

Examples:

Return an array of songs with artist ‘Daft Punk’

Echowrap.playlist_static(:artist => "Daft Punk")

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :type (String) —

    The type of the playlist to be generated. Not required, must be one of [‘artist’, ‘artist-radio’, ‘artist-description’, ‘song-radio’, ‘catalog’, ‘catalog-radio’, ‘genre-radio’], ‘artist’ is default.

  • :artist_pick (String) —

    The artist_pick parameter is used to determine how songs are picked for each artist in artist-type playlists. If the asc or desc suffix is ommitted, artist_pick defaults to descending. Not required, must one of [‘song_hotttnesss-desc’, ‘tempo’, ‘duration’, ‘loudness’, ‘mode’, ‘key’]

  • :variety (Float) —

    The maximum variety of artists to be represented in the playlist. A higher number will allow for more variety in the artists. Must be between 0.0 and 1.0, default is 0.5. Example: 0.7.

  • :distribution (String) —

    Controls the distribution of artists in the playlist. A focused distribution yields a playlist of songs that are tightly clustered around the seeds, whereas a wandering distribution yields a playlist from a broader range of artists. Not required, must be on of [‘focused’, ‘wandering’], ‘focused’ is default.

  • :adventurousness (Float) —

    Controls the trade between known music and unknown music. A value of 0 means no adventurousness, only known and preferred music will be played. A value of 1 means high adventurousness, mostly unknown music will be played. A value of auto indicates that the adventurousness should be automatically determined based upon the taste profile of the user. This parameter only applies to catalog and catalog-radio type playlists. Not required must greater than 0.0 and less than 1.0, default is 0.2.

  • :artist_id (String) —

    ID(s) of seed artist(s) for the playlist. Echo Nest or Rosetta IDs. Not required, may use multiple, no more than 5 total artist_id, artist, track_id, and song_id parameters. Example: ‘ARH6W4X1187B99274F’ or ‘7digital-US:artist:304’.

  • :artist (String) —

    Name(s) of seed artist(s) for the playlist. Not required, may use multiple, no more than 5 total artist_id, artist, track_id, and song_id parameters. Example: ‘Weezer, the+beatles’.

  • :seed_catalog (String) —

    ID of seed catalog for playlist. Not required. Example: ‘CAKSMUX1321A708AA4’.

  • :song_id (String) —

    ID(s) of seed song(s) for the playlist. Echo Nest or Rosetta IDs. Not required, may use multiple, no more than 5 total artist_id, artist, track_id, and song_id parameters. Example: ‘SOCZMFK12AC468668F’.

  • :track_id (String) —

    ID(s) of seed track(s) for the playlist. Echo Nest or Rosetta IDs. Not required, may use multiple, no more than 5 total artist_id, artist, track_id, and song_id parameters. Example: ‘TRTLKZV12E5AC92E11’.

  • :description (String) —

    Description of the type of songs that can be included in the playlist. Not required, may use multiple. Example: ‘alt-rock,-emo,harp^2’.

  • :genre (String) —

    A musical genre such as rock, jazz, or dance pop. See the artist method list_genres for details on what genres are currently available, only allowed for genre-radio playlist types and required for genre-radio playlist types. Example: ‘jazz, metal’.

  • :style (String) —

    A musical style or genre like rock, jazz, or funky, some examples are: ‘jazz’, ‘metal^2’.

  • :mood (String) —

    A mood like happy or sad, some examples are: ‘happy’, ‘sad^.5’.

  • :results (Integer) —

    The desired number of songs in the playlist, the valid range is 0 to 100, with 15 as the default

  • :max_tempo (Float) —

    The maximum tempo for any song on the playlist, the valid range for max_tempo is 0.0 to 500.0 (BPM), with 500.0 as default.

  • :min_tempo (Float) —

    The minimum tempo for any song on the playlist, the valid range for min_tempo is 0.0 to 500.0 (BPM), with 0.0 as default.

  • :max_duration (Float) —

    The maximum duration of any song on the playlist, the valid range for max_duration is 0.0 to 3600.0 (seconds), with 3600.0 as default.

  • :min_duration (Float) —

    The minimum duration of any song on the playlist, the valid range for min_duration is 0.0 to 3600.0 (seconds), with 0.0 as default.

  • :max_loudness (Float) —

    The maximum loudness of any song on the playlist, the valid range for max_loudness is -100.0 to 100.0 (decibels), with 100.0 as default.

  • :min_loudness (Float) —

    The minimum loudness of any song on the playlist, the valid range for min_loudness is 0.0 to -100.0 (decibels), with -100.0 as default.

  • :max_danceability (Float) —

    The maximum danceability of any song, the valid range for max_danceability is 0.0 to 1.0, with 1.0 as default.

  • :min_danceability (Float) —

    The minimum danceability of any song, the valid range for min_danceability is 0.0 to 1.0, with 0.0 as default.

  • :max_energy (Float) —

    The maximum energy of any song, the valid range for max_energy is 0.0 to 1.0, with 1.0 as default.

  • :min_energy (Float) —

    The minimum energy of any song, the valid range for min_energy is 0.0 to 1.0, with 0.0 as default.

  • :max_liveness (Float) —

    The maximum liveness of any song, the valid range for max_liveness is 0.0 to 1.0, with 1.0 as default.

  • :min_liveness (Float) —

    The minimum liveness of any song, the valid range for min_liveness is 0.0 to 1.0, with 0.0 as default.

  • :max_speechiness (Float) —

    The maximum speechiness of any song, the valid range for max_speechiness is 0.0 to 1.0, with 1.0 as default.

  • :min_speechiness (Float) —

    The minimum speechiness of any song, the valid range for min_speechiness is 0.0 to 1.0, with 0.0 as default.

  • :artist_max_familiarity (Float) —

    The maximum artist familiarity of any song on the playlist, the valid range for artist_max_familiarity is 0.0 to 1.0, with 1.0 as default.

  • :artist_min_familiarity (Float) —

    The minimum artist familiarity of any song on the playlist, the valid range for artist_min_familiarity is 0.0 to 1.0, with 0.0 as default.

  • :artist_max_hotttnesss (Float) —

    The maximum artist hotttnesss of any song on the playlist, the valid range for artist_max_hotttnesss is 0.0 to 1.0, with 1.0 as default.

  • :artist_min_hotttnesss (Float) —

    The minimum artist hotttnesss of any song on the playlist, the valid range for the artist_min_hotttnesss is 0.0 to 1.0, with 0.0 as default.

  • :song_type (String) —

    Controls the type of songs returned. Supported song_types are: ‘christmas’, ‘live’ and ‘studio’. A song type can optionally be followed by ‘:’ and a state, where the state can be one of ‘true’, ‘false’ or ‘any’. If no state is given, the desired state is assumed to be ‘true’.

  • :artist_start_year_before (String) —

    Matches artists that have an earliest start year before the given value, some examples are ‘1970’, ‘2011’, ‘present’.

  • :artist_start_year_after (String) —

    Matches artists that have an earliest start year after the given value, some examples are ‘1970’, ‘2011’, ‘present’.

  • :artist_end_year_before (String) —

    Matches artists that have an latest start year before the given value, some examples are ‘1970’, ‘2011’, ‘present’.

  • :artist_end_year_after (String) —

    Matches artists that have an latest start year after the given value, some examples are ‘1970’, ‘2011’, ‘present’.

  • :song_max_hotttnesss (Float) —

    The maximum hotttnesss of any song, the valid range for song_max_hotttnesss is 0.0 to 1.0, with 1.0 as default.

  • :song_min_hotttnesss (Float) —

    The minimum hotttnesss of any song, the valid range for the song_min_hotttnesss is 0.0 to 1.0, with 0.0 as default.

  • :max_longitude (Float) —

    The maximum longitude of the primary artist location, the valid range for max_longitude is -180.0 to 180.0, with 180.0 as default.

  • :min_longitude (Float) —

    The minimum longitude of the primary artist location, the valid range for min_longitude is -180.0 to 180.0, with -180.0 as default.

  • :max_latitude (Float) —

    The maximum latitude of the primary artist location, the valid range for max_latitude is -90.0 to 90.0, with 90.0 as default.

  • :min_latitude (Float) —

    The minimum longitude of the primary artist location, the valid range for max_latitude is -90.0 to 90.0, with -90.0 as default.

  • :mode (Integer) —

    The mode of songs, must be one of [0, 1] (minor, major), with 0 representing minor and 1 represeting major.

  • :key (Integer) —

    The key of songs in the playlist, the valid range for key is 0 to 11 (C, C-sharp, D, D-sharp, E… with 0 representing C and 11 representing B).

  • :bucket (String) —

    Indicates what data should be returned for each song. If specifying the “tracks” bucket, a bucket with an id space must also be specified. Must be one of [‘audio_summary’, ‘artist_familiarity’, ‘artist_hotttnesss’, ‘artist_location’, ‘song_hotttnesss’, ‘song_type’, ‘tracks’, ‘id:Rosetta-space’].

  • :sort (String) —

    Indicates how the songs results should be ordered. Must be one of [‘tempo-asc’, ‘duration-asc’, ‘loudness-asc’, ‘speechiness-asc’, ‘liveness-asc’, ‘artist_familiarity-asc’, ‘artist_hotttnesss-asc’, ‘artist_start_year-asc’, ‘artist_start_year-desc’, ‘artist_end_year-asc’, ‘artist_end_year-desc’, ‘song_hotttness-asc’, ‘latitude-asc’, ‘longitude-asc’, ‘mode-asc’, ‘key-asc’, ‘tempo-desc’, ‘duration-desc’, ‘loudness-desc’, ‘liveness-desc’, ‘speechiness-desc’, ‘artist_familiarity-desc’, ‘artist_hotttnesss-desc’, ‘song_hotttnesss-desc’, ‘latitude-desc’, ‘longitude-desc’, ‘mode-desc’, ‘key-desc’, ‘energy-asc’, ‘energy-desc’, ‘danceability-asc’, ‘danceability-desc’].

  • :limit (String) —

    If ‘true’, limit the results to any of the given rosetta id space. Must be on of [‘true’, ‘false’] with ‘false’ as the default. If limit is set to anything but false, at least one idspace must also be provided in the bucket parameter.

  • :dmca (String) —

    If true or ‘styleb’ the playlist delivered will meet the DMCA rules. When the DMCA parameter is set to true, the playlist will conform to the following rules: No more than 2 songs in a row from the same album, no more than 3 songs from an album in a 3 hour period, no more than 3 different songs in a row by the same artist, no more than 4 songs by the same artist in a 3 hour period. Skipped songs are not considered to have been played for DMCA conformance purposes. If dmca is set to ‘styleb’, skipped songs are considered to have been played for DMCA purposes.

Returns:

  • (Array) —

    Array of songs.

  • (Array<Echowrap::Song>) —

    Array<Echowrap::Song>

Raises:

See Also:



98
99
100
 
# File 'lib/echowrap/api/playlist.rb', line 98

def playlist_static(options={})
  objects_from_response(Echowrap::Song, :get, '/api/v4/playlist/static', :songs, options)
end