From 1f54414876fada4f577994f0872edadc3df900df Mon Sep 17 00:00:00 2001 From: AppVeyor Doc Generation Date: Wed, 29 Apr 2020 10:13:52 +0000 Subject: [PATCH] Built docs | AppVeyor Build 589 --- assets/js/{19.a6196abf.js => 19.70cf2c90.js} | 2 +- assets/js/{22.a4edf47c.js => 22.b2427986.js} | 2 +- assets/js/{app.89ff9b8f.js => app.b18eecc7.js} | 8 ++++---- auth/authorization_code.html | 6 +++--- auth/client_credentials.html | 6 +++--- auth/getting_started.html | 6 +++--- auth/implicit_grant.html | 6 +++--- auth/token_swap.html | 6 +++--- index.html | 6 +++--- web/albums.html | 6 +++--- web/artists.html | 6 +++--- web/browse.html | 6 +++--- web/examples.html | 6 +++--- web/follow.html | 6 +++--- web/getting_started.html | 6 +++--- web/library.html | 6 +++--- web/personalization.html | 6 +++--- web/player.html | 6 +++--- web/playlists.html | 6 +++--- web/profiles.html | 6 +++--- web/proxy.html | 6 +++--- web/search.html | 6 +++--- web/tracks.html | 6 +++--- web/utils.html | 6 +++--- 24 files changed, 69 insertions(+), 69 deletions(-) rename assets/js/{19.a6196abf.js => 19.70cf2c90.js} (99%) rename assets/js/{22.a4edf47c.js => 22.b2427986.js} (97%) rename assets/js/{app.89ff9b8f.js => app.b18eecc7.js} (86%) diff --git a/assets/js/19.a6196abf.js b/assets/js/19.70cf2c90.js similarity index 99% rename from assets/js/19.a6196abf.js rename to assets/js/19.70cf2c90.js index 1e278751..3acca120 100644 --- a/assets/js/19.a6196abf.js +++ b/assets/js/19.70cf2c90.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{263:function(t,a,e){"use strict";e.r(a);var s=e(28),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"player"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#player","aria-hidden":"true"}},[t._v("#")]),t._v(" Player")]),t._v(" "),e("h2",{attrs:{id:"getdevices"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdevices","aria-hidden":"true"}},[t._v("#")]),t._v(" GetDevices")]),t._v(" "),e("blockquote",[e("p",[t._v("Get information about a user’s available devices.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody")]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("AvailabeDevices")]),t._v(" devices "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("GetDevices")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ndevices"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Devices"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("ForEach")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("device "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" Console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("WriteLine")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("device"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Name"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"getplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" GetPlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Get information about the user’s current playback state, including track, track progress, and active device.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[market]")]),t._v(" "),e("td",[t._v("An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.")]),t._v(" "),e("td",[e("code",[t._v('"DE"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("PlaybackContext")]),t._v(" context "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("GetPlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("contex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Item "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n Console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("WriteLine")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Item"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Name"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//Print the current song")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"getplayingtrack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getplayingtrack","aria-hidden":"true"}},[t._v("#")]),t._v(" GetPlayingTrack")]),t._v(" "),e("blockquote",[e("p",[t._v("Get the object currently being played on the user’s Spotify account.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[market]")]),t._v(" "),e("td",[t._v("An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.")]),t._v(" "),e("td",[e("code",[t._v('"DE"')])])])])]),t._v(" "),e("p",[t._v("This is a simpler (less data) version of "),e("code",[t._v("GetPlayback")])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("PlaybackContext")]),t._v(" context "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("GetPlayingTrack")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("contex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Item "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n Console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("WriteLine")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Item"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Name"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//Print the current song")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"transferplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transferplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" TransferPlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Transfer playback to a new device and determine if it should start playing.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("deviceIds or deviceId")]),t._v(" "),e("td",[t._v("A JSON array containing the ID of the device on which playback should be started/transferred")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])]),t._v(" "),e("tr",[e("td",[t._v("play")]),t._v(" "),e("td",[t._v("true: ensure playback happens on new device, false: keep current playback state")]),t._v(" "),e("td",[e("code",[t._v("true")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("TransferPlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"XXXX-XXXX-XXXX-XXXX"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"resumeplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resumeplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" ResumePlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Start a new context or resume current playback on the user’s active device.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])]),t._v(" "),e("tr",[e("td",[t._v("contextUri")]),t._v(" "),e("td",[t._v("Spotify URI of the context to play")]),t._v(" "),e("td",[e("code",[t._v('"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"')])])]),t._v(" "),e("tr",[e("td",[t._v("uris")]),t._v(" "),e("td",[t._v("An array of the Spotify track URIs to play.")]),t._v(" "),e("td",[e("code",[t._v('new List { "spotify:track:4iV5W9uYEdYUVa79Axb7Rh" }')])])]),t._v(" "),e("tr",[e("td",[t._v("offset")]),t._v(" "),e("td",[t._v("Indicates from where in the context playback should start. Only available when context_uri corresponds to an album or playlist object, or when the uris parameter is used.")]),t._v(" "),e("td",[e("code",[t._v("0")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("ResumePlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("uris"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("List")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("string")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"spotify:track:4iV5W9uYEdYUVa79Axb7Rh"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"pauseplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pauseplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" PausePlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Pause playback on the user’s account.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("PausePlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"skipplaybacktonext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#skipplaybacktonext","aria-hidden":"true"}},[t._v("#")]),t._v(" SkipPlaybackToNext")]),t._v(" "),e("blockquote",[e("p",[t._v("Skips to next track in the user’s queue.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SkipPlaybackToNext")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"skipplaybacktoprevious"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#skipplaybacktoprevious","aria-hidden":"true"}},[t._v("#")]),t._v(" SkipPlaybackToPrevious")]),t._v(" "),e("blockquote",[e("p",[t._v("Skips to previous track in the user’s queue.\nNote that this will ALWAYS skip to the previous track, regardless of the current track’s progress.\nReturning to the start of the current track should be performed using the https://api.spotify.com/v1/me/player/seek endpoint.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SkipPlaybackToPrevious")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"seekplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#seekplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" SeekPlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Seeks to the given position in the user’s currently playing track.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("positionMs")]),t._v(" "),e("td",[t._v("The position in milliseconds to seek to. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.")]),t._v(" "),e("td",[e("code",[t._v("50")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SeekPlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"setrepeatmode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setrepeatmode","aria-hidden":"true"}},[t._v("#")]),t._v(" SetRepeatMode")]),t._v(" "),e("blockquote",[e("p",[t._v("Set the repeat mode for the user’s playback. Options are repeat-track, repeat-context, and off.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("state")]),t._v(" "),e("td",[t._v("track, context or off.")]),t._v(" "),e("td",[e("code",[t._v("RepeatState.Track")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SetRepeatMode")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("RepeatState"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Track"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"setvolume"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setvolume","aria-hidden":"true"}},[t._v("#")]),t._v(" SetVolume")]),t._v(" "),e("blockquote",[e("p",[t._v("Set the volume for the user’s current playback device.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("volumePercent")]),t._v(" "),e("td",[t._v("Integer. The volume to set. Must be a value from 0 to 100 inclusive.")]),t._v(" "),e("td",[e("code",[t._v("50")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SetVolume")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"setshuffle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setshuffle","aria-hidden":"true"}},[t._v("#")]),t._v(" SetShuffle")]),t._v(" "),e("blockquote",[e("p",[t._v("Toggle shuffle on or off for user’s playback.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("shuffle")]),t._v(" "),e("td",[t._v("True or False")]),t._v(" "),e("td",[e("code",[t._v("false")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SetShuffle")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("false")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"addtoqueue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addtoqueue","aria-hidden":"true"}},[t._v("#")]),t._v(" AddToQueue")]),t._v(" "),e("blockquote",[e("p",[t._v("Add an Item to the User's Playback Queue. BETA.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("uri")]),t._v(" "),e("td",[t._v("The uri of the item to add to the queue. Must be a track or an episode uri.")]),t._v(" "),e("td",[e("code",[t._v("spotify:track:7zrCVKp6x0AtolOsn2iMif")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("AddToQueue")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"spotify:track:7zrCVKp6x0AtolOsn2iMif"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{265:function(t,a,e){"use strict";e.r(a);var s=e(28),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"player"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#player","aria-hidden":"true"}},[t._v("#")]),t._v(" Player")]),t._v(" "),e("h2",{attrs:{id:"getdevices"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdevices","aria-hidden":"true"}},[t._v("#")]),t._v(" GetDevices")]),t._v(" "),e("blockquote",[e("p",[t._v("Get information about a user’s available devices.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody")]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("AvailabeDevices")]),t._v(" devices "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("GetDevices")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ndevices"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Devices"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("ForEach")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("device "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" Console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("WriteLine")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("device"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Name"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"getplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" GetPlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Get information about the user’s current playback state, including track, track progress, and active device.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[market]")]),t._v(" "),e("td",[t._v("An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.")]),t._v(" "),e("td",[e("code",[t._v('"DE"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("PlaybackContext")]),t._v(" context "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("GetPlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("contex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Item "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n Console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("WriteLine")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Item"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Name"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//Print the current song")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"getplayingtrack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getplayingtrack","aria-hidden":"true"}},[t._v("#")]),t._v(" GetPlayingTrack")]),t._v(" "),e("blockquote",[e("p",[t._v("Get the object currently being played on the user’s Spotify account.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[market]")]),t._v(" "),e("td",[t._v("An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.")]),t._v(" "),e("td",[e("code",[t._v('"DE"')])])])])]),t._v(" "),e("p",[t._v("This is a simpler (less data) version of "),e("code",[t._v("GetPlayback")])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("PlaybackContext")]),t._v(" context "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("GetPlayingTrack")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("contex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Item "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n Console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("WriteLine")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Item"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Name"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//Print the current song")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"transferplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transferplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" TransferPlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Transfer playback to a new device and determine if it should start playing.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("deviceIds or deviceId")]),t._v(" "),e("td",[t._v("A JSON array containing the ID of the device on which playback should be started/transferred")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])]),t._v(" "),e("tr",[e("td",[t._v("play")]),t._v(" "),e("td",[t._v("true: ensure playback happens on new device, false: keep current playback state")]),t._v(" "),e("td",[e("code",[t._v("true")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("TransferPlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"XXXX-XXXX-XXXX-XXXX"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"resumeplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resumeplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" ResumePlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Start a new context or resume current playback on the user’s active device.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])]),t._v(" "),e("tr",[e("td",[t._v("contextUri")]),t._v(" "),e("td",[t._v("Spotify URI of the context to play")]),t._v(" "),e("td",[e("code",[t._v('"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"')])])]),t._v(" "),e("tr",[e("td",[t._v("uris")]),t._v(" "),e("td",[t._v("An array of the Spotify track URIs to play.")]),t._v(" "),e("td",[e("code",[t._v('new List { "spotify:track:4iV5W9uYEdYUVa79Axb7Rh" }')])])]),t._v(" "),e("tr",[e("td",[t._v("offset")]),t._v(" "),e("td",[t._v("Indicates from where in the context playback should start. Only available when context_uri corresponds to an album or playlist object, or when the uris parameter is used.")]),t._v(" "),e("td",[e("code",[t._v("0")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("ResumePlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("uris"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("List")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("string")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"spotify:track:4iV5W9uYEdYUVa79Axb7Rh"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"pauseplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pauseplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" PausePlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Pause playback on the user’s account.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("PausePlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"skipplaybacktonext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#skipplaybacktonext","aria-hidden":"true"}},[t._v("#")]),t._v(" SkipPlaybackToNext")]),t._v(" "),e("blockquote",[e("p",[t._v("Skips to next track in the user’s queue.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SkipPlaybackToNext")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"skipplaybacktoprevious"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#skipplaybacktoprevious","aria-hidden":"true"}},[t._v("#")]),t._v(" SkipPlaybackToPrevious")]),t._v(" "),e("blockquote",[e("p",[t._v("Skips to previous track in the user’s queue.\nNote that this will ALWAYS skip to the previous track, regardless of the current track’s progress.\nReturning to the start of the current track should be performed using the https://api.spotify.com/v1/me/player/seek endpoint.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SkipPlaybackToPrevious")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"seekplayback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#seekplayback","aria-hidden":"true"}},[t._v("#")]),t._v(" SeekPlayback")]),t._v(" "),e("blockquote",[e("p",[t._v("Seeks to the given position in the user’s currently playing track.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("positionMs")]),t._v(" "),e("td",[t._v("The position in milliseconds to seek to. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.")]),t._v(" "),e("td",[e("code",[t._v("50")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SeekPlayback")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"setrepeatmode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setrepeatmode","aria-hidden":"true"}},[t._v("#")]),t._v(" SetRepeatMode")]),t._v(" "),e("blockquote",[e("p",[t._v("Set the repeat mode for the user’s playback. Options are repeat-track, repeat-context, and off.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("state")]),t._v(" "),e("td",[t._v("track, context or off.")]),t._v(" "),e("td",[e("code",[t._v("RepeatState.Track")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SetRepeatMode")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("RepeatState"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Track"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"setvolume"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setvolume","aria-hidden":"true"}},[t._v("#")]),t._v(" SetVolume")]),t._v(" "),e("blockquote",[e("p",[t._v("Set the volume for the user’s current playback device.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("volumePercent")]),t._v(" "),e("td",[t._v("Integer. The volume to set. Must be a value from 0 to 100 inclusive.")]),t._v(" "),e("td",[e("code",[t._v("50")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SetVolume")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"setshuffle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setshuffle","aria-hidden":"true"}},[t._v("#")]),t._v(" SetShuffle")]),t._v(" "),e("blockquote",[e("p",[t._v("Toggle shuffle on or off for user’s playback.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("shuffle")]),t._v(" "),e("td",[t._v("True or False")]),t._v(" "),e("td",[e("code",[t._v("false")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("SetShuffle")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("false")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("hr"),t._v(" "),e("h2",{attrs:{id:"addtoqueue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addtoqueue","aria-hidden":"true"}},[t._v("#")]),t._v(" AddToQueue")]),t._v(" "),e("blockquote",[e("p",[t._v("Add an Item to the User's Playback Queue. BETA.")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Example")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("uri")]),t._v(" "),e("td",[t._v("The uri of the item to add to the queue. Must be a track or an episode uri.")]),t._v(" "),e("td",[e("code",[t._v("spotify:track:7zrCVKp6x0AtolOsn2iMif")])])]),t._v(" "),e("tr",[e("td",[t._v("[deviceId]")]),t._v(" "),e("td",[t._v("The id of the device this command is targeting. If not supplied, the user's currently active device is the target.")]),t._v(" "),e("td",[e("code",[t._v('"XXXX-XXXX-XXXX-XXXX"')])])])])]),t._v(" "),e("p",[e("strong",[t._v("Usage")])]),t._v(" "),e("div",{staticClass:"language-csharp extra-class"},[e("pre",{pre:!0,attrs:{class:"language-csharp"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ErrorResponse")]),t._v(" error "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" _spotify"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("AddToQueue")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"spotify:track:7zrCVKp6x0AtolOsn2iMif"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/22.a4edf47c.js b/assets/js/22.b2427986.js similarity index 97% rename from assets/js/22.a4edf47c.js rename to assets/js/22.b2427986.js index 91efb023..91f1175a 100644 --- a/assets/js/22.a4edf47c.js +++ b/assets/js/22.b2427986.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{265:function(t,s,a){"use strict";a.r(s);var n=a(28),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"proxy-settings"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#proxy-settings","aria-hidden":"true"}},[t._v("#")]),t._v(" Proxy Settings")]),t._v(" "),a("p",[t._v("You can forward your proxy settings to the web api by using a field in the "),a("code",[t._v("SpotifyLocalAPIConfig")]),t._v(".")]),t._v(" "),a("div",{staticClass:"language-csharp extra-class"},[a("pre",{pre:!0,attrs:{class:"language-csharp"}},[a("code",[a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ProxyConfig")]),t._v(" proxyConfig "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ProxyConfig")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n Host "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"127.0.0.1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n Port "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("8080")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Additional values like Username and Password are available")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("SpotifyWebAPI")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("SpotifyWebAPI")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("proxyConfig"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{263:function(t,s,a){"use strict";a.r(s);var n=a(28),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"proxy-settings"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#proxy-settings","aria-hidden":"true"}},[t._v("#")]),t._v(" Proxy Settings")]),t._v(" "),a("p",[t._v("You can forward your proxy settings to the web api by using a field in the "),a("code",[t._v("SpotifyLocalAPIConfig")]),t._v(".")]),t._v(" "),a("div",{staticClass:"language-csharp extra-class"},[a("pre",{pre:!0,attrs:{class:"language-csharp"}},[a("code",[a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ProxyConfig")]),t._v(" proxyConfig "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ProxyConfig")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n Host "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"127.0.0.1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n Port "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("8080")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Additional values like Username and Password are available")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("SpotifyWebAPI")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("SpotifyWebAPI")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("proxyConfig"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/assets/js/app.89ff9b8f.js b/assets/js/app.b18eecc7.js similarity index 86% rename from assets/js/app.89ff9b8f.js rename to assets/js/app.b18eecc7.js index c31bbef8..14b543f6 100644 --- a/assets/js/app.89ff9b8f.js +++ b/assets/js/app.b18eecc7.js @@ -1,13 +1,13 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(t){function e(e){for(var r,a,s=e[0],u=e[1],c=e[2],f=0,p=[];f0?o(r(t),9007199254740991):0}},function(t,e,n){var r=n(3),o=n(9),i=n(5),a=n(47),s=n(73),u=n(19),c=u.get,l=u.enforce,f=String(String).split("String");(t.exports=function(t,e,n,s){var u=!!s&&!!s.unsafe,c=!!s&&!!s.enumerable,p=!!s&&!!s.noTargetGet;"function"==typeof n&&("string"!=typeof e||i(n,"name")||o(n,"name",e),l(n).source=f.join("string"==typeof e?e:"")),t!==r?(u?!p&&t[e]&&(c=!0):delete t[e],c?t[e]=n:o(t,e,n)):c?t[e]=n:a(e,n)})(Function.prototype,"toString",function(){return"function"==typeof this&&c(this).source||s(this)})},function(t,e,n){var r=n(16);t.exports=function(t){return Object(r(t))}},function(t,e,n){var r=n(53),o=n(13),i=n(114);r||o(Object.prototype,"toString",i,{unsafe:!0})},function(t,e){t.exports=function(t){if(null==t)throw TypeError("Can't call method on "+t);return t}},function(t,e,n){"use strict";var r=n(0),o=n(21).filter,i=n(45),a=n(11),s=i("filter"),u=a("filter");r({target:"Array",proto:!0,forced:!s||!u},{filter:function(t){return o(this,t,arguments.length>1?arguments[1]:void 0)}})},function(t,e,n){var r=n(6),o=n(70),i=n(22),a=n(10),s=n(31),u=n(5),c=n(71),l=Object.getOwnPropertyDescriptor;e.f=r?l:function(t,e){if(t=a(t),e=s(e,!0),c)try{return l(t,e)}catch(t){}if(u(t,e))return i(!o.f.call(t,e),t[e])}},function(t,e,n){var r,o,i,a=n(112),s=n(3),u=n(4),c=n(9),l=n(5),f=n(32),p=n(24),h=s.WeakMap;if(a){var d=new h,v=d.get,y=d.has,m=d.set;r=function(t,e){return m.call(d,t,e),e},o=function(t){return v.call(d,t)||{}},i=function(t){return y.call(d,t)}}else{var g=f("state");p[g]=!0,r=function(t,e){return c(t,g,e),e},o=function(t){return l(t,g)?t[g]:{}},i=function(t){return l(t,g)}}t.exports={set:r,get:o,has:i,enforce:function(t){return i(t)?o(t):r(t,{})},getterFor:function(t){return function(e){var n;if(!u(e)||(n=o(e)).type!==t)throw TypeError("Incompatible receiver, "+t+" required");return n}}}},function(t,e){t.exports=!1},function(t,e,n){var r=n(51),o=n(43),i=n(14),a=n(12),s=n(104),u=[].push,c=function(t){var e=1==t,n=2==t,c=3==t,l=4==t,f=6==t,p=5==t||f;return function(h,d,v,y){for(var m,g,b=i(h),w=o(b),_=r(d,v,3),x=a(w.length),k=0,S=y||s,O=e?S(h,x):n?S(h,0):void 0;x>k;k++)if((p||k in w)&&(g=_(m=w[k],k,b),t))if(e)O[k]=g;else if(g)switch(t){case 3:return!0;case 5:return m;case 6:return k;case 2:u.call(O,m)}else if(l)return!1;return f?-1:c||l?l:O}};t.exports={forEach:c(0),map:c(1),filter:c(2),some:c(3),every:c(4),find:c(5),findIndex:c(6)}},function(t,e){t.exports=function(t,e){return{enumerable:!(1&t),configurable:!(2&t),writable:!(4&t),value:e}}},function(t,e){var n={}.toString;t.exports=function(t){return n.call(t).slice(8,-1)}},function(t,e){t.exports={}},function(t,e,n){var r=n(77),o=n(3),i=function(t){return"function"==typeof t?t:void 0};t.exports=function(t,e){return arguments.length<2?i(r[t])||i(o[t]):r[t]&&r[t][e]||o[t]&&o[t][e]}},function(t,e,n){var r,o=n(8),i=n(116),a=n(50),s=n(24),u=n(117),c=n(72),l=n(32),f=l("IE_PROTO"),p=function(){},h=function(t){return" +
+ diff --git a/auth/client_credentials.html b/auth/client_credentials.html index ef1d872e..d351ab75 100644 --- a/auth/client_credentials.html +++ b/auth/client_credentials.html @@ -8,7 +8,7 @@ - + @@ -109,7 +109,7 @@ If you want to use it securely, you would need to do it all server-side. TokenType = token.TokenType, AccessToken = token.AccessToken }; -
- +
+ diff --git a/auth/getting_started.html b/auth/getting_started.html index cee5bb95..74674d4b 100644 --- a/auth/getting_started.html +++ b/auth/getting_started.html @@ -8,7 +8,7 @@ - + @@ -102,7 +102,7 @@ 🚀 GitHub

Getting Started

Auth-Methods

Before you can use the Web API's full functionality, you need the user to authenticate your Application. If you want to know more, you can read to the whole auth-process here.

Before you start, install SpotifyAPI.Web.Auth and create an application at Spotify: Your Applications

After you have created your Application, you will have following important values:

Name Description
Client_Id This is your client_id, you don't have to hide it
Client_Secret Never use this in one of your client-side apps! Keep it secret!
Redirect URIs Some of auth flows require that you set the correct redirect URI

Now you can start with the user-authentication. Spotify provides 3 ways (4 if you consider different implementations):

Overview: -Overview

- +Overview

+ diff --git a/auth/implicit_grant.html b/auth/implicit_grant.html index 3d1410a7..8dd5cdad 100644 --- a/auth/implicit_grant.html +++ b/auth/implicit_grant.html @@ -8,7 +8,7 @@ - + @@ -122,7 +122,7 @@ You won't be able to refresh the token. If you want to use the internal Http ser auth.Start(); // Starts an internal HTTP Server auth.OpenBrowser(); } -
- +
+ diff --git a/auth/token_swap.html b/auth/token_swap.html index 57f83bda..9b2bdea2 100644 --- a/auth/token_swap.html +++ b/auth/token_swap.html @@ -8,7 +8,7 @@ - + @@ -152,7 +152,7 @@ auth.AuthReceived .OnAccessTokenExpired += async (sender, e) => spotify.AccessToken = (await auth.RefreshAuthAsync(lastToken.RefreshToken)).AccessToken; auth.Start(); auth.OpenBrowser(); -

Token Swap Endpoint

To keep your client secret completely secure and your client ID and redirect URI as secure as possible, use of a web server (such as a php website) is required.

To use this method, an external HTTP Server (that you may need to create) needs to be able to supply the following HTTP Endpoints to your application:

/swap - Swaps out an authorization_code with an access_token and refresh_token - The following parameters are required in the JSON POST Body:

  • grant_type (set to "authorization_code")
  • code (the authorization_code)
  • redirect_uri
    • Important The page that the redirect URI links to must return the authorization code json to your serverUri (default is 'http://localhost:4002') but to the folder 'auth', like this: 'http://localhost:4002/auth'.

/refresh - Refreshes an access_token - The following parameters are required in the JSON POST Body:

  • grant_type (set to "refresh_token")
  • refresh_token

The following open-source token swap endpoint code can be used for your website:

Remarks

It should be noted that GitHub Pages does not support hosting php scripts. Hosting php scripts through it will cause the php to render as plain HTML, potentially compromising your client secret while doing absolutely nothing.

Be sure you have whitelisted your redirect uri in the Spotify Developer Dashboard otherwise the authorization will always fail.

If you did not use the WebAPIFactory or you provided a serverUri different from its default, you must make sure your redirect uri's script at your endpoint will properly redirect to your serverUri (such as changing the areas which refer to localhost:4002 if you had changed serverUri from its default), otherwise it will never reach your new serverUri.

- +

Token Swap Endpoint

To keep your client secret completely secure and your client ID and redirect URI as secure as possible, use of a web server (such as a php website) is required.

To use this method, an external HTTP Server (that you may need to create) needs to be able to supply the following HTTP Endpoints to your application:

/swap - Swaps out an authorization_code with an access_token and refresh_token - The following parameters are required in the JSON POST Body:

  • grant_type (set to "authorization_code")
  • code (the authorization_code)
  • redirect_uri
    • Important The page that the redirect URI links to must return the authorization code json to your serverUri (default is 'http://localhost:4002') but to the folder 'auth', like this: 'http://localhost:4002/auth'.

/refresh - Refreshes an access_token - The following parameters are required in the JSON POST Body:

  • grant_type (set to "refresh_token")
  • refresh_token

The following open-source token swap endpoint code can be used for your website:

Remarks

It should be noted that GitHub Pages does not support hosting php scripts. Hosting php scripts through it will cause the php to render as plain HTML, potentially compromising your client secret while doing absolutely nothing.

Be sure you have whitelisted your redirect uri in the Spotify Developer Dashboard otherwise the authorization will always fail.

If you did not use the WebAPIFactory or you provided a serverUri different from its default, you must make sure your redirect uri's script at your endpoint will properly redirect to your serverUri (such as changing the areas which refer to localhost:4002 if you had changed serverUri from its default), otherwise it will never reach your new serverUri.

+ diff --git a/index.html b/index.html index 96791382..88d1f75a 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ - + @@ -103,7 +103,7 @@

SpotifyAPI-NET Docs

About

This project, written in C#/.NET, provides 2 libraries for an easier usage of the Spotify Web API

Spotify's Web API (link)

Based on simple REST principles, our Web API endpoints return metadata in JSON format about artists, albums, and tracks directly from the Spotify catalogue. The API also provides access to user-related data such as playlists and music saved in a “Your Music” library, subject to user’s authorization.

SpotifyAPI.Web

A wrapper around Spotify's Web API, providing sync and async methods to query all possible endpoints. Results are returned as typed class instances, allowing property-based access.

SpotifyAPI.Web.Auth

A library providing C# implementations of the 3 supported Authentication modes, including ImplicitGrantAuth, AuthorizationCodeAuth and CredentialsAuth

Installing

  • Via NuGet Package:
Install-Package SpotifyAPI.Web
 Install-Package SpotifyAPI.Web.Auth
-
  • Download the latest binaries on the GitHub Release Page and add it to your Project
  • Clone the Repo and build the project yourself.

Getting Started

Projects

lidarr by @lidarr

Looks and smells like Sonarr but made for music.

botframework-solutions by @microsoft

home for a set of templates and solutions to help build advanced conversational experiences using Azure Bot Service and Bot Framework

Spytify by @jwallet

Records Spotify to mp3 without ads while it plays and includes media tags to the recorded files

audio-band by @dsafa

Display and control songs from the Windows taskbar

rocksmith-custom-song-toolkit by @catara

MASS Manipulation of Rocksmith DLC Library

Spofy by @eltoncezar

A Spotify mini player and notifier for Windows

Toastify by @aleab

Toastify adds global hotkeys and toast notifications to Spotify

Forked from nachmore/toastify

Spotify Oculus by @CaptainMorgs

Unity project for interacting with Spotify in virtual reality for the Oculus Rift.

Songify by @Inzaniity

A simple tool that gets the current track from Spotify, YouTube and Nightbot.

Elite G19s Companion app by @MagicMau

Main features include: system and station overview, play radio and podcast with audio visualizations, simulated Space Traffic Control, GPS functionality (including planetary races), an orrery view, a screenshot converter, and a news ticker.

ARDUINO-Spotify-Remote-Control by @NADER11NDEU

Well, with this project we will be able to control active spotify devices with Arduino. How we gonna do that ? We will use serial communication.

- +
  • Download the latest binaries on the GitHub Release Page and add it to your Project
  • Clone the Repo and build the project yourself.

Getting Started

Projects

lidarr by @lidarr

Looks and smells like Sonarr but made for music.

botframework-solutions by @microsoft

home for a set of templates and solutions to help build advanced conversational experiences using Azure Bot Service and Bot Framework

Spytify by @jwallet

Records Spotify to mp3 without ads while it plays and includes media tags to the recorded files

audio-band by @dsafa

Display and control songs from the Windows taskbar

rocksmith-custom-song-toolkit by @catara

MASS Manipulation of Rocksmith DLC Library

Spofy by @eltoncezar

A Spotify mini player and notifier for Windows

Toastify by @aleab

Toastify adds global hotkeys and toast notifications to Spotify

Forked from nachmore/toastify

Spotify Oculus by @CaptainMorgs

Unity project for interacting with Spotify in virtual reality for the Oculus Rift.

Songify by @Inzaniity

A simple tool that gets the current track from Spotify, YouTube and Nightbot.

Elite G19s Companion app by @MagicMau

Main features include: system and station overview, play radio and podcast with audio visualizations, simulated Space Traffic Control, GPS functionality (including planetary races), an orrery view, a screenshot converter, and a news ticker.

ARDUINO-Spotify-Remote-Control by @NADER11NDEU

Well, with this project we will be able to control active spotify devices with Arduino. How we gonna do that ? We will use serial communication.

+ diff --git a/web/albums.html b/web/albums.html index 9e5cb077..12c9c601 100644 --- a/web/albums.html +++ b/web/albums.html @@ -8,7 +8,7 @@ - + @@ -107,7 +107,7 @@ Console.Writ Console.WriteLine(album.Name + "| Popularity: " + album.Popularity); //Display name and Popularity

GetSeveralAlbums

Get Spotify catalog information for multiple albums identified by their Spotify IDs.

Parameters

Name Description Example
ids A list of the Spotify IDs for the albums. Maximum: 20 IDs. new List<String>() { "5O7V8l4SeXTymVp3IesT9C" }
[market] An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking. "DE"

Returns a SeveralAlbums which Property "Albums" contains a list of FullAlbum

Usage

SeveralAlbums albums = _spotify.GetSeveralAlbums(new List<String>() { "5O7V8l4SeXTymVp3IesT9C" });
 Console.WriteLine(albums.Albums[0].Name);
-
- +
+ diff --git a/web/artists.html b/web/artists.html index 6744a771..31c7116f 100644 --- a/web/artists.html +++ b/web/artists.html @@ -8,7 +8,7 @@ - + @@ -110,7 +110,7 @@ Console.Writ albums.Items.ForEach(album => Console.WriteLine(album.Name));

GetSeveralArtists

Get Spotify catalog information for several artists based on their Spotify IDs.

Parameters

Name Description Example
ids A list of the Spotify IDs for the artists. Maximum: 50 IDs. new List<String>() { "1KpCi9BOfviCVhmpI4G2sY" }

Returns a SeveralArtists object which contains the property List<FullArtist> Artists (FullArtist)

Usage

SeveralArtists artists = _spotify.GetSeveralArtists(new List<String>() {"1KpCi9BOfviCVhmpI4G2sY"});
 artists.Artists.ForEach(artist => Console.WriteLine(artist.Name));
-
- +
+ diff --git a/web/browse.html b/web/browse.html index cb0aa275..4168b3d8 100644 --- a/web/browse.html +++ b/web/browse.html @@ -8,7 +8,7 @@ - + @@ -111,7 +111,7 @@ categoryList.Categories.WriteLine(cat.Name);

GetCategoryPlaylists

Get a list of Spotify playlists tagged with a particular category.

Parameters

Name Description Example
categoryId The Spotify category ID for the category. "party"
[country] A country: an ISO 3166-1 alpha-2 country code. "DE"
[limit] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. 20
[offset] The index of the first item to return. Default: 0 0

Returns a CategoryPlaylist object, which has the property Paging<SimplePlaylist> Playlists

Usage

CategoryPlaylist playlists = _spotify.GetCategoryPlaylists("party");
 playlists.Playlists.Items.ForEach(playlist => Console.WriteLine(playlist.Name));
-
- +
+ diff --git a/web/examples.html b/web/examples.html index 2adc0e1a..1efa3f6a 100644 --- a/web/examples.html +++ b/web/examples.html @@ -8,7 +8,7 @@ - + @@ -100,7 +100,7 @@ - ClientCredentialsAuth 🚀 GitHub -

  • Examples

Examples

This page is currently empty. Do you have useful examples? Please open a PR

- +

  • Examples

Examples

This page is currently empty. Do you have useful examples? Please open a PR

+ diff --git a/web/follow.html b/web/follow.html index 29b05782..b81d3ad2 100644 --- a/web/follow.html +++ b/web/follow.html @@ -8,7 +8,7 @@ - + @@ -118,7 +118,7 @@ Console.Writ

IsFollowingPlaylist

Check to see if one or more Spotify users are following a specified playlist.

Parameters

Name Description Example
ownerId The Spotify user ID of the person who owns the playlist. "maxloermans"
playlistId The Spotify ID of the playlist. "3SIp2VAsKI03mReF0dFBmI"
ids or id A list of the artist or the user Spotify IDs or just a Spotify ID new List<String> { "1KpCi9BOfviCVhmpI4G2sY" } or "1KpCi9BOfviCVhmpI4G2sY"

Returns a ListResponse<Boolean> which contains the property List<Boolean> List

Usage

//Am I following the playlist?
 ListResponse<Boolean> response = _spotify.IsFollowing("maxloermans", "3SIp2VAsKI03mReF0dFBmI", "1122095781");
 Console.WriteLine(response.List[0] ? "Yis!" : "No :(");
-
- +
+ diff --git a/web/getting_started.html b/web/getting_started.html index 3b6d591e..15215497 100644 --- a/web/getting_started.html +++ b/web/getting_started.html @@ -8,7 +8,7 @@ - + @@ -135,7 +135,7 @@ _spotify = newvar asyncProfile = await _spotify.GetPrivateProfileAsync(); var syncProfile = _spotify.GetPrivateProfile(); } -

