PlayQueue

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

{
 "current": "1234",
 "position": 1000,
 "username": "user",
 "changed": "2023-03-10T02:19:35.784818075Z",
 "changedBy": "example client",
 "entry": [
 {
 "id": "1234",
 "parent": "200000021",
 "title": "Can I Help U?",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000021",
 "album": "Forget and Remember",
 "artistId": "100000036",
 "artist": "Comfort Fit",
 "coverArt": "1234",
 "duration": 103,
 "bitRate": 216,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 1,
 "year": 2005,
 "genre": "Hip-Hop",
 "size": 2811819,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "user/Comfort Fit/Forget And Remember/1 - Can I Help U?.mp3"
 }
 ]
}

{
 "current": "1234",
 "position": 1000,
 "username": "user",
 "changed": "2023-03-10T02:19:35.784818075Z",
 "changedBy": "example client",
 "entry": [
 {
 "id": "1234",
 "parent": "200000021",
 "title": "Can I Help U?",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000021",
 "album": "Forget and Remember",
 "artistId": "100000036",
 "artist": "Comfort Fit",
 "coverArt": "1234",
 "duration": 103,
 "bitRate": 216,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "track": 1,
 "year": 2005,
 "genre": "Hip-Hop",
 "size": 2811819,
 "discNumber": 1,
 "suffix": "mp3",
 "contentType": "audio/mpeg",
 "path": "user/Comfort Fit/Forget And Remember/1 - Can I Help U?.mp3"
 }
 ]
}

OpenSubsonic

Errata: In the original spec, current is required to be an int. However, as child ids are strings, this is updated to note that the id should be a string to be consistent.

Field	Type	Req.	Details
`current`	`string`	No*	ID of currently playing track
`position`	`long`	No	Position in milliseconds of currently playing track
`username`	`string`	Yes	The user this queue belongs to
`changed`	`string`	Yes	Date modified [ISO 8601]
`changedBy`	`string`	Yes	Name of client app
`entry`	Array of `Child`	No	The list of songs in the queue

OpenSubsonic

* If entry exists and is non-empty, OpenSubsonic servers must ensure that current exists and is a valid id in the list of songs.

savePlayQueue

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

http://your-server/rest/savePlayQueue Since 1.12.0

Saves the state of the play queue for this user. This includes the tracks in the play queue, the currently playing track, and the position within this track. Typically used to allow a user to move between different clients/apps while retaining the same play queue (for instance when listening to an audio book).

Parameters

Parameter	Req.	Comment
`id`	No	ID of a song in the play queue. Use one `id` parameter for each song in the play queue.
`current`	Yes (subsonic) / No (OpenSubsonic)*	The ID of the current playing song.
`position`	No	The position in milliseconds within the currently playing song.

Errata/OpenSubsonic

* In the original Subsonic, despite the claims that current is optional, it was required and must be in the list of id.

Errata on OpenSubsonic

PlayQueue

OpenSubsonic

OpenSubsonic

savePlayQueue

Parameters

Errata/OpenSubsonic