Media Annotation on OpenSubsonic

reportPlayback

Mon, 01 Jan 0001 00:00:00 +0000

OpenSubsonic version: 1

OpenSubsonic extension name playbackReport (As returned by getOpenSubsonicExtensions)

http://your-server/rest/reportPlayback

Reports playback timeline state for a song. Clients should call the endpoint at least on each state change. The end point can be called every X seconds by clients, but servers should estimate current position based on playbackRate for up to date data between calls. Servers should not assume a media is played after the calculated end of content, but needs to wait for a stopped state. 30 minutes after the planned end of the media, servers should stop listening to events and clients should use the normal scrobble endpoint after reconnection from offline.

scrobble

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/scrobble Since 1.5.0

Registers the local playback of one or more media files. Typically used when playing media that is cached on the client. This operation includes the following:

“Scrobbles” the media files on last.fm if the user has configured his/her last.fm credentials on the server.
Updates the play count and last played timestamp for the media files. (Since 1.11.0)
Makes the media files appear in the “Now playing” page in the web app, and appear in the list of songs returned by getNowPlaying (Since 1.11.0)

Since 1.8.0 you may specify multiple id (and optionally time) parameters to scrobble multiple files.

setRating

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/setRating Since 1.6.0

Sets the rating for a music file.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			A string which uniquely identifies the file (song) or folder (album/artist) to rate.
`rating`	Yes			The rating between 1 and 5 (inclusive), or 0 to remove the rating.

Example

http://your-server/rest/setRating.view?id=123&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1"
 }
}

star

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/star Since 1.8.0

Attaches a star to a song, album or artist.

Parameters

Parameter	Req.	Comment
`id`	No	The ID of the file (song) or folder (album/artist) to star. Multiple parameters allowed.
`albumId`	No	The ID of an album to star. Use this rather than `id` if the client accesses the media collection according to ID3 tags rather than file structure. Multiple parameters allowed.
`artistId`	No	The ID of an artist to star. Use this rather than `id` if the client accesses the media collection according to ID3 tags rather than file structure. Multiple parameters allowed.

Example

http://your-server/rest/star.view?id=123&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

unstar

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/unstar Since 1.8.0

Removes a star to a song, album or artist.

Parameters

Parameter	Req.	Comment
`id`	No	The ID of the file (song) or folder (album/artist) to unstar. Multiple parameters allowed.
`albumId`	No	The ID of an album to unstar. Use this rather than `id` if the client accesses the media collection according to ID3 tags rather than file structure. Multiple parameters allowed.
`artistId`	No	The ID of an artist to unstar. Use this rather than `id` if the client accesses the media collection according to ID3 tags rather than file structure. Multiple parameters allowed.

Example

http://your-server/rest/unstar.view?id=123&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.