Class GroovesharkAPI

The class for the Grooveshark Javascript API. When the swf is embedded, it automatically creates an instance of this class as window.Grooveshark.

Example Usage:

                //Would return something like "20100518.01" 
                window.Grooveshark.getApplicationVersion();
            

Class Summary

Constructor Attributes	Constructor Name and Description
	GroovesharkAPI(flashID)

Method Summary

Method Attributes	Method Name and Description
	addAlbumByID(albumID, playOnAdd) Add/Play songs from an album
	addCurrentSongToLibrary() Add the current song to your library. If this song is already in your library, it does nothing. Only available in APIVersion 1.4 and up.
	addPlaylistByID(playlistID, playOnAdd) Add/Play songs from a playlist
	addSongByToken(token, playOnAdd) Add/Play song from a song token
	addSongsByID(songIDs, playOnAdd) Add/Play songs from an array of songIDs
	executeProtocol(protocol) Used to provide support for extensions that pass gs:// URIs into the application.
	favoriteCurrentSong() Add the current song to your favorites.
	getAPIVersion() Returns the version of the Javascript API
	getApplicationVersion() Returns the version of the client swf
	getCurrentSongStatus() Returns the current song and playback status
	getNextSong() Returns the next song Only available in APIVersion 1.1 and up.
	getPreviousSong() Returns the previous song Only available in APIVersion 1.1 and up.
	getVolume() Get the current volume of the player.
	getVoteForCurrentSong() Get the Radio smile/frown vote for the current song.
	next() Play the next song in the current playlist.
	pause() Pause the current song.
	play() Play the current song.
	previous() Play the previous song in the current playlist.
	removeCurrentSongFromQueue() Remove the currently playing song from the Now Playing queue. Only available in APIVersion 1.4 and up.
	seekToPosition(volume) Seek to a particular position in the current song. You cannot seek past where the song is currently loaded to. Only available in APIVersion 1.5 and up.
	setSongStatusCallback(callback) Define a callback function that should be called whenever the current song or status changes.
	setVolume(volume) Set the volume of the player.
	togglePlayPause() If the current song is stopped or paused, it will play.
	voteCurrentSong(vote) Change the Radio smile/frown vote for the current song.

Parameters:

{int} albumID

The albumID of the album

{Boolean} playOnAdd

If true, will immediately play the given songs after adding them to the current playlist

Returns:

void

---

Returns:

void

---

Parameters:

{int} playlistID

The playlistID of the playlist

{Boolean} playOnAdd

If true, will immediately play the given songs after adding them to the current playlist

Returns:

void

---

Parameters:

{String} token

Token of the song

{Boolean} playOnAdd

If true, will immediately play the given songs after adding them to the current playlist

Returns:

void

---

Parameters:

{int[]} songIDs

Array of songIDs

{Boolean} playOnAdd

If true, will immediately play the given songs after adding them to the current playlist

Returns:

void

---

Parameters:

{String} protocol

The gs:// URI

Returns:

void

---

Returns:

void

---

Returns:

{Number} The API version

---

Returns:

{String} The revision number, in the format YYYYMMDD.RR

---

Returns:

{Object} { song:Object (can be null) { songID:int, songName:String, artistID:int, artistName:String, albumID:int, albumName:String, trackNum:int, estimateDuration:Number, (in milliseconds) artURL:String calculatedDuration:Number, (in milliseconds, Only available in APIVersion 1.1 and up) position:Number, (in milliseconds, Only available in APIVersion 1.1 and up) vote:int (1 = Smile, -1 = Frown, 0 = No vote, Only available in APIVersion 1.1 and up) }, status:String (One of: "none", "loading", "playing", "paused", "buffering", "failed", "completed") }

---

Returns:

{Object} (can be null) { songID:int, songName:String, artistID:int, artistName:String, albumID:int, albumName:String, trackNum:int, estimateDuration:Number, (in milliseconds) artURL:String vote:int (1 = Smile, -1 = Frown, 0 = No vote) }

---

Returns:

{Object} (can be null) { songID:int, songName:String, artistID:int, artistName:String, albumID:int, albumName:String, trackNum:int, estimateDuration:Number, (in milliseconds) artURL:String vote:int (1 = Smile, -1 = Frown, 0 = No vote) }

---

Returns:

{Number} The current volume

---

Returns:

{int} 1 = Smile, -1 = Frown, 0 = No vote

---

Returns:

void

---

Returns:

void

---

Returns:

void

---

Returns:

void

---

Returns:

void

---

Parameters:

{Number} position

The position to seek to, in milliseconds.

Returns:

void

---

Parameters:

{String} callback

The name of the function to be used as a callback.

Returns:

{Object} { song:Object (can be null) { songID:int, songName:String, artistID:int, artistName:String, albumID:int, albumName:String, trackNum:int, estimateDuration:Number, (in milliseconds) artURL:String calculatedDuration:Number, (in milliseconds, Only available in APIVersion 1.1 and up) position:Number, (in milliseconds, Only available in APIVersion 1.1 and up) vote:int (1 = Smile, -1 = Frown, 0 = No vote, Only available in APIVersion 1.1 and up) }, status:String (One of: "none", "loading", "playing", "paused", "buffering", "failed", "completed") }

---

Parameters:

{Number} volume

The volume to set

Returns:

void

---

Returns:

void

---

Parameters:

{int} vote

1 = Smile, -1 = Frown, 0 = Remove vote

Returns:

void

---