Addition on OpenSubsonic

Contributor

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

{
 "role": "performer",
 "subRole": "Bass",
 "artist": {
 "id": "ar-1",
 "name": "Artist 1"
 }
}

Does not exist.

Field	Type	Req.	OpenS.	Details
`role`	`string`	Yes	Yes	The contributor role.
`subRole`	`string`	No	Yes	The subRole for roles that may require it. Ex: The instrument for the performer role (TMCL/performer tags). Note: For consistency between different tag formats, the TIPL sub roles should be directly exposed in the role field.
`artist`	`ArtistID3`	Yes	Yes	The artist taking on the role. (Note: Only the required `ArtistID3` fields should be returned by default)

OpenSubsonic

This is a new OpenSubsonic response type.

DiscTitle

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

{
 "disc": 0,
 "title": "The disc title"
}

Does not exist.

Field	Type	Req.	OpenS.	Details
`disc`	`int`	Yes	Yes	The disc number.
`title`	`string`	Yes	Yes	The name of the disc.

OpenSubsonic

This is a new OpenSubsonic response type.

getOpenSubsonicExtensions

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

http://your-server/rest/getOpenSubsonicExtensions OpenSubsonic version 1

List the OpenSubsonic extensions supported by this server.

Parameters

Takes no extra parameters.

Note: Unlike all other APIs getOpenSubsonicExtensions must be publicly accessible.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "openSubsonicExtensions": [
 {
 "name": "template",
 "versions": [
 1,
 2
 ]
 },
 {
 "name": "transcodeOffset",
 "versions": [
 1
 ]
 }
 ]
 }
}

Does not exist.

Field	Type	Req.	OpenS.	Details
`openSubsonicExtensions`	An array of `openSubsonicExtension`	Yes		The list of supported extensions

OpenSubsonic

This is a new endpoint.

line

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

{
 "start": 0,
 "value": "It's bugging me"
}

<line start="0">It's bugging me</line>

Does not exist.

Field	Type	Req.	OpenS.	Details
`value`	`string`	Yes	Yes	The actual text of this line
`start`	`number`	No	Yes	The start time of the lyrics, relative to the start time of the track, in milliseconds. If this is not part of synced lyrics, start must be omitted

OpenSubsonic

This is a new OpenSubsonic response type.

lyricsList

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

{
 "structuredLyrics": [
 {
 "displayArtist": "Muse",
 "displayTitle": "Hysteria",
 "lang": "eng",
 "offset": -100,
 "synced": true,
 "line": [
 {
 "start": 0,
 "value": "It's bugging me"
 },
 {
 "start": 2000,
 "value": "Grating me"
 },
 {
 "start": 3001,
 "value": "And twisting me around..."
 }
 ]
 },
 {
 "displayArtist": "Muse",
 "displayTitle": "Hysteria",
 "lang": "xxx",
 "offset": 100,
 "synced": false,
 "line": [
 {
 "value": "It's bugging me"
 },
 {
 "value": "Grating me"
 },
 {
 "value": "And twisting me around..."
 }
 ]
 }
 ]
}

<lyricsList>
 <structuredLyrics displayArtist="Muse" displayTitle="Hysteria" lang="eng" offset="-100" synced="true">
 <line start="0">It's bugging me</line>
 <line start="2000">Grating me</line>
 <line start="3001">And twisting me around...</line>
 </structuredLyrics>
 <structuredLyrics displayArtist="Muse" displayTitle="Hysteria" lang="xxx" offset="100" synced="false">
 <line>It's bugging me</line>
 <line>Grating me</line>
 <line>And twisting me around...</line>
 </structuredLyrics>
</lyricsList>

Does not exist.

Field	Type	Req.	OpenS.	Details
`structuredLyrics`	Array of `structuredLyrics`	No	Yes	Structured lyrics. There can be multiple lyrics of the same type with the same language

OpenSubsonic

This is a new OpenSubsonic response type.

ReplayGain

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

{
 "trackGain": 0.1,
 "albumGain": 1.1,
 "trackPeak": 9.2,
 "albumPeak": 0,
 "baseGain": 0,
 "fallbackGain": -8.1
}

Does not exist.

