mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-12-24 06:56:27 +00:00
127 lines
30 KiB
HTML
127 lines
30 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>Player | SpotifyAPI-NET</title>
|
||
<meta name="description" content="🔉 An API for the Spotify-Client and the Spotify Web API, written in C#/.NET">
|
||
<meta name="generator" content="VuePress 1.4.0">
|
||
|
||
|
||
<link rel="preload" href="/SpotifyAPI-NET/assets/css/0.styles.82abfbf9.css" as="style"><link rel="preload" href="/SpotifyAPI-NET/assets/js/app.39f7bcb8.js" as="script"><link rel="preload" href="/SpotifyAPI-NET/assets/js/2.31113494.js" as="script"><link rel="preload" href="/SpotifyAPI-NET/assets/js/19.a6196abf.js" as="script"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/10.002ef499.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/11.7de40808.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/12.db52d3ac.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/13.8b5c9b44.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/14.c0f35def.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/15.cfa7a58a.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/16.9c0ba2de.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/17.5154e8d9.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/18.6bcd5883.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/20.540a6f36.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/21.956153ac.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/22.a4edf47c.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/23.e0985451.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/24.a9466c6a.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/25.33dd1a97.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/26.fd03eb58.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/3.7ef0fbfe.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/4.2f270ddd.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/5.14f2fea3.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/6.66d7c2fe.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/7.830f290b.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/8.9cb2269f.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/9.f14800d8.js">
|
||
<link rel="stylesheet" href="/SpotifyAPI-NET/assets/css/0.styles.82abfbf9.css">
|
||
</head>
|
||
<body>
|
||
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/SpotifyAPI-NET/" class="home-link router-link-active"><!----> <span class="site-name">SpotifyAPI-NET</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/SpotifyAPI-NET/" class="nav-link">
|
||
Home
|
||
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="SpotifyAPI.Web" class="dropdown-title"><span class="title">SpotifyAPI.Web</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/getting_started.html" class="nav-link">
|
||
Getting Started
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/examples.html" class="nav-link">
|
||
Examples
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/proxy.html" class="nav-link">
|
||
Proxy
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/albums.html" class="nav-link">
|
||
- Albums
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/artists.html" class="nav-link">
|
||
- Artists
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/browse.html" class="nav-link">
|
||
- Browse
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/follow.html" class="nav-link">
|
||
- Follow
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/library.html" class="nav-link">
|
||
- Library
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/personalization.html" class="nav-link">
|
||
- Personalization
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/player.html" class="nav-link router-link-exact-active router-link-active">
|
||
- Player
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/playlists.html" class="nav-link">
|
||
- Playlists
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/profiles.html" class="nav-link">
|
||
- Profiles
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/search.html" class="nav-link">
|
||
- Search
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/tracks.html" class="nav-link">
|
||
- Tracks
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/utils.html" class="nav-link">
|
||
Utilities
|
||
</a></li></ul></div></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="SpotifyAPI.Auth" class="dropdown-title"><span class="title">SpotifyAPI.Auth</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/getting_started.html" class="nav-link">
|
||
Getting Started
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/implicit_grant.html" class="nav-link">
|
||
- ImplicitGrantAuth
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/token_swap.html" class="nav-link">
|
||
- TokenSwapAuth
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/authorization_code.html" class="nav-link">
|
||
- AutorizationCodeAuth
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/client_credentials.html" class="nav-link">
|
||
- ClientCredentialsAuth
|
||
</a></li></ul></div></div> <a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="repo-link">
|
||
🚀 GitHub
|
||
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/SpotifyAPI-NET/" class="nav-link">
|
||
Home
|
||
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="SpotifyAPI.Web" class="dropdown-title"><span class="title">SpotifyAPI.Web</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/getting_started.html" class="nav-link">
|
||
Getting Started
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/examples.html" class="nav-link">
|
||
Examples
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/proxy.html" class="nav-link">
|
||
Proxy
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/albums.html" class="nav-link">
|
||
- Albums
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/artists.html" class="nav-link">
|
||
- Artists
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/browse.html" class="nav-link">
|
||
- Browse
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/follow.html" class="nav-link">
|
||
- Follow
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/library.html" class="nav-link">
|
||
- Library
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/personalization.html" class="nav-link">
|
||
- Personalization
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/player.html" class="nav-link router-link-exact-active router-link-active">
|
||
- Player
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/playlists.html" class="nav-link">
|
||
- Playlists
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/profiles.html" class="nav-link">
|
||
- Profiles
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/search.html" class="nav-link">
|
||
- Search
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/tracks.html" class="nav-link">
|
||
- Tracks
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/utils.html" class="nav-link">
|
||
Utilities
|
||
</a></li></ul></div></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="SpotifyAPI.Auth" class="dropdown-title"><span class="title">SpotifyAPI.Auth</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/getting_started.html" class="nav-link">
|
||
Getting Started
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/implicit_grant.html" class="nav-link">
|
||
- ImplicitGrantAuth
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/token_swap.html" class="nav-link">
|
||
- TokenSwapAuth
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/authorization_code.html" class="nav-link">
|
||
- AutorizationCodeAuth
|
||
</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/client_credentials.html" class="nav-link">
|
||
- ClientCredentialsAuth
|
||
</a></li></ul></div></div> <a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="repo-link">
|
||
🚀 GitHub
|
||
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>Player</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/SpotifyAPI-NET/web/player.html#getdevices" class="sidebar-link">GetDevices</a></li><li><a href="/SpotifyAPI-NET/web/player.html#getplayback" class="sidebar-link">GetPlayback</a></li><li><a href="/SpotifyAPI-NET/web/player.html#getplayingtrack" class="sidebar-link">GetPlayingTrack</a></li><li><a href="/SpotifyAPI-NET/web/player.html#transferplayback" class="sidebar-link">TransferPlayback</a></li><li><a href="/SpotifyAPI-NET/web/player.html#resumeplayback" class="sidebar-link">ResumePlayback</a></li><li><a href="/SpotifyAPI-NET/web/player.html#pauseplayback" class="sidebar-link">PausePlayback</a></li><li><a href="/SpotifyAPI-NET/web/player.html#skipplaybacktonext" class="sidebar-link">SkipPlaybackToNext</a></li><li><a href="/SpotifyAPI-NET/web/player.html#skipplaybacktoprevious" class="sidebar-link">SkipPlaybackToPrevious</a></li><li><a href="/SpotifyAPI-NET/web/player.html#seekplayback" class="sidebar-link">SeekPlayback</a></li><li><a href="/SpotifyAPI-NET/web/player.html#setrepeatmode" class="sidebar-link">SetRepeatMode</a></li><li><a href="/SpotifyAPI-NET/web/player.html#setvolume" class="sidebar-link">SetVolume</a></li><li><a href="/SpotifyAPI-NET/web/player.html#setshuffle" class="sidebar-link">SetShuffle</a></li><li><a href="/SpotifyAPI-NET/web/player.html#addtoqueue" class="sidebar-link">AddToQueue</a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="player"><a href="#player" aria-hidden="true" class="header-anchor">#</a> Player</h1> <h2 id="getdevices"><a href="#getdevices" aria-hidden="true" class="header-anchor">#</a> GetDevices</h2> <blockquote><p>Get information about a user’s 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="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">AvailabeDevices</span> devices <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">GetDevices</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
devices<span class="token punctuation">.</span>Devices<span class="token punctuation">.</span><span class="token function">ForEach</span><span class="token punctuation">(</span>device <span class="token operator">=></span> Console<span class="token punctuation">.</span><span class="token function">WriteLine</span><span class="token punctuation">(</span>device<span class="token punctuation">.</span>Name<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="getplayback"><a href="#getplayback" aria-hidden="true" class="header-anchor">#</a> GetPlayback</h2> <blockquote><p>Get information about the user’s 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>"DE"</code></td></tr></tbody></table> <p><strong>Usage</strong></p> <div class="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">PlaybackContext</span> context <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">GetPlayback</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
<span class="token keyword">if</span><span class="token punctuation">(</span>contex<span class="token punctuation">.</span>Item <span class="token operator">!=</span> <span class="token keyword">null</span><span class="token punctuation">)</span>
|
||
Console<span class="token punctuation">.</span><span class="token function">WriteLine</span><span class="token punctuation">(</span>context<span class="token punctuation">.</span>Item<span class="token punctuation">.</span>Name<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">//Print the current song</span>
|
||
</code></pre></div><hr> <h2 id="getplayingtrack"><a href="#getplayingtrack" aria-hidden="true" class="header-anchor">#</a> GetPlayingTrack</h2> <blockquote><p>Get the object currently being played on the user’s 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>"DE"</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="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">PlaybackContext</span> context <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">GetPlayingTrack</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
<span class="token keyword">if</span><span class="token punctuation">(</span>contex<span class="token punctuation">.</span>Item <span class="token operator">!=</span> <span class="token keyword">null</span><span class="token punctuation">)</span>
|
||
Console<span class="token punctuation">.</span><span class="token function">WriteLine</span><span class="token punctuation">(</span>context<span class="token punctuation">.</span>Item<span class="token punctuation">.</span>Name<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">//Print the current song</span>
|
||
</code></pre></div><hr> <h2 id="transferplayback"><a href="#transferplayback" aria-hidden="true" class="header-anchor">#</a> TransferPlayback</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>"XXXX-XXXX-XXXX-XXXX"</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="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">TransferPlayback</span><span class="token punctuation">(</span><span class="token string">"XXXX-XXXX-XXXX-XXXX"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="resumeplayback"><a href="#resumeplayback" aria-hidden="true" class="header-anchor">#</a> ResumePlayback</h2> <blockquote><p>Start a new context or resume current playback on the user’s 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's currently active device is the target.</td> <td><code>"XXXX-XXXX-XXXX-XXXX"</code></td></tr> <tr><td>contextUri</td> <td>Spotify URI of the context to play</td> <td><code>"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"</code></td></tr> <tr><td>uris</td> <td>An array of the Spotify track URIs to play.</td> <td><code>new List<string> { "spotify:track:4iV5W9uYEdYUVa79Axb7Rh" }</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="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">ResumePlayback</span><span class="token punctuation">(</span>uris<span class="token punctuation">:</span> <span class="token keyword">new</span> <span class="token class-name">List</span><span class="token operator"><</span><span class="token keyword">string</span><span class="token operator">></span> <span class="token punctuation">{</span> <span class="token string">"spotify:track:4iV5W9uYEdYUVa79Axb7Rh"</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="pauseplayback"><a href="#pauseplayback" aria-hidden="true" class="header-anchor">#</a> PausePlayback</h2> <blockquote><p>Pause playback on the user’s 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's currently active device is the target.</td> <td><code>"XXXX-XXXX-XXXX-XXXX"</code></td></tr></tbody></table> <p><strong>Usage</strong></p> <div class="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">PausePlayback</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="skipplaybacktonext"><a href="#skipplaybacktonext" aria-hidden="true" class="header-anchor">#</a> SkipPlaybackToNext</h2> <blockquote><p>Skips to next track in the user’s 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's currently active device is the target.</td> <td><code>"XXXX-XXXX-XXXX-XXXX"</code></td></tr></tbody></table> <p><strong>Usage</strong></p> <div class="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">SkipPlaybackToNext</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="skipplaybacktoprevious"><a href="#skipplaybacktoprevious" aria-hidden="true" class="header-anchor">#</a> SkipPlaybackToPrevious</h2> <blockquote><p>Skips to previous track in the user’s queue.
|
||
Note that this will ALWAYS skip to the previous track, regardless of the current track’s progress.
|
||
Returning to the start of the current track should be performed using the https://api.spotify.com/v1/me/player/seek 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's currently active device is the target.</td> <td><code>"XXXX-XXXX-XXXX-XXXX"</code></td></tr></tbody></table> <p><strong>Usage</strong></p> <div class="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">SkipPlaybackToPrevious</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="seekplayback"><a href="#seekplayback" aria-hidden="true" class="header-anchor">#</a> SeekPlayback</h2> <blockquote><p>Seeks to the given position in the user’s 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's currently active device is the target.</td> <td><code>"XXXX-XXXX-XXXX-XXXX"</code></td></tr></tbody></table> <p><strong>Usage</strong></p> <div class="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">SeekPlayback</span><span class="token punctuation">(</span><span class="token number">50</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="setrepeatmode"><a href="#setrepeatmode" aria-hidden="true" class="header-anchor">#</a> SetRepeatMode</h2> <blockquote><p>Set the repeat mode for the user’s 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's currently active device is the target.</td> <td><code>"XXXX-XXXX-XXXX-XXXX"</code></td></tr></tbody></table> <p><strong>Usage</strong></p> <div class="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">SetRepeatMode</span><span class="token punctuation">(</span>RepeatState<span class="token punctuation">.</span>Track<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="setvolume"><a href="#setvolume" aria-hidden="true" class="header-anchor">#</a> SetVolume</h2> <blockquote><p>Set the volume for the user’s 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's currently active device is the target.</td> <td><code>"XXXX-XXXX-XXXX-XXXX"</code></td></tr></tbody></table> <p><strong>Usage</strong></p> <div class="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">SetVolume</span><span class="token punctuation">(</span><span class="token number">50</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="setshuffle"><a href="#setshuffle" aria-hidden="true" class="header-anchor">#</a> SetShuffle</h2> <blockquote><p>Toggle shuffle on or off for user’s 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's currently active device is the target.</td> <td><code>"XXXX-XXXX-XXXX-XXXX"</code></td></tr></tbody></table> <p><strong>Usage</strong></p> <div class="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">SetShuffle</span><span class="token punctuation">(</span><span class="token keyword">false</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div><hr> <h2 id="addtoqueue"><a href="#addtoqueue" aria-hidden="true" class="header-anchor">#</a> AddToQueue</h2> <blockquote><p>Add an Item to the User'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's currently active device is the target.</td> <td><code>"XXXX-XXXX-XXXX-XXXX"</code></td></tr></tbody></table> <p><strong>Usage</strong></p> <div class="language-csharp extra-class"><pre class="language-csharp"><code><span class="token class-name">ErrorResponse</span> error <span class="token operator">=</span> _spotify<span class="token punctuation">.</span><span class="token function">AddToQueue</span><span class="token punctuation">(</span><span class="token string">"spotify:track:7zrCVKp6x0AtolOsn2iMif"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre></div></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET/edit/master/SpotifyAPI.Docs/docs/web/player.md" target="_blank" rel="noopener noreferrer">Help us improve this page!</a> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></div> <div class="last-updated"><span class="prefix">Last Updated:</span> <span class="time">4/16/2020, 7:54:15 PM</span></div></footer> <!----> </main></div><div class="global-ui"></div></div>
|
||
<script src="/SpotifyAPI-NET/assets/js/app.39f7bcb8.js" defer></script><script src="/SpotifyAPI-NET/assets/js/2.31113494.js" defer></script><script src="/SpotifyAPI-NET/assets/js/19.a6196abf.js" defer></script>
|
||
</body>
|
||
</html>
|