Note that the synchronous call will block the current Thread!

API-Reference

Albums

Artists

Browse

Follow

Library

Personalization

Player

Playlists

Profiles

Tracks

Util

- +

Note that the synchronous call will block the current Thread!

API-Reference

Albums

Artists

Browse

Follow

Library

Personalization

Player

Playlists

Profiles

Tracks

Util

+ diff --git a/web/library.html b/web/library.html index 7c761b22..d8dd2b05 100644 --- a/web/library.html +++ b/web/library.html @@ -8,7 +8,7 @@ - + @@ -128,7 +128,7 @@ savedAlbums.Items CheckSavedAlbums

Check if one or more albums is already saved in the current Spotify user’s “Your Music” library.

Parameters

Name Description Example
ids A list of the Spotify IDs. new List<String> { "1cq06d0kTUnFmJHixz1RaF" }

Returns a ListResponse<bool> which contains a property, List<bool> List

Usage

ListResponse<bool> albumsSaved = _spotify.CheckSavedAlbums(new List<String> { "1cq06d0kTUnFmJHixz1RaF" });
 if(albumsSaved.List[0])
     Console.WriteLine("The album is in your library!");
-
- +
+ diff --git a/web/personalization.html b/web/personalization.html index 9746037a..e506057e 100644 --- a/web/personalization.html +++ b/web/personalization.html @@ -8,7 +8,7 @@ - + @@ -107,7 +107,7 @@ Console.WriteLine(tracks.Total.ToString()) //Display total album track count artists.Items.ForEach(item => Console.WriteLine(item.Name)); //Display all fetched Artist-Names (max 20)

