savePlayQueueByIndex
Categories:
Opensubsonic:
http://your-server/rest/savePlayQueueByIndex 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).
Uses an index instead, as this allows for uniquely identifying play queues which may have multiple copies of the same track.
Parameters
| Parameter | Req. | OpenS. | Default | Comment |
|---|---|---|---|---|
id | No | ID of a song in the play queue. Use one id parameter for each song in the play queue. | ||
currentIndex | Yes, unless no id is provided | The 0-based index of the current playing track. This must be between 0 and length of the queue - 1 (inclusive). | ||
position | No | The position in milliseconds within the currently playing song. |
Example
http://your-server/rest/savePlayQueueByIndex.view?id=123¤tIndex=1&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=jsonResult
An empty subsonic-response element on success.
{
"subsonic-response": {
"status": "ok",
"version": "1.16.1",
"type": "AwesomeServerName",
"serverVersion": "0.1.3 (tag)",
"openSubsonic": true
}
}Does not existOpenSubsonic
Note id is optional. Send a call without any parameters to clear the currently saved queue.
In this case, currentIndex must not be set.
If currentIndex is not between 0 and length of the queue - 1 (inclusive), the server must respond with error code 10.
currentIndex is required unless no id is provided.
If position is empty, servers should treat the position as 0.