getPlayQueueByIndex
Returns the state of the play queue for this user.
Categories:
Opensubsonic:
http://your-server/rest/getPlayQueueByIndex Since 1.12.0
Returns the state of the play queue for this user (as set by savePlayQueue or savePlayQueueByIndex). This includes the tracks in the play queue, the currently playing track index (0-based), 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
Takes no extra parameters.
Example
http://your-server/rest/getPlayQueueByIndex.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=jsonResult
A subsonic-response element with a nested playQueue element on success.
{
"subsonic-response": {
"status": "ok",
"version": "1.16.1",
"type": "AwesomeServerName",
"serverVersion": "0.1.3 (tag)",
"openSubsonic": true,
"playQueueByIndex": {
"currentIndex": 1,
"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"
}
]
}
}
}Does not exist.| Field | Type | Req. | OpenS. | Details |
|---|---|---|---|---|
playQueueByIndex | PlayQueueByIndex | Yes | The play queue |