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

Update README.md

Browse Source 
Added Links
This commit is contained in:
Jonas Dellinger 2014-02-13 18:31:19 +01:00
parent 247adfed64
commit 461066837a
1 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -4,7 +4,6 @@ SpotifyAPI-NET
An API for the Spotify-Client, written in .NET An API for the Spotify-Client, written in .NET
Look at the example provided in the Repo Look at the example provided in the Repo
Following 3 files will be needed for all features: Following 3 files will be needed for all features:
+ SpotifyAPI.dll + SpotifyAPI.dll
+ Newtonsoft.Json.dll (Will be merged into SpotifyAPI.dll in the official Releases using ILMerge) + Newtonsoft.Json.dll (Will be merged into SpotifyAPI.dll in the official Releases using ILMerge)
@ -12,6 +11,8 @@ Following 3 files will be needed for all features:
Usage: Usage:
============== ==============
### SpotifyAPI ### SpotifyAPI
#####void Connect() #####void Connect()
> Connects the SpotifyAPI to the Spotify Client (Needs to be called before making calls, Spotify has to run) > Connects the SpotifyAPI to the Spotify Client (Needs to be called before making calls, Spotify has to run)
@ -34,12 +35,13 @@ Usage:
#####static Boolean IsValidSpotifyURL(String SpotifyURL) #####static Boolean IsValidSpotifyURL(String SpotifyURL)
> Returns true, if the provided Spotify URL is working (Not working yet) > Returns true, if the provided Spotify URL is working (Not working yet)
#####MusicHandler GetMusicHandler() #####[SpotifyMusicHandler](https://github.com/JohnnyCrazy/SpotifyAPI-NET#spotifymusichandler) GetMusicHandler()
> Returns the MusicHandler > Returns the MusicHandler
#####EventHandler GetEventHandler() #####[SpotifyEventHandler](https://github.com/JohnnyCrazy/SpotifyAPI-NET#spotifyeventhandler) GetEventHandler()
> Returns the EventHandler > Returns the EventHandler
### SpotifyMusicHandler ### SpotifyMusicHandler
#####void Play() #####void Play()
> Play "button" > Play "button"
@ -74,13 +76,33 @@ Usage:
#####Boolean IsPlaying() #####Boolean IsPlaying()
> Returns true, if Spotify is playing atm > Returns true, if Spotify is playing atm
#####Track GetCurrentTrack() #####[Track](https://github.com/JohnnyCrazy/SpotifyAPI-NET#track) GetCurrentTrack()
> Returns the current Track > Returns the current Track
#####StatusResponse GetStatusResponse() #####StatusResponse GetStatusResponse()
> Returns the StatusResponse, which contains all Information gathered by the Call > Returns the StatusResponse, which contains all Information gathered by the Call
### SpotifyEventHandler
#####Event OnTrackChange
> Triggered, when the Track gets changed
#####Event OnPlayStateChange
> Triggered, when Spotify's Play/Pause-State changes
#####Event OnVolumeChange
> Triggered, when the volume gets changed
#####Event TrackTimeChangeEventHandler
> Triggered, when the current trackposition changes
#####void ListenForEvents(Boolean listen)
> Should it listen for events?
#####void SetSynchronizingObject(ISynchronizeInvoke obj)
> Sets the synced object, so no Invoke is required (Events doesnt get called from the Main-Thread)
### Track ### Track
#####String GetName() #####String GetName()
> Returns Track-Name > Returns Track-Name
@ -99,23 +121,3 @@ Usage:
#####Bitmap GetAlbumArtAsync(AlbumArtSize size) #####Bitmap GetAlbumArtAsync(AlbumArtSize size)
> Returns a Bitmap of the Albumart based on the choosen size asynchronously > Returns a Bitmap of the Albumart based on the choosen size asynchronously
### EventHandler
#####Event OnTrackChange
> Triggered, when the Track gets changed
#####Event OnPlayStateChange
> Triggered, when Spotify's Play/Pause-State changes
#####Event OnVolumeChange
> Triggered, when the volume gets changed
#####Event TrackTimeChangeEventHandler
> Triggered, when the current trackposition changes
#####void ListenForEvents(Boolean listen)
> Should it listen for events?
#####void SetSynchronizingObject(ISynchronizeInvoke obj)
> Sets the synced object, so no Invoke is required (Events doesnt get called from the Main-Thread)