Bookmarks on OpenSubsonic

createBookmark

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

http://your-server/rest/createBookmark Since 1.9.0

Creates or updates a bookmark (a position within a media file). Bookmarks are personal and not visible to other users.

Parameters

Parameter	Req.	Comment
`id`	Yes	ID of the media file to bookmark. If a bookmark already exists for this file it will be overwritten.
`position`	Yes	The position (in milliseconds) within the media file.
`comment`	No	A user-defined comment.

Example

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

Result

An empty subsonic-response element on success.

deleteBookmark

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

http://your-server/rest/deleteBookmark Since 1.9.0

Creates or updates a bookmark (a position within a media file). Bookmarks are personal and not visible to other users.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			ID of the media file for which to delete the bookmark. Other users’ bookmarks are not affected.

Example

http://your-server/rest/deleteBookmark.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"
 }
}

getBookmarks

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

http://your-server/rest/getBookmarks Since 1.9.0

Returns all bookmarks for this user. A bookmark is a position within a certain media file.

Parameters

Takes no extra parameters.

Example

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

Result

A subsonic-response element with a nested bookmarks element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "bookmarks": {
 "bookmark": [
 {
 "entry": {
 "id": "113bf5989ad15ce2cf1834ba9622983f",
 "parent": "b87a936c682c49d4494c7ccb08c22d23",
 "isDir": false,
 "title": "Stay Out Here",
 "album": "Shaking The Habitual",
 "artist": "The Knife",
 "track": 11,
 "year": 2013,
 "genre": "Electronic",
 "coverArt": "al-b87a936c682c49d4494c7ccb08c22d23_0",
 "size": 21096309,
 "contentType": "audio/mp4",
 "suffix": "m4a",
 "duration": 642,
 "bitRate": 257,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "path": "The Knife/Shaking The Habitual/11 - Stay Out Here.m4a",
 "created": "2023-03-13T16:30:35Z",
 "albumId": "b87a936c682c49d4494c7ccb08c22d23",
 "artistId": "b29e9a9d780cb0e133f3add5662771b9",
 "type": "music",
 "isVideo": false,
 "bookmarkPosition": 129000
 },
 "position": 129000,
 "username": "demo",
 "comment": "",
 "created": "2023-03-13T16:30:35Z",
 "changed": "2023-03-13T16:30:35Z"
 },
 {
 "entry": {
 "id": "2b42782333450d02b177823e729664af",
 "parent": "dc8d8889a6fe08d8da7698c7ee1de61c",
 "isDir": false,
 "title": "Ill with the Skills",
 "album": "First Words",
 "artist": "The Polish Ambassador",
 "track": 17,
 "year": 2014,
 "coverArt": "mf-2b42782333450d02b177823e729664af_641edeb3",
 "size": 6219581,
 "contentType": "audio/mpeg",
 "suffix": "mp3",
 "duration": 255,
 "bitRate": 194,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "path": "The Polish Ambassador/First Words/17 - Ill with the Skills.mp3",
 "playCount": 1,
 "played": "2023-03-15T15:23:37Z",
 "created": "2023-03-25T11:44:51Z",
 "albumId": "dc8d8889a6fe08d8da7698c7ee1de61c",
 "artistId": "64e1f796b283545d329cdf6a31a31dbe",
 "type": "music",
 "isVideo": false,
 "bookmarkPosition": 7000
 },
 "position": 7000,
 "username": "demo",
 "comment": "playSub bookmark",
 "created": "2023-03-25T11:44:51Z",
 "changed": "2023-03-25T11:44:51Z"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "bookmarks": {
 "bookmark": [
 {
 "entry": {
 "id": "113bf5989ad15ce2cf1834ba9622983f",
 "parent": "b87a936c682c49d4494c7ccb08c22d23",
 "isDir": false,
 "title": "Stay Out Here",
 "album": "Shaking The Habitual",
 "artist": "The Knife",
 "track": 11,
 "year": 2013,
 "genre": "Electronic",
 "coverArt": "al-b87a936c682c49d4494c7ccb08c22d23_0",
 "size": 21096309,
 "contentType": "audio/mp4",
 "suffix": "m4a",
 "duration": 642,
 "bitRate": 257,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "path": "The Knife/Shaking The Habitual/11 - Stay Out Here.m4a",
 "created": "2023-03-13T16:30:35Z",
 "albumId": "b87a936c682c49d4494c7ccb08c22d23",
 "artistId": "b29e9a9d780cb0e133f3add5662771b9",
 "type": "music",
 "isVideo": false,
 "bookmarkPosition": 129000
 },
 "position": 129000,
 "username": "demo",
 "comment": "",
 "created": "2023-03-13T16:30:35Z",
 "changed": "2023-03-13T16:30:35Z"
 },
 {
 "entry": {
 "id": "2b42782333450d02b177823e729664af",
 "parent": "dc8d8889a6fe08d8da7698c7ee1de61c",
 "isDir": false,
 "title": "Ill with the Skills",
 "album": "First Words",
 "artist": "The Polish Ambassador",
 "track": 17,
 "year": 2014,
 "coverArt": "mf-2b42782333450d02b177823e729664af_641edeb3",
 "size": 6219581,
 "contentType": "audio/mpeg",
 "suffix": "mp3",
 "duration": 255,
 "bitRate": 194,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "path": "The Polish Ambassador/First Words/17 - Ill with the Skills.mp3",
 "playCount": 1,
 "played": "2023-03-15T15:23:37Z",
 "created": "2023-03-25T11:44:51Z",
 "albumId": "dc8d8889a6fe08d8da7698c7ee1de61c",
 "artistId": "64e1f796b283545d329cdf6a31a31dbe",
 "type": "music",
 "isVideo": false,
 "bookmarkPosition": 7000
 },
 "position": 7000,
 "username": "demo",
 "comment": "playSub bookmark",
 "created": "2023-03-25T11:44:51Z",
 "changed": "2023-03-25T11:44:51Z"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`bookmarks`	`bookmarks`	Yes		The bookmarks

getPlayQueue

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

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

Returns the state of the play queue for this user (as set by savePlayQueue). 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

Takes no extra parameters.

Example

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

Result

A subsonic-response element with a nested playQueue element on success.

getPlayQueueByIndex

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

OpenSubsonic version: 1

OpenSubsonic extension name indexBasedQueue (As returned by getOpenSubsonicExtensions)

http://your-server/rest/getPlayQueueByIndex

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).

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.

savePlayQueueByIndex

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

OpenSubsonic version: 1

OpenSubsonic extension name indexBasedQueue (As returned by getOpenSubsonicExtensions)

http://your-server/rest/savePlayQueueByIndex

Uses an index instead, as this allows for uniquely identifying play queues which may have multiple copies of the same track.