sarsoo/Spotify.NET
1
0
Fork 0
mirror of https://github.com/Sarsoo/Spotify.NET.git synced 2024-12-24 15:06:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
e2451b5be6
Spotify.NET/assets/js/19.6fcc81c7.js
AppVeyor Doc Generation dcf2bd420a Built docs | AppVeyor Build 529
2020-01-12 19:02:59 +00:00

1 line
23 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{219:function(t,a,e){"use strict";e.r(a);var s=e(0),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<string> { "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")])])])])},[],!1,null,null,null);a.default=r.exports}}]);
Reference in New Issue View Git Blame Copy Permalink