Spotify.NET/docs/web/player/index.html
2020-09-10 19:33:21 +00:00

33 lines
29 KiB
HTML
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.

<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width">
<meta name="generator" content="Docusaurus v2.0.0-alpha.56">
<title data-react-helmet="true">Player | SpotifyAPI-NET</title><meta data-react-helmet="true" name="docsearch:version" content="5.1.1"><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:title" content="Player | SpotifyAPI-NET"><meta data-react-helmet="true" name="description" content="GetDevices"><meta data-react-helmet="true" property="og:description" content="GetDevices"><meta data-react-helmet="true" property="og:url" content="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/web/player"><link data-react-helmet="true" rel="shortcut icon" href="/SpotifyAPI-NET/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/web/player"><link rel="stylesheet" href="/SpotifyAPI-NET/styles.8a053330.css">
<link rel="preload" href="/SpotifyAPI-NET/styles.c98ed224.js" as="script">
<link rel="preload" href="/SpotifyAPI-NET/runtime~main.55bc79db.js" as="script">
<link rel="preload" href="/SpotifyAPI-NET/main.73459b16.js" as="script">
<link rel="preload" href="/SpotifyAPI-NET/1.3b60c25a.js" as="script">
<link rel="preload" href="/SpotifyAPI-NET/2.2bb7aa4d.js" as="script">
<link rel="preload" href="/SpotifyAPI-NET/3.f4b60483.js" as="script">
<link rel="preload" href="/SpotifyAPI-NET/1be78505.163494cb.js" as="script">
<link rel="preload" href="/SpotifyAPI-NET/3d0d8a2f.6e650079.js" as="script">
<link rel="preload" href="/SpotifyAPI-NET/0951e901.4ff42114.js" as="script">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=window.matchMedia("(prefers-color-scheme: dark)"),n=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();null!==n?t(n):e.matches&&t("dark")}()</script><div id="__docusaurus">
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/SpotifyAPI-NET/"><img class="navbar__logo" src="/SpotifyAPI-NET/img/logo.svg" alt="SpotifyAPI-NET"><strong class="navbar__title">SpotifyAPI-NET</strong></a><div class="navbar__item dropdown dropdown--hoverable dropdown--left"><a activeclassname="navbar__link--active" class="navbar__item navbar__link">Docs</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/SpotifyAPI-NET/docs/next/introduction">Latest/Next</a></li><li><a class="dropdown__link" href="/SpotifyAPI-NET/docs/home">5.1.1</a></li></ul></div><a class="navbar__item navbar__link" href="/SpotifyAPI-NET/news">News</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/SpotifyAPI-NET/"><img class="navbar__logo" src="/SpotifyAPI-NET/img/logo.svg" alt="SpotifyAPI-NET"><strong class="navbar__title">SpotifyAPI-NET</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a activeclassname="navbar__link--active" class="menu__link menu__link--sublist">Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/SpotifyAPI-NET/docs/next/introduction">Latest/Next</a></li><li class="menu__list-item"><a class="menu__link" href="/SpotifyAPI-NET/docs/home">5.1.1</a></li></ul></li><li class="menu__list-item"><a class="menu__link" href="/SpotifyAPI-NET/news">News</a></li><li class="menu__list-item"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><div class="docSidebarContainer_1cYp"><div class="sidebar_1kLs"><div class="menu menu--responsive menu_w2sC"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_2vk4" xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 32 32" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">SpotifyAPI-NET</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/home">Home</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">SpotifyAPI-NET.Web</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/getting_started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/albums">Albums</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/artists">Artists</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/browse">Browse</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/follow">Follow</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/library">Library</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/personalization">Personalization</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/SpotifyAPI-NET/docs/web/player">Player</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/playlists">Playlists</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/profiles">Profiles</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/proxy">Proxy Settings</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/search">Search</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/tracks">Tracks</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/utilities">Utilities</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">SpotifyAPI-NET.Auth</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/getting_started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/implicit_grant">Implicit Grant</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/authorization_code">Authorization Code</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/client_credentials">Client Credentials</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/token_swap">Token Swap</a></li></ul></li></ul></div></div></div><main class="docMainContainer_FFX1"><div class="container padding-vert--lg docItemWrapper_1cc7"><div class="row"><div class="col docItemCol_2GOA"><div class="docItemContainer_2cwg"><article><div><span class="badge badge--secondary">Version: 5.1.1</span></div><header><h1 class="docTitle_1vWb">Player</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="getdevices"></a>GetDevices<a aria-hidden="true" tabindex="-1" class="hash-link" href="#getdevices" title="Direct link to heading">#</a></h2><blockquote><p>Get information about a users available devices.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">AvailabeDevices devices = _spotify.GetDevices();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">devices.Devices.ForEach(device =&gt; Console.WriteLine(device.Name));</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="getplayback"></a>GetPlayback<a aria-hidden="true" tabindex="-1" class="hash-link" href="#getplayback" title="Direct link to heading">#</a></h2><blockquote><p>Get information about the users current playback state, including track, track progress, and active device.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[market]</td><td>An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.</td><td><code>&quot;DE&quot;</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">PlaybackContext context = _spotify.GetPlayback();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">if(context.Item != null)</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> Console.WriteLine(context.Item.Name)); //Print the current song</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="getplayingtrack"></a>GetPlayingTrack<a aria-hidden="true" tabindex="-1" class="hash-link" href="#getplayingtrack" title="Direct link to heading">#</a></h2><blockquote><p>Get the object currently being played on the users Spotify account.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[market]</td><td>An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.</td><td><code>&quot;DE&quot;</code></td></tr></tbody></table><p>This is a simpler (less data) version of <code>GetPlayback</code></p><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">PlaybackContext context = _spotify.GetPlayingTrack();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">if(context.Item != null)</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> Console.WriteLine(context.Item.Name)); //Print the current song</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="transferplayback"></a>TransferPlayback<a aria-hidden="true" tabindex="-1" class="hash-link" href="#transferplayback" title="Direct link to heading">#</a></h2><blockquote><p>Transfer playback to a new device and determine if it should start playing.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>deviceIds or deviceId</td><td>A JSON array containing the ID of the device on which playback should be started/transferred</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr><tr><td>play</td><td>true: ensure playback happens on new device, false: keep current playback state</td><td><code>true</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.TransferPlayback(&quot;XXXX-XXXX-XXXX-XXXX&quot;);</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="resumeplayback"></a>ResumePlayback<a aria-hidden="true" tabindex="-1" class="hash-link" href="#resumeplayback" title="Direct link to heading">#</a></h2><blockquote><p>Start a new context or resume current playback on the users active device.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[deviceId]</td><td>The id of the device this command is targeting. If not supplied, the user&#x27;s currently active device is the target.</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr><tr><td>contextUri</td><td>Spotify URI of the context to play</td><td><code>&quot;spotify:album:1Je1IMUlBXcx1Fz0WE7oPT&quot;</code></td></tr><tr><td>uris</td><td>An array of the Spotify track URIs to play.</td><td><code>new List&lt;string&gt; { &quot;spotify:track:4iV5W9uYEdYUVa79Axb7Rh&quot; }</code></td></tr><tr><td>offset</td><td>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.</td><td><code>0</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.ResumePlayback(uris: new List&lt;string&gt; { &quot;spotify:track:4iV5W9uYEdYUVa79Axb7Rh&quot; });</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="pauseplayback"></a>PausePlayback<a aria-hidden="true" tabindex="-1" class="hash-link" href="#pauseplayback" title="Direct link to heading">#</a></h2><blockquote><p>Pause playback on the users account.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[deviceId]</td><td>The id of the device this command is targeting. If not supplied, the user&#x27;s currently active device is the target.</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.PausePlayback();</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="skipplaybacktonext"></a>SkipPlaybackToNext<a aria-hidden="true" tabindex="-1" class="hash-link" href="#skipplaybacktonext" title="Direct link to heading">#</a></h2><blockquote><p>Skips to next track in the users queue.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[deviceId]</td><td>The id of the device this command is targeting. If not supplied, the user&#x27;s currently active device is the target.</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.SkipPlaybackToNext();</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="skipplaybacktoprevious"></a>SkipPlaybackToPrevious<a aria-hidden="true" tabindex="-1" class="hash-link" href="#skipplaybacktoprevious" title="Direct link to heading">#</a></h2><blockquote><p>Skips to previous track in the users queue.
Note that this will ALWAYS skip to the previous track, regardless of the current tracks progress.
Returning to the start of the current track should be performed using the <a href="https://api.spotify.com/v1/me/player/seek" target="_blank" rel="noopener noreferrer">https://api.spotify.com/v1/me/player/seek</a> endpoint.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[deviceId]</td><td>The id of the device this command is targeting. If not supplied, the user&#x27;s currently active device is the target.</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.SkipPlaybackToPrevious();</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="seekplayback"></a>SeekPlayback<a aria-hidden="true" tabindex="-1" class="hash-link" href="#seekplayback" title="Direct link to heading">#</a></h2><blockquote><p>Seeks to the given position in the users currently playing track.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>positionMs</td><td>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.</td><td><code>50</code></td></tr><tr><td>[deviceId]</td><td>The id of the device this command is targeting. If not supplied, the user&#x27;s currently active device is the target.</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.SeekPlayback(50);</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="setrepeatmode"></a>SetRepeatMode<a aria-hidden="true" tabindex="-1" class="hash-link" href="#setrepeatmode" title="Direct link to heading">#</a></h2><blockquote><p>Set the repeat mode for the users playback. Options are repeat-track, repeat-context, and off.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>state</td><td>track, context or off.</td><td><code>RepeatState.Track</code></td></tr><tr><td>[deviceId]</td><td>The id of the device this command is targeting. If not supplied, the user&#x27;s currently active device is the target.</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.SetRepeatMode(RepeatState.Track);</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="setvolume"></a>SetVolume<a aria-hidden="true" tabindex="-1" class="hash-link" href="#setvolume" title="Direct link to heading">#</a></h2><blockquote><p>Set the volume for the users current playback device.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>volumePercent</td><td>Integer. The volume to set. Must be a value from 0 to 100 inclusive.</td><td><code>50</code></td></tr><tr><td>[deviceId]</td><td>The id of the device this command is targeting. If not supplied, the user&#x27;s currently active device is the target.</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.SetVolume(50);</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="setshuffle"></a>SetShuffle<a aria-hidden="true" tabindex="-1" class="hash-link" href="#setshuffle" title="Direct link to heading">#</a></h2><blockquote><p>Toggle shuffle on or off for users playback.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>shuffle</td><td>True or False</td><td><code>false</code></td></tr><tr><td>[deviceId]</td><td>The id of the device this command is targeting. If not supplied, the user&#x27;s currently active device is the target.</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.SetShuffle(false);</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="addtoqueue"></a>AddToQueue<a aria-hidden="true" tabindex="-1" class="hash-link" href="#addtoqueue" title="Direct link to heading">#</a></h2><blockquote><p>Add an Item to the User&#x27;s Playback Queue. BETA.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>uri</td><td>The uri of the item to add to the queue. Must be a track or an episode uri.</td><td><code>spotify:track:7zrCVKp6x0AtolOsn2iMif</code></td></tr><tr><td>[deviceId]</td><td>The id of the device this command is targeting. If not supplied, the user&#x27;s currently active device is the target.</td><td><code>&quot;XXXX-XXXX-XXXX-XXXX&quot;</code></td></tr></tbody></table><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">ErrorResponse error = _spotify.AddToQueue(&quot;spotify:track:7zrCVKp6x0AtolOsn2iMif&quot;);</span></div></div></div></div></div></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET/edit/master/SpotifyAPI.Docs/versioned_docs/version-5.1.1/web/player.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col text--right"><em><small>Last updated on <time datetime="2020-09-10T19:30:43.000Z" class="docLastUpdatedAt_1sqk">9/10/2020</time> by <strong>dependabot[bot]</strong></small></em></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/SpotifyAPI-NET/docs/web/personalization"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Personalization</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/SpotifyAPI-NET/docs/web/playlists"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Playlists »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#getdevices" class="table-of-contents__link">GetDevices</a></li><li><a href="#getplayback" class="table-of-contents__link">GetPlayback</a></li><li><a href="#getplayingtrack" class="table-of-contents__link">GetPlayingTrack</a></li><li><a href="#transferplayback" class="table-of-contents__link">TransferPlayback</a></li><li><a href="#resumeplayback" class="table-of-contents__link">ResumePlayback</a></li><li><a href="#pauseplayback" class="table-of-contents__link">PausePlayback</a></li><li><a href="#skipplaybacktonext" class="table-of-contents__link">SkipPlaybackToNext</a></li><li><a href="#skipplaybacktoprevious" class="table-of-contents__link">SkipPlaybackToPrevious</a></li><li><a href="#seekplayback" class="table-of-contents__link">SeekPlayback</a></li><li><a href="#setrepeatmode" class="table-of-contents__link">SetRepeatMode</a></li><li><a href="#setvolume" class="table-of-contents__link">SetVolume</a></li><li><a href="#setshuffle" class="table-of-contents__link">SetShuffle</a></li><li><a href="#addtoqueue" class="table-of-contents__link">AddToQueue</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="text--center"><div>Copyright © 2020 Jonas Dellinger. Built with Docusaurus.</div></div></div></footer></div>
<script src="/SpotifyAPI-NET/styles.c98ed224.js"></script>
<script src="/SpotifyAPI-NET/runtime~main.55bc79db.js"></script>
<script src="/SpotifyAPI-NET/main.73459b16.js"></script>
<script src="/SpotifyAPI-NET/1.3b60c25a.js"></script>
<script src="/SpotifyAPI-NET/2.2bb7aa4d.js"></script>
<script src="/SpotifyAPI-NET/3.f4b60483.js"></script>
<script src="/SpotifyAPI-NET/1be78505.163494cb.js"></script>
<script src="/SpotifyAPI-NET/3d0d8a2f.6e650079.js"></script>
<script src="/SpotifyAPI-NET/0951e901.4ff42114.js"></script>
</body>
</html>