GetUsersRecentlyPlayedTracks

Get tracks from the current user’s recent play history.

Parameters

Name Description Example
[limit] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. 20
[after] Returns all items after (but not including) this cursor position. DateTime.Now.AddDays(-1)
[before] Returns all items before (but not including) this cursor position. DateTime.Now.AddDays(-1)

Returns a PlayHistory wrapped inside a CursorPaging-object

Usage

CursorPaging<PlayHistory> histories = _spotify.GetUsersRecentlyPlayedTracks();
 histories.Items.ForEach(item => Console.WriteLine(item.Track.Name));
-
- +
+ diff --git a/web/player.html b/web/player.html index e56fac19..efe42bda 100644 --- a/web/player.html +++ b/web/player.html @@ -8,7 +8,7 @@ - + @@ -120,7 +120,7 @@ Returning to the start of the current track should be performed using the https:

SetVolume

Set the volume for the user’s current playback device.

Parameters

Name Description Example
volumePercent Integer. The volume to set. Must be a value from 0 to 100 inclusive. 50
[deviceId] The id of the device this command is targeting. If not supplied, the user's currently active device is the target. "XXXX-XXXX-XXXX-XXXX"

Usage

ErrorResponse error = _spotify.SetVolume(50);

SetShuffle

Toggle shuffle on or off for user’s playback.

