lms/SUBSONIC.md

Subsonic API

The API version implemented is 1.16.0 and has been tested on Android using Subsonic Player, Ultrasonic, Symfonium, and DSub.

Folder navigation commands are supported. However, since LMS does not store information for each folder, it is not possible to star/unstar folders considered as artists. Given the API limitations of folder navigation commands, it is recommended to place all tracks of an album in the same folder and not to mix multiple albums in the same folder.

The Subsonic API is enabled by default.

Note: since LMS may store hashed and salted passwords or may forward authentication requests to external services, it cannot handle the token authentication method. You may need to check your client to make sure to use the password authentication method. Since logins/passwords are passed in plain text through URLs, it is highly recommended to use a unique password when using the Subsonic API. Note that this may affect the use of authentication via PAM. In any case, ensure the web server logs (and proxy logs, if applicable) are properly secured.

OpenSubsonic API

OpenSubsonic is an initiative to patch and extend the legacy Subsonic API. You'll find more details in the official documentation

Extra fields

The following extra fields are implemented:

• Album response:
  • artists
  • discTitles: discs with no subtitle are omitted
  • displayArtist
  • genres
  • isCompilation
  • played
  • mediaType
  • moods
  • musicBrainzId
  • originalReleaseDate
  • releaseTypes
• Child response:
  • albumArtists
  • artists
  • bitDepth
  • channelCount
  • comment
  • contributors
  • displayAlbumArtist
  • displayArtist
  • genres
  • mediaType
  • moods
  • musicBrainzId: note this is actually the recording MBID when this response refers to a song
  • played
  • replayGain
  • samplingRate
• Artist response:
  • mediaType
  • musicBrainzId
  • sortName
  • roles

Supported extensions

• Transcode offset