Field	Type	Req.	OpenS.	Details
`trackGain`	`number`	No	Yes	The track replay gain value. (In Db)
`albumGain`	`number`	No	Yes	The album replay gain value. (In Db)
`trackPeak`	`number`	No	Yes	The track peak value. (Must be positive)
`albumPeak`	`number`	No	Yes	The album peak value. (Must be positive)
`baseGain`	`number`	No	Yes	The base gain value. (In Db) (Ogg Opus Output Gain for example)
`fallbackGain`	`number`	No	Yes	An optional fallback gain that clients should apply when the corresponding gain value is missing. (Can be computed from the tracks or exposed as an user setting.)

Note: If the data is not present the field must be omitted in the answer. (But the replayGain field on Child must always be present)

stream

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

http://your-server/rest/stream Since 1.0.0

Streams a given media file.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			A string which uniquely identifies the file to stream. Obtained by calls to getMusicDirectory.
`maxBitRate`	No			(Since 1.2.0) If specified, the server will attempt to limit the bitrate to this value, in kilobits per second. If set to zero, no limit is imposed.
`format`	No			(Since 1.6.0) Specifies the preferred target format (e.g., “mp3” or “flv”) in case there are multiple applicable transcodings. Starting with 1.9.0 you can use the special value “raw” to disable transcoding.
`timeOffset`	No	No / Yes		By default only applicable to video streaming. If specified, start streaming at the given offset (in seconds) into the media. The `Transcode Offset` extension enables the parameter to music too.
`size`	No			(Since 1.6.0) Only applicable to video streaming. Requested video size specified as WxH, for instance “640x480”.
`estimateContentLength`	No		false	(Since 1.8.0). If set to “true”, the Content-Length HTTP header will be set to an estimated value for transcoded or downsampled media.
`converted`	No		false	(Since 1.14.0) Only applicable to video streaming. Servers can optimize videos for streaming by converting them to MP4. If a conversion exists for the video in question, then setting this parameter to “true” will cause the converted video to be returned instead of the original.

Example

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

Result

Returns binary data on success, or an XML document on error (in which case the HTTP content type will start with “text/xml”).

structuredLyrics

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

{
 "displayArtist": "Muse",
 "displayTitle": "Hysteria",
 "lang": "xxx",
 "offset": -100,
 "synced": true,
 "line": [
 {
 "start": 0,
 "value": "It's bugging me"
 },
 {
 "start": 2000,
 "value": "Grating me"
 },
 {
 "start": 3001,
 "value": "And twisting me around..."
 }
 ]
}

<structuredLyrics displayArtist="Muse" displayTitle="Hysteria" lang="xxx" offset="-100" synced="true">
 <line start="0">It's bugging me</line>
 <line start="2000">Grating me</line>
 <line start="3001">And twisting me around...</line>
</structuredLyrics>

Does not exist.

Field	Type	Req.	OpenS.	Details
`lang`	`string`	Yes	Yes	The lyrics language (ideally ISO 639). If the language is unknown (e.g. lrc file), the server must return `und` (ISO standard) or `xxx` (common value for taggers)
`synced`	`boolean`	Yes	Yes	True if the lyrics are synced, false otherwise
`line`	Array of `line`	Yes	Yes	The actual lyrics. Ordered by start time (synced) or appearance order (unsynced)
`displayArtist`	`string`	No	Yes	The artist name to display. This could be the localized name, or any other value
`displayTitle`	`string`	No	Yes	The title to display. This could be the song title (localized), or any other value
`offset`	`number`	No	Yes	The offset to apply to all lyrics, in milliseconds. Positive means lyrics appear sooner, negative means later. If not included, the offset must be assumed to be 0

OpenSubsonic

This is a new OpenSubsonic response type.

tokenInfo

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

OpenSubsonic version: 1

OpenSubsonic extension name apiKeyAuthentication (As returned by getOpenSubsonicExtensions)

Returns data about an API key.

http://your-server/rest/tokenInfo

Parameters

None

Example

http://your-server/rest/tokenInfo.view?apiKey=1234&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested tokenInfo on success, or error 44 on invalid token.

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

<subsonic-response status="ok" version="1.16.1" type="AwesomeServerName" serverVersion="0.1.3 (tag)" openSubsonic="true">
 <tokenInfo username="token username"></tokenInfo>
</subsonic-response>

Does not exist.

Field	Type	Req.	OpenS.	Details
`tokenInfo`	`tokenInfo`	Yes	Yes	Information about the token

tokenInfo

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

{
 "tokenInfo": {
 "username": "token username"
 }
}

<tokenInfo username="token username"></tokenInfo>

Does not exist.

Field	Type	Req.	OpenS.	Details
`username`	string	Yes	Yes	Username associated with token