Parameters

Name Description Example
shuffle True or False false
[deviceId] The id of the device this command is targeting. If not supplied, the user's currently active device is the target. "XXXX-XXXX-XXXX-XXXX"

Usage

ErrorResponse error = _spotify.SetShuffle(false);

AddToQueue

Add an Item to the User's Playback Queue. BETA.

Parameters

Name Description Example
uri The uri of the item to add to the queue. Must be a track or an episode uri. spotify:track:7zrCVKp6x0AtolOsn2iMif
[deviceId] The id of the device this command is targeting. If not supplied, the user's currently active device is the target. "XXXX-XXXX-XXXX-XXXX"

Usage

ErrorResponse error = _spotify.AddToQueue("spotify:track:7zrCVKp6x0AtolOsn2iMif");
-
- +
+ diff --git a/web/playlists.html b/web/playlists.html index d1effa29..5fa91622 100644 --- a/web/playlists.html +++ b/web/playlists.html @@ -8,7 +8,7 @@ - + @@ -140,7 +140,7 @@ playlist.Items ReorderPlaylist

Reorder a track or a group of tracks in a playlist. More Info: Reorder-Playlist

Parameters

Name Description Example
userId The user's Spotify user ID. "1122095781"
playlistId The Spotify ID for the playlist. "1TtEejT1y4D1WmcOnLfha2"
rangeStart The position of the first track to be reordered. 2
insertBefore The position where the tracks should be inserted. 0
[rangeLength] The amount of tracks to be reordered. Defaults to 1 if not set. 2
[snapshotId] The playlist's snapshot ID against which you want to make the changes. ``

