Reference

import export shorthand

Get an existing, readable ini file name, create it if necessary

authorize()

Get and store client credentials. Any other credentials will be dropped.

Get application path for developer applications

Get id and secret as 32-byte string, no encryption

If the user gives us access, that will be in the future. Is it worth waiting for? If so, call wait_for_ig_access()

Constructs launch command

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

Try to open one browser from BROWSERS. In some cases we expect an immediate indication of failure, for example when the corresponding browser is not found on the system. In other cases, we will just wait in vain. In those cases, call this function again after a reasonable timeout. The function remembers which browsers were tried before.

player_get_current_track(;additional_types::String="track", market::String="US")

Summary: Get the object currently being played on the user's Spotify account.

Optional keywords

• additional_types::String : "track" (default) or "episode"
• market::String : An ISO 3166-1 alpha-2 country code. If a country code is specified, only episodes that are available in that market will be returned. Default is set to "US".

Example

julia> Spotify.player_get_current_track()[1]
[ Info: We try the request without checking if current grant includes scope user-read-playback-state.
JSON3.Object{Base.CodeUnits{UInt8, String}, Vector{UInt64}} with 7 entries:
  :timestamp              => 1636491068506
  :context                => {…
  :progress_ms            => 5265
  :item                   => {…
  :currently_playing_type => "track"
  :actions                => {…
  :is_playing             => true

player_get_devices()

Summary: Get information about a user’s available devices.

Example

julia> Spotify.player_get_devices()[1]["devices"]
2-element JSON3.Array{JSON3.Object, Base.CodeUnits{UInt8, String}, SubArray{UInt64, 1, Vector{UInt64}, Tuple{UnitRange{Int64}}, true}}:
{
                   "id": "your_device_id",
            "is_active": false,
   "is_private_session": false,
        "is_restricted": false,
                 "name": "Web Player (Chrome)",
                 "type": "Computer",
       "volume_percent": 100
}

player_get_state(;additional_types::String="track", market::String="US")

Summary: Get information about the user’s current playback state, including track or episode, progress, and active device.

Optional keywords

• additional_types::String : "track" (default) or "episode"
• market::String : An ISO 3166-1 alpha-2 country code. If a country code is specified, only episodes that are available in that market will be returned. Default is set to "US".

Example

julia> Spotify.player_get_state()[1]
[ Info: We try the request without checking if current grant includes scope user-read-playback-state.
JSON3.Object{Base.CodeUnits{UInt8, String}, Vector{UInt64}} with 10 entries:
  :device                 => {…
  :shuffle_state          => false
  :repeat_state           => "off"
  :timestamp              => 1636493367689
  :context                => {…
  :progress_ms            => 66454
  :item                   => {…
  :currently_playing_type => "track"
  :actions                => {…
  :is_playing             => true

Get Recommendations Based on Seeds

seeds: (Required) A dictionary containing keys(seedgenres, seedartists, seed_tracks) and values for each key being seeds delimeted by a comma up to 5 seeds for each category

Example

Dict("seedartists" => "s33dart1st,s33edart!st2", "seedgenres" => "g3nre1,genr32", "seed_tracks" => "trackid1,trackid2")

trackattributes: (Optional) a dictionary containing key values for different tunable track trackattributes

See https://developer.spotify.com/documentation/web-api/reference/browse/get-recommendations/

spotify_request(url_ext::String, method::String= "GET"; scope = "client-credentials")
 -> (r::JSON3.Object, retry_in_seconds::Int)

Access the Spotify Web API. Error results return an empty Object. Errors are written to 'stderr', expect for 'API rate limit exceeded', as the output would typically occur in the middle of recursive calls.

strip_embed_code(sdvs<substring>)
-> Spid(<substring>)

Get the interesting part for pasting:

Spotify app -> Right click -> Share -> Copy embed code to clipboard

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request targetenergy=0.6 and targetdanceability=0.8. All target values will be weighed equally in ranking results.

A stateful browser counter.

All web API arguments are strings, but types SpUri, SpId, CategoryId, SpUserId, SpUrl aids in picking default values. format

All web API arguments are strings, but types SpUri, SpId, CategoryId, SpUserId, SpUrl aids in picking default values. format

All web API arguments are strings, but types SpUri, SpId, CategoryId, SpUserId, SpUrl aids in picking default values. format

All web API arguments are strings, but types SpUri, SpId, CategoryId, SpUserId, SpUrl aids in picking default values. format

All web API arguments are strings, but types SpUri, SpId, CategoryId, SpUserId, SpUrl aids in picking default values. format

All web API arguments are strings, but types SpUri, SpId, CategoryId, SpUserId, SpUrl aids in picking default values. format

All web API arguments are strings, but types SpUri, SpId, CategoryId, SpUserId, SpUrl aids in picking default values. format

All web API arguments are strings, but types SpUri, SpId, CategoryId, SpUserId, SpUrl aids in picking default values. format

For the client credentials flow

A list of potentially available browsers, to be tried in succession if present

For next value: COUNTBROWSER(). For current value: COUNTBROWSER.value

These permissions are not requested until the current scope is insufficient, or the user calls 'getimplicitgrant()'

Default requested permissions are 'client-credentials'.

For the 'Implicit grant flow