Skip to content

Latest commit

 

History

History
64 lines (56 loc) · 2.36 KB

SUBSONIC.md

File metadata and controls

64 lines (56 loc) · 2.36 KB
Raw

Subsonic API

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

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.

OpenSubsonic API

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

Authentication

LMS supports the API Key Authentication method. Each user has to generate their own API key on the settings page to use the Subsonic API.

By default, API keys can also be used as passwords, provided the user parameter matches the API key owner. To disable this fallback authentication method, set the following in lms.conf:

api-subsonic-support-user-password-auth = false;

Note: the token+salt authentication method is not supported.

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
    • recordLabels
    • releaseTypes
    • userRating
  • 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