Returns a Snapshot-Object which contains the property String SnapshotId

Usage

Snapshot snapshot = _spotify.ReorderPlaylist("1122095781", "1TtEejT1y4D1WmcOnLfha2", 2, 0, 2);
 Console.WriteLine("New SnapshotId: " + snapshot.SnapshotId);
-
- +
+ diff --git a/web/profiles.html b/web/profiles.html index b6578504..e7eca3eb 100644 --- a/web/profiles.html +++ b/web/profiles.html @@ -8,7 +8,7 @@ - + @@ -102,7 +102,7 @@ 🚀 GitHub

Profiles

GetPrivateProfile

Get detailed profile information about the current user (including the current user’s username).

Parameters

Name Description Example

Returns a PrivateProfile

Usage

PrivateUser user = _spotify.GetPrivateProfile();
 Console.WriteLine(user.DisplayName);
-

GetPublicProfile

Get public profile information about a Spotify user.

Parameters

Name Description Example
userId The user's Spotify user ID. EXAMPLE

Returns a PublicProfile

Usage

- +

GetPublicProfile

Get public profile information about a Spotify user.

Parameters

Name Description Example
userId The user's Spotify user ID. EXAMPLE

Returns a PublicProfile

Usage

+ diff --git a/web/proxy.html b/web/proxy.html index e9bb927e..410c9563 100644 --- a/web/proxy.html +++ b/web/proxy.html @@ -8,7 +8,7 @@ - + @@ -108,7 +108,7 @@ }; SpotifyWebAPI api = new SpotifyWebAPI(proxyConfig); -
- +
+ diff --git a/web/search.html b/web/search.html index edbfe05e..76ba2a80 100644 --- a/web/search.html +++ b/web/search.html @@ -8,7 +8,7 @@ - + @@ -102,7 +102,7 @@ 🚀 GitHub

