sarsoo/Spotify.NET
1
0
Fork 0
mirror of https://github.com/Sarsoo/Spotify.NET.git synced 2024-12-25 15:36:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

add documentation to the publicly exposed methods.

Browse Source
This commit is contained in:
salfab 2015-03-15 16:45:16 +01:00
parent 54e0c06e96
commit 4de230cb8e
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
SpotifyAPI/SpoitfyLocalAPI/SpotifyMusicHandler.cs
View File

@ -54,9 +54,13 @@ namespace SpotifyAPI.SpotifyLocalAPI
return sr.volume; return sr.volume;
} }
/// <summary> /// <summary>
/// Plays a Spotify URI /// Plays a Spotify URI within an optional context.
/// </summary> /// </summary>
/// <param name="uri">The Spotify URI. Can be checked with <seealso cref="SpotifyLocalAPIClass.IsValidSpotifyURI"/></param> /// <param name="uri">The Spotify URI. Can be checked with <seealso cref="SpotifyLocalAPIClass.IsValidSpotifyURI"/></param>
/// <param name="context">The context in which to play the specified <paramref name="uri"/>. </param>
/// <remarks>
/// Contexts are basically a queue in spotify. a song can be played within a context, meaning that hitting next / previous would lead to another song. Contexts are leveraged by widgets as described in the "Multiple tracks player" section of the following documentation page: https://developer.spotify.com/technologies/widgets/spotify-play-button/
/// </remarks>
public void PlayURL(String uri, String context = "") public void PlayURL(String uri, String context = "")
{ {
rh.SendPlayRequest(uri, context); rh.SendPlayRequest(uri, context);