Search

SearchItems

Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.

WARNING

You may want to use SearchItemsEscaped if you're processing user-input without validation

Parameters

Name Description Example
q The search query's keywords (and optional field filters and operators), for example q=roadhouse+blues. "roadhouse+blues"
type A list of item types to search across. SearchType.Album
[limit] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. 20
[offset] The index of the first result to return. Default: 0 0
[market] An ISO 3166-1 alpha-2 country code or the string from_token. "de"

Returns a SearchItem which contains the properties Paging<FullArtist> Artists,Paging<FullTrack> Tracks, Paging<SimpleAlbum> Albums, Paging<SimplePlaylist> Playlists. They are filled based on your search-type.

Usage

SearchItem item = _spotify.SearchItems("roadhouse+blues", SearchType.Album | SearchType.Playlist);
 Console.WriteLine(item.Albums.Total); //How many results are there in total? NOTE: item.Tracks = item.Artists = null
-

SearchItemsEscaped

Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.

Works like SearchItems, but URL escapes all characters

- +

SearchItemsEscaped

Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.

Works like SearchItems, but URL escapes all characters

+ diff --git a/web/tracks.html b/web/tracks.html index 899084e6..f7bdd35b 100644 --- a/web/tracks.html +++ b/web/tracks.html @@ -8,7 +8,7 @@ - + @@ -106,7 +106,7 @@ severalTracks.Tracks.WriteLine(track.Name);

GetAudioAnalysis

Get a detailed audio analysis for a single track identified by its unique Spotify ID.

Parameters

Name Description Example
id The Spotify ID for the track. "6Y1CLPwYe7zvI8PJiWVz6T"

Returns a AudioAnalysis. This object is currently lacking Spotify documentation but archived EchoNest documentation is relevant.

Usage

AudioAnalysis analysis = _spotify.GetAudioAnalysis("6Y1CLPwYe7zvI8PJiWVz6T");
 Console.WriteLine(analysis.Meta.DetailedStatus);
-
- +
+ diff --git a/web/utils.html b/web/utils.html index d6141432..2656af5a 100644 --- a/web/utils.html +++ b/web/utils.html @@ -8,7 +8,7 @@ - + @@ -109,7 +109,7 @@ Both are an easy way to receive the next/previous page of a Paging-Object.

< break; playlistTracks = _spotify.GetNextPage(playlistTracks); } -
- +
+