mirror of
https://github.com/spl0k/supysonic.git
synced 2024-11-12 21:22:17 +00:00
1287 lines
29 KiB
ReStructuredText
1287 lines
29 KiB
ReStructuredText
|
Subsonic API breakdown
|
||
|
======================
|
||
|
|
||
|
This page lists all the API methods and their parameters up to the version
|
||
|
1.16.0 (Subsonic 6.1.2). Here you'll find details about which API features
|
||
|
*Supysonic* support, plan on supporting, or won't.
|
||
|
|
||
|
At the moment, the current target API version is 1.10.2.
|
||
|
|
||
|
The following information was gathered by *diff*-ing various snapshots of the
|
||
|
`Subsonic API page <http://www.subsonic.org/pages/api.jsp>`_.
|
||
|
|
||
|
Methods and parameters listing
|
||
|
------------------------------
|
||
|
|
||
|
Statuses explanation:
|
||
|
|
||
|
* 📅: planned
|
||
|
* ✔️: done
|
||
|
* ❌: done as not supported
|
||
|
* 🔴: won't be implemented
|
||
|
* ❔: not decided yet
|
||
|
|
||
|
The version column specifies the API version which added the related method or
|
||
|
parameter. When no version is given, it means the item was introduced prior to
|
||
|
or with version 1.8.0.
|
||
|
|
||
|
All methods / pseudo-TOC
|
||
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
||
|
|
||
|
============================================================== ====== =
|
||
|
Method Vers.
|
||
|
============================================================== ====== =
|
||
|
:ref:`ping <ping>` ✔️
|
||
|
:ref:`getLicense <getLicense>` ✔️
|
||
|
:ref:`getMusicFolders <getMusicFolders>` ✔️
|
||
|
:ref:`getIndexes <getIndexes>` ✔️
|
||
|
:ref:`getMusicDirectory <getMusicDirectory>` ✔️
|
||
|
:ref:`getGenres <getGenres>` 1.9.0 ✔️
|
||
|
:ref:`getArtists <getArtists>` ✔️
|
||
|
:ref:`getArtist <getArtist>` ✔️
|
||
|
:ref:`getAlbum <getAlbum>` ✔️
|
||
|
:ref:`getSong <getSong>` ✔️
|
||
|
:ref:`getVideos <getVideos>` ❌
|
||
|
:ref:`getVideoInfo <getVideoInfo>` 1.15.0 🔴
|
||
|
:ref:`getArtistInfo <getArtistInfo>` 1.11.0 📅
|
||
|
:ref:`getArtistInfo2 <getArtistInfo2>` 1.11.0 📅
|
||
|
:ref:`getAlbumInfo <getAlbumInfo>` 1.14.0 📅
|
||
|
:ref:`getAlbumInfo2 <getAlbumInfo2>` 1.14.0 📅
|
||
|
:ref:`getSimilarSongs <getSimilarSongs>` 1.11.0 ❔
|
||
|
:ref:`getSimilarSongs2 <getSimilarSongs2>` 1.11.0 ❔
|
||
|
:ref:`getTopSongs <getTopSongs>` 1.13.0 ❔
|
||
|
:ref:`getAlbumList <getAlbumList>` ✔️
|
||
|
:ref:`getAlbumList2 <getAlbumList2>` ✔️
|
||
|
:ref:`getRandomSongs <getRandomSongs>` ✔️
|
||
|
:ref:`getSongsByGenre <getSongsByGenre>` 1.9.0 ✔️
|
||
|
:ref:`getNowPlaying <getNowPlaying>` ✔️
|
||
|
:ref:`getStarred <getStarred>` ✔️
|
||
|
:ref:`getStarred2 <getStarred2>` ✔️
|
||
|
:ref:`search <search->` ✔️
|
||
|
:ref:`search2 <search2>` ✔️
|
||
|
:ref:`search3 <search3>` ✔️
|
||
|
:ref:`getPlaylists <getPlaylists>` ✔️
|
||
|
:ref:`getPlaylist <getPlaylist>` ✔️
|
||
|
:ref:`createPlaylist <createPlaylist>` ✔️
|
||
|
:ref:`updatePlaylist <updatePlaylist>` ✔️
|
||
|
:ref:`deletePlaylist <deletePlaylist>` ✔️
|
||
|
:ref:`stream <stream>` ✔️
|
||
|
:ref:`download <download>` ✔️
|
||
|
:ref:`hls <hls>` 1.9.0 🔴
|
||
|
:ref:`getCaptions <getCaptions>` 1.15.0 🔴
|
||
|
:ref:`getCoverArt <getCoverArt>` ✔️
|
||
|
:ref:`getLyrics <getLyrics>` ✔️
|
||
|
:ref:`getAvatar <getAvatar>` ❌
|
||
|
:ref:`star <star>` ✔️
|
||
|
:ref:`unstar <unstar>` ✔️
|
||
|
:ref:`setRating <setRating>` ✔️
|
||
|
:ref:`scrobble <scrobble>` ✔️
|
||
|
:ref:`getShares <getShares>` ❌
|
||
|
:ref:`createShare <createShare>` ❌
|
||
|
:ref:`updateShare <updateShare>` ❌
|
||
|
:ref:`deleteShare <deleteShare>` ❌
|
||
|
:ref:`getPodcasts <getPodcasts>` ❔
|
||
|
:ref:`getNewestPodcasts <getNewestPodcasts>` 1.14.0 ❔
|
||
|
:ref:`refreshPodcasts <refreshPodcasts>` 1.9.0 ❔
|
||
|
:ref:`createPodcastChannel <createPodcastChannel>` 1.9.0 ❔
|
||
|
:ref:`deletePodcastChannel <deletePodcastChannel>` 1.9.0 ❔
|
||
|
:ref:`deletePodcastEpisode <deletePodcastEpisode>` 1.9.0 ❔
|
||
|
:ref:`downloadPodcastEpisode <downloadPodcastEpisode>` 1.9.0 ❔
|
||
|
:ref:`jukeboxControl <jukeboxControl>` ✔️
|
||
|
:ref:`getInternetRadioStations <getInternetRadioStations>` 1.9.0 ✔️
|
||
|
:ref:`createInternetRadioStation <createInternetRadioStation>` 1.16.0 ✔️
|
||
|
:ref:`updateInternetRadioStation <updateInternetRadioStation>` 1.16.0 ✔️
|
||
|
:ref:`deleteInternetRadioStation <deleteInternetRadioStation>` 1.16.0 ✔️
|
||
|
:ref:`getChatMessages <getChatMessages>` ✔️
|
||
|
:ref:`addChatMessage <addChatMessage>` ✔️
|
||
|
:ref:`getUser <getUser>` ✔️
|
||
|
:ref:`getUsers <getUsers>` 1.9.0 ✔️
|
||
|
:ref:`createUser <createUser>` ✔️
|
||
|
:ref:`updateUser <updateUser>` 1.10.2 ✔️
|
||
|
:ref:`deleteUser <deleteUser>` ✔️
|
||
|
:ref:`changePassword <changePassword>` ✔️
|
||
|
:ref:`getBookmarks <getBookmarks>` 1.9.0 ❔
|
||
|
:ref:`createBookmark <createBookmark>` 1.9.0 ❔
|
||
|
:ref:`deleteBookmark <deleteBookmark>` 1.9.0 ❔
|
||
|
:ref:`getPlayQueue <getPlayQueue>` 1.12.0 ❔
|
||
|
:ref:`savePlayQueue <savePlayQueue>` 1.12.0 ❔
|
||
|
:ref:`getScanStatus <getScanStatus>` 1.15.0 ✔️
|
||
|
:ref:`startScan <startScan>` 1.15.0 ✔️
|
||
|
============================================================== ====== =
|
||
|
|
||
|
Global
|
||
|
^^^^^^
|
||
|
|
||
|
Parameters used for any request
|
||
|
|
||
|
===== ====== =
|
||
|
P. Vers.
|
||
|
===== ====== =
|
||
|
``u`` ✔️
|
||
|
``p`` ✔️
|
||
|
``t`` 1.13.0 🔴
|
||
|
``s`` 1.13.0 🔴
|
||
|
``v`` ✔️
|
||
|
``c`` ✔️
|
||
|
``f`` ✔️
|
||
|
===== ====== =
|
||
|
|
||
|
Error codes
|
||
|
|
||
|
== ====== =
|
||
|
# Vers.
|
||
|
== ====== =
|
||
|
0 ✔️
|
||
|
10 ✔️
|
||
|
20 ✔️
|
||
|
30 ✔️
|
||
|
40 ✔️
|
||
|
41 1.15.0 📅
|
||
|
50 ✔️
|
||
|
60 ✔️
|
||
|
70 ✔️
|
||
|
== ====== =
|
||
|
|
||
|
System
|
||
|
^^^^^^
|
||
|
|
||
|
.. _ping:
|
||
|
|
||
|
``ping``
|
||
|
✔️
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _getLicense:
|
||
|
|
||
|
``getLicense``
|
||
|
✔️
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
Browsing
|
||
|
^^^^^^^^
|
||
|
|
||
|
.. _getMusicFolders:
|
||
|
|
||
|
``getMusicFolders``
|
||
|
✔️
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _getIndexes:
|
||
|
|
||
|
``getIndexes``
|
||
|
✔️
|
||
|
|
||
|
=================== ===== =
|
||
|
Parameter Vers.
|
||
|
=================== ===== =
|
||
|
``musicFolderId`` ✔️
|
||
|
``ifModifiedSince`` ✔️
|
||
|
=================== ===== =
|
||
|
|
||
|
.. _getMusicDirectory:
|
||
|
|
||
|
``getMusicDirectory``
|
||
|
✔️
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` ✔️
|
||
|
========= ===== =
|
||
|
|
||
|
.. _getGenres:
|
||
|
|
||
|
``getGenres``
|
||
|
✔️ 1.9.0
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _getArtists:
|
||
|
|
||
|
``getArtists``
|
||
|
✔️
|
||
|
|
||
|
================= ====== =
|
||
|
Parameter Vers.
|
||
|
================= ====== =
|
||
|
``musicFolderId`` 1.14.0 📅
|
||
|
================= ====== =
|
||
|
|
||
|
.. _getArtist:
|
||
|
|
||
|
``getArtist``
|
||
|
✔️
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` ✔️
|
||
|
========= ===== =
|
||
|
|
||
|
.. _getAlbum:
|
||
|
|
||
|
``getAlbum``
|
||
|
✔️
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` ✔️
|
||
|
========= ===== =
|
||
|
|
||
|
.. _getSong:
|
||
|
|
||
|
``getSong``
|
||
|
✔️
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` ✔️
|
||
|
========= ===== =
|
||
|
|
||
|
.. _getVideos:
|
||
|
|
||
|
``getVideos``
|
||
|
❌
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _getVideoInfo:
|
||
|
|
||
|
``getVideoInfo``
|
||
|
🔴 1.15.0
|
||
|
|
||
|
========= ====== =
|
||
|
Parameter Vers.
|
||
|
========= ====== =
|
||
|
``id`` 1.15.0 🔴
|
||
|
========= ====== =
|
||
|
|
||
|
.. _getArtistInfo:
|
||
|
|
||
|
``getArtistInfo``
|
||
|
📅 1.11.0
|
||
|
|
||
|
===================== ====== =
|
||
|
Parameter Vers.
|
||
|
===================== ====== =
|
||
|
``id`` 1.11.0 📅
|
||
|
``count`` 1.11.0 📅
|
||
|
``includeNotPresent`` 1.11.0 📅
|
||
|
===================== ====== =
|
||
|
|
||
|
.. _getArtistInfo2:
|
||
|
|
||
|
``getArtistInfo2``
|
||
|
📅 1.11.0
|
||
|
|
||
|
===================== ====== =
|
||
|
Parameter Vers.
|
||
|
===================== ====== =
|
||
|
``id`` 1.11.0 📅
|
||
|
``count`` 1.11.0 📅
|
||
|
``includeNotPresent`` 1.11.0 📅
|
||
|
===================== ====== =
|
||
|
|
||
|
.. _getAlbumInfo:
|
||
|
|
||
|
``getAlbumInfo``
|
||
|
📅 1.14.0
|
||
|
|
||
|
========= ====== =
|
||
|
Parameter Vers.
|
||
|
========= ====== =
|
||
|
``id`` 1.14.0 📅
|
||
|
========= ====== =
|
||
|
|
||
|
.. _getAlbumInfo2:
|
||
|
|
||
|
``getAlbumInfo2``
|
||
|
📅 1.14.0
|
||
|
|
||
|
========= ====== =
|
||
|
Parameter Vers.
|
||
|
========= ====== =
|
||
|
``id`` 1.14.0 📅
|
||
|
========= ====== =
|
||
|
|
||
|
.. _getSimilarSongs:
|
||
|
|
||
|
``getSimilarSongs``
|
||
|
❔ 1.11.0
|
||
|
|
||
|
========= ====== =
|
||
|
Parameter Vers.
|
||
|
========= ====== =
|
||
|
``id`` 1.11.0 ❔
|
||
|
``count`` 1.11.0 ❔
|
||
|
========= ====== =
|
||
|
|
||
|
.. _getSimilarSongs2:
|
||
|
|
||
|
``getSimilarSongs2``
|
||
|
❔ 1.11.0
|
||
|
|
||
|
========= ====== =
|
||
|
Parameter Vers.
|
||
|
========= ====== =
|
||
|
``id`` 1.11.0 ❔
|
||
|
``count`` 1.11.0 ❔
|
||
|
========= ====== =
|
||
|
|
||
|
.. _getTopSongs:
|
||
|
|
||
|
``getTopSongs``
|
||
|
❔ 1.13.0
|
||
|
|
||
|
========== ====== =
|
||
|
Parameter Vers.
|
||
|
========== ====== =
|
||
|
``artist`` 1.13.0 ❔
|
||
|
``count`` 1.13.0 ❔
|
||
|
========== ====== =
|
||
|
|
||
|
Album/song lists
|
||
|
^^^^^^^^^^^^^^^^
|
||
|
|
||
|
.. _getAlbumList:
|
||
|
|
||
|
``getAlbumList``
|
||
|
✔️
|
||
|
|
||
|
================= ====== =
|
||
|
Parameter Vers.
|
||
|
================= ====== =
|
||
|
``type`` ✔️
|
||
|
``size`` ✔️
|
||
|
``offset`` ✔️
|
||
|
``fromYear`` ✔️
|
||
|
``toYear`` ✔️
|
||
|
``genre`` ✔️
|
||
|
``musicFolderId`` 1.12.0 📅
|
||
|
================= ====== =
|
||
|
|
||
|
.. versionadded:: 1.10.1
|
||
|
``byYear`` and ``byGenre`` were added to ``type``
|
||
|
|
||
|
.. _getAlbumList2:
|
||
|
|
||
|
``getAlbumList2``
|
||
|
✔️
|
||
|
|
||
|
================= ====== =
|
||
|
Parameter Vers.
|
||
|
================= ====== =
|
||
|
``type`` ✔️
|
||
|
``size`` ✔️
|
||
|
``offset`` ✔️
|
||
|
``fromYear`` ✔️
|
||
|
``toYear`` ✔️
|
||
|
``genre`` ✔️
|
||
|
``musicFolderId`` 1.12.0 📅
|
||
|
================= ====== =
|
||
|
|
||
|
.. versionadded:: 1.10.1
|
||
|
``byYear`` and ``byGenre`` were added to ``type``
|
||
|
|
||
|
.. _getRandomSongs:
|
||
|
|
||
|
``getRandomSongs``
|
||
|
✔️
|
||
|
|
||
|
================= ===== =
|
||
|
Parameter Vers.
|
||
|
================= ===== =
|
||
|
``size`` ✔️
|
||
|
``genre`` ✔️
|
||
|
``fromYear`` ✔️
|
||
|
``toYear`` ✔️
|
||
|
``musicFolderId`` ✔️
|
||
|
================= ===== =
|
||
|
|
||
|
.. _getSongsByGenre:
|
||
|
|
||
|
``getSongsByGenre``
|
||
|
✔️ 1.9.0
|
||
|
|
||
|
================= ====== =
|
||
|
Parameter Vers.
|
||
|
================= ====== =
|
||
|
``genre`` 1.9.0 ✔️
|
||
|
``count`` 1.9.0 ✔️
|
||
|
``offset`` 1.9.0 ✔️
|
||
|
``musicFolderId`` 1.12.0 📅
|
||
|
================= ====== =
|
||
|
|
||
|
.. _getNowPlaying:
|
||
|
|
||
|
``getNowPlaying``
|
||
|
✔️
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _getStarred:
|
||
|
|
||
|
``getStarred``
|
||
|
✔️
|
||
|
|
||
|
================= ====== =
|
||
|
Parameter Vers.
|
||
|
================= ====== =
|
||
|
``musicFolderId`` 1.12.0 📅
|
||
|
================= ====== =
|
||
|
|
||
|
.. _getStarred2:
|
||
|
|
||
|
``getStarred2``
|
||
|
✔️
|
||
|
|
||
|
================= ====== =
|
||
|
Parameter Vers.
|
||
|
================= ====== =
|
||
|
``musicFolderId`` 1.12.0 📅
|
||
|
================= ====== =
|
||
|
|
||
|
Searching
|
||
|
^^^^^^^^^
|
||
|
|
||
|
.. _search-:
|
||
|
|
||
|
``search``
|
||
|
✔️
|
||
|
|
||
|
============= ===== =
|
||
|
Parameter Vers.
|
||
|
============= ===== =
|
||
|
``artist`` ✔️
|
||
|
``album`` ✔️
|
||
|
``title`` ✔️
|
||
|
``any`` ✔️
|
||
|
``count`` ✔️
|
||
|
``offset`` ✔️
|
||
|
``newerThan`` ✔️
|
||
|
============= ===== =
|
||
|
|
||
|
.. _search2:
|
||
|
|
||
|
``search2``
|
||
|
✔️
|
||
|
|
||
|
================= ====== =
|
||
|
Parameter Vers.
|
||
|
================= ====== =
|
||
|
``query`` ✔️
|
||
|
``artistCount`` ✔️
|
||
|
``artistOffset`` ✔️
|
||
|
``albumCount`` ✔️
|
||
|
``albumOffset`` ✔️
|
||
|
``songCount`` ✔️
|
||
|
``songOffset`` ✔️
|
||
|
``musicFolderId`` 1.12.0 📅
|
||
|
================= ====== =
|
||
|
|
||
|
.. _search3:
|
||
|
|
||
|
``search3``
|
||
|
✔️
|
||
|
|
||
|
================= ====== =
|
||
|
Parameter Vers.
|
||
|
================= ====== =
|
||
|
``query`` ✔️
|
||
|
``artistCount`` ✔️
|
||
|
``artistOffset`` ✔️
|
||
|
``albumCount`` ✔️
|
||
|
``albumOffset`` ✔️
|
||
|
``songCount`` ✔️
|
||
|
``songOffset`` ✔️
|
||
|
``musicFolderId`` 1.12.0 📅
|
||
|
================= ====== =
|
||
|
|
||
|
Playlists
|
||
|
^^^^^^^^^
|
||
|
|
||
|
.. _getPlaylists:
|
||
|
|
||
|
``getPlaylists``
|
||
|
✔️
|
||
|
|
||
|
============ ===== =
|
||
|
Parameter Vers.
|
||
|
============ ===== =
|
||
|
``username`` ✔️
|
||
|
============ ===== =
|
||
|
|
||
|
.. _getPlaylist:
|
||
|
|
||
|
``getPlaylist``
|
||
|
✔️
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` ✔️
|
||
|
========= ===== =
|
||
|
|
||
|
.. _createPlaylist:
|
||
|
|
||
|
``createPlaylist``
|
||
|
✔️
|
||
|
|
||
|
============== ===== =
|
||
|
Parameter Vers.
|
||
|
============== ===== =
|
||
|
``playlistId`` ✔️
|
||
|
``name`` ✔️
|
||
|
``songId`` ✔️
|
||
|
============== ===== =
|
||
|
|
||
|
.. _updatePlaylist:
|
||
|
|
||
|
``updatePlaylist``
|
||
|
✔️
|
||
|
|
||
|
===================== ===== =
|
||
|
Parameter Vers.
|
||
|
===================== ===== =
|
||
|
``playlistId`` ✔️
|
||
|
``name`` ✔️
|
||
|
``comment`` ✔️
|
||
|
``public`` 1.9.0 ✔️
|
||
|
``songIdToAdd`` ✔️
|
||
|
``songIndexToRemove`` ✔️
|
||
|
===================== ===== =
|
||
|
|
||
|
.. _deletePlaylist:
|
||
|
|
||
|
``deletePlaylist``
|
||
|
✔️
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` ✔️
|
||
|
========= ===== =
|
||
|
|
||
|
Media retrieval
|
||
|
^^^^^^^^^^^^^^^
|
||
|
|
||
|
.. _stream:
|
||
|
|
||
|
``stream``
|
||
|
✔️
|
||
|
|
||
|
========================= ====== =
|
||
|
Parameter Vers.
|
||
|
========================= ====== =
|
||
|
``id`` ✔️
|
||
|
``maxBitRate`` ✔️
|
||
|
``format`` ✔️
|
||
|
``timeOffset`` ❌
|
||
|
``size`` ❌
|
||
|
``estimateContentLength`` ✔️
|
||
|
``converted`` 1.15.0 🔴
|
||
|
========================= ====== =
|
||
|
|
||
|
.. _download:
|
||
|
|
||
|
``download``
|
||
|
✔️
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` ✔️
|
||
|
========= ===== =
|
||
|
|
||
|
.. _hls:
|
||
|
|
||
|
``hls``
|
||
|
🔴 1.9.0
|
||
|
|
||
|
============== ====== =
|
||
|
Parameter Vers.
|
||
|
============== ====== =
|
||
|
``id`` 1.9.0 🔴
|
||
|
``bitRate`` 1.9.0 🔴
|
||
|
``audioTrack`` 1.15.0 🔴
|
||
|
============== ====== =
|
||
|
|
||
|
.. _getCaptions:
|
||
|
|
||
|
``getCaptions``
|
||
|
🔴 1.15.0
|
||
|
|
||
|
========== ====== =
|
||
|
Parameter Vers.
|
||
|
========== ====== =
|
||
|
``id`` 1.15.0 🔴
|
||
|
``format`` 1.15.0 🔴
|
||
|
========== ====== =
|
||
|
|
||
|
.. _getCoverArt:
|
||
|
|
||
|
``getCoverArt``
|
||
|
✔️
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` ✔️
|
||
|
``size`` ✔️
|
||
|
========= ===== =
|
||
|
|
||
|
.. _getLyrics:
|
||
|
|
||
|
``getLyrics``
|
||
|
✔️
|
||
|
|
||
|
========== ===== =
|
||
|
Parameter Vers.
|
||
|
========== ===== =
|
||
|
``artist`` ✔️
|
||
|
``title`` ✔️
|
||
|
========== ===== =
|
||
|
|
||
|
.. _getAvatar:
|
||
|
|
||
|
``getAvatar``
|
||
|
❌
|
||
|
|
||
|
============ ===== =
|
||
|
Parameter Vers.
|
||
|
============ ===== =
|
||
|
``username`` ❌
|
||
|
============ ===== =
|
||
|
|
||
|
Media annotation
|
||
|
^^^^^^^^^^^^^^^^
|
||
|
|
||
|
.. _star:
|
||
|
|
||
|
``star``
|
||
|
✔️
|
||
|
|
||
|
============ ===== =
|
||
|
Parameter Vers.
|
||
|
============ ===== =
|
||
|
``id`` ✔️
|
||
|
``albumId`` ✔️
|
||
|
``artistId`` ✔️
|
||
|
============ ===== =
|
||
|
|
||
|
.. _unstar:
|
||
|
|
||
|
``unstar``
|
||
|
✔️
|
||
|
|
||
|
============ ===== =
|
||
|
Parameter Vers.
|
||
|
============ ===== =
|
||
|
``id`` ✔️
|
||
|
``albumId`` ✔️
|
||
|
``artistId`` ✔️
|
||
|
============ ===== =
|
||
|
|
||
|
.. _setRating:
|
||
|
|
||
|
``setRating``
|
||
|
✔️
|
||
|
|
||
|
========== ===== =
|
||
|
Parameter Vers.
|
||
|
========== ===== =
|
||
|
``id`` ✔️
|
||
|
``rating`` ✔️
|
||
|
========== ===== =
|
||
|
|
||
|
.. _scrobble:
|
||
|
|
||
|
``scrobble``
|
||
|
✔️
|
||
|
|
||
|
============== ===== =
|
||
|
Parameter Vers.
|
||
|
============== ===== =
|
||
|
``id`` ✔️
|
||
|
``time`` 1.9.0 ✔️
|
||
|
``submission`` ✔️
|
||
|
============== ===== =
|
||
|
|
||
|
Sharing
|
||
|
^^^^^^^
|
||
|
|
||
|
.. _getShares:
|
||
|
|
||
|
``getShares``
|
||
|
❌
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _createShare:
|
||
|
|
||
|
``createShare``
|
||
|
❌
|
||
|
|
||
|
=============== ===== =
|
||
|
Parameter Vers.
|
||
|
=============== ===== =
|
||
|
``id`` ❌
|
||
|
``description`` ❌
|
||
|
``expires`` ❌
|
||
|
=============== ===== =
|
||
|
|
||
|
.. _updateShare:
|
||
|
|
||
|
``updateShare``
|
||
|
❌
|
||
|
|
||
|
=============== ===== =
|
||
|
Parameter Vers.
|
||
|
=============== ===== =
|
||
|
``id`` ❌
|
||
|
``description`` ❌
|
||
|
``expires`` ❌
|
||
|
=============== ===== =
|
||
|
|
||
|
.. _deleteShare:
|
||
|
|
||
|
``deleteShare``
|
||
|
❌
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` ❌
|
||
|
========= ===== =
|
||
|
|
||
|
Podcast
|
||
|
^^^^^^^
|
||
|
|
||
|
.. _getPodcasts:
|
||
|
|
||
|
``getPodcasts``
|
||
|
❔
|
||
|
|
||
|
=================== ===== =
|
||
|
Parameter Vers.
|
||
|
=================== ===== =
|
||
|
``includeEpisodes`` 1.9.0 ❔
|
||
|
``id`` 1.9.0 ❔
|
||
|
=================== ===== =
|
||
|
|
||
|
.. _getNewestPodcasts:
|
||
|
|
||
|
``getNewestPodcasts``
|
||
|
❔ 1.14.0
|
||
|
|
||
|
========= ====== =
|
||
|
Parameter Vers.
|
||
|
========= ====== =
|
||
|
``count`` 1.14.0 ❔
|
||
|
========= ====== =
|
||
|
|
||
|
.. _refreshPodcasts:
|
||
|
|
||
|
``refreshPodcasts``
|
||
|
❔ 1.9.0
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _createPodcastChannel:
|
||
|
|
||
|
``createPodcastChannel``
|
||
|
❔ 1.9.0
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``url`` 1.9.0 ❔
|
||
|
========= ===== =
|
||
|
|
||
|
.. _deletePodcastChannel:
|
||
|
|
||
|
``deletePodcastChannel``
|
||
|
❔ 1.9.0
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` 1.9.0 ❔
|
||
|
========= ===== =
|
||
|
|
||
|
.. _deletePodcastEpisode:
|
||
|
|
||
|
``deletePodcastEpisode``
|
||
|
❔ 1.9.0
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` 1.9.0 ❔
|
||
|
========= ===== =
|
||
|
|
||
|
.. _downloadPodcastEpisode:
|
||
|
|
||
|
``downloadPodcastEpisode``
|
||
|
❔ 1.9.0
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``id`` 1.9.0 ❔
|
||
|
========= ===== =
|
||
|
|
||
|
Jukebox
|
||
|
^^^^^^^
|
||
|
|
||
|
.. _jukeboxControl:
|
||
|
|
||
|
``jukeboxControl``
|
||
|
✔️
|
||
|
|
||
|
========== ===== =
|
||
|
Parameter Vers.
|
||
|
========== ===== =
|
||
|
``action`` ✔️
|
||
|
``index`` ✔️
|
||
|
``offset`` ✔️
|
||
|
``id`` ✔️
|
||
|
``gain`` ❌
|
||
|
========== ===== =
|
||
|
|
||
|
Internet radio
|
||
|
^^^^^^^^^^^^^^
|
||
|
|
||
|
.. _getInternetRadioStations:
|
||
|
|
||
|
``getInternetRadioStations``
|
||
|
❔ 1.9.0
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _createInternetRadioStation:
|
||
|
|
||
|
``createInternetRadioStation``
|
||
|
❔ 1.16.0
|
||
|
|
||
|
=============== ====== =
|
||
|
Parameter Vers.
|
||
|
=============== ====== =
|
||
|
``streamUrl`` 1.16.0 ❔
|
||
|
``name`` 1.16.0 ❔
|
||
|
``homepageUrl`` 1.16.0 ❔
|
||
|
=============== ====== =
|
||
|
|
||
|
.. _updateInternetRadioStation:
|
||
|
|
||
|
``updateInternetRadioStation``
|
||
|
❔ 1.16.0
|
||
|
|
||
|
=============== ====== =
|
||
|
Parameter Vers.
|
||
|
=============== ====== =
|
||
|
``id`` 1.16.0 ❔
|
||
|
``streamUrl`` 1.16.0 ❔
|
||
|
``name`` 1.16.0 ❔
|
||
|
``homepageUrl`` 1.16.0 ❔
|
||
|
=============== ====== =
|
||
|
|
||
|
.. _deleteInternetRadioStation:
|
||
|
|
||
|
``deleteInternetRadioStation``
|
||
|
❔ 1.16.0
|
||
|
|
||
|
=============== ====== =
|
||
|
Parameter Vers.
|
||
|
=============== ====== =
|
||
|
``id`` 1.16.0 ❔
|
||
|
=============== ====== =
|
||
|
|
||
|
Chat
|
||
|
^^^^
|
||
|
|
||
|
.. _getChatMessages:
|
||
|
|
||
|
``getChatMessages``
|
||
|
✔️
|
||
|
|
||
|
========= ===== =
|
||
|
Parameter Vers.
|
||
|
========= ===== =
|
||
|
``since`` ✔️
|
||
|
========= ===== =
|
||
|
|
||
|
.. _addChatMessage:
|
||
|
|
||
|
``addChatMessage``
|
||
|
✔️
|
||
|
|
||
|
=========== ===== =
|
||
|
Parameter Vers.
|
||
|
=========== ===== =
|
||
|
``message`` ✔️
|
||
|
=========== ===== =
|
||
|
|
||
|
User management
|
||
|
^^^^^^^^^^^^^^^
|
||
|
|
||
|
.. _getUser:
|
||
|
|
||
|
``getUser``
|
||
|
✔️
|
||
|
|
||
|
============ ===== =
|
||
|
Parameter Vers.
|
||
|
============ ===== =
|
||
|
``username`` ✔️
|
||
|
============ ===== =
|
||
|
|
||
|
.. _getUsers:
|
||
|
|
||
|
``getUsers``
|
||
|
✔️ 1.9.0
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _createUser:
|
||
|
|
||
|
``createUser``
|
||
|
✔️
|
||
|
|
||
|
======================= ====== =
|
||
|
Parameter Vers.
|
||
|
======================= ====== =
|
||
|
``username`` ✔️
|
||
|
``password`` ✔️
|
||
|
``email`` ✔️
|
||
|
``ldapAuthenticated``
|
||
|
``adminRole`` ✔️
|
||
|
``settingsRole``
|
||
|
``streamRole``
|
||
|
``jukeboxRole`` ✔️
|
||
|
``downloadRole``
|
||
|
``uploadRole``
|
||
|
``playlistRole``
|
||
|
``coverArtRole``
|
||
|
``commentRole``
|
||
|
``podcastRole``
|
||
|
``shareRole``
|
||
|
``videoConversionRole`` 1.14.0
|
||
|
``musicFolderId`` 1.12.0 📅
|
||
|
======================= ====== =
|
||
|
|
||
|
.. _updateUser:
|
||
|
|
||
|
``updateUser``
|
||
|
✔️ 1.10.2
|
||
|
|
||
|
======================= ====== =
|
||
|
Parameter Vers.
|
||
|
======================= ====== =
|
||
|
``username`` 1.10.2 ✔️
|
||
|
``password`` 1.10.2 ✔️
|
||
|
``email`` 1.10.2 ✔️
|
||
|
``ldapAuthenticated`` 1.10.2
|
||
|
``adminRole`` 1.10.2 ✔️
|
||
|
``settingsRole`` 1.10.2
|
||
|
``streamRole`` 1.10.2
|
||
|
``jukeboxRole`` 1.10.2 ✔️
|
||
|
``downloadRole`` 1.10.2
|
||
|
``uploadRole`` 1.10.2
|
||
|
``coverArtRole`` 1.10.2
|
||
|
``commentRole`` 1.10.2
|
||
|
``podcastRole`` 1.10.2
|
||
|
``shareRole`` 1.10.2
|
||
|
``videoConversionRole`` 1.14.0
|
||
|
``musicFolderId`` 1.12.0 📅
|
||
|
``maxBitRate`` 1.13.0 📅
|
||
|
======================= ====== =
|
||
|
|
||
|
.. _deleteUser:
|
||
|
|
||
|
``deleteUser``
|
||
|
✔️
|
||
|
|
||
|
============ ===== =
|
||
|
Parameter Vers.
|
||
|
============ ===== =
|
||
|
``username`` ✔️
|
||
|
============ ===== =
|
||
|
|
||
|
.. _changePassword:
|
||
|
|
||
|
``changePassword``
|
||
|
✔️
|
||
|
|
||
|
============ ===== =
|
||
|
Parameter Vers.
|
||
|
============ ===== =
|
||
|
``username`` ✔️
|
||
|
``password`` ✔️
|
||
|
============ ===== =
|
||
|
|
||
|
Bookmarks
|
||
|
^^^^^^^^^
|
||
|
|
||
|
.. _getBookmarks:
|
||
|
|
||
|
``getBookmarks``
|
||
|
❔ 1.9.0
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _createBookmark:
|
||
|
|
||
|
``createBookmark``
|
||
|
❔ 1.9.0
|
||
|
|
||
|
============ ===== =
|
||
|
Parameter Vers.
|
||
|
============ ===== =
|
||
|
``id`` 1.9.0 ❔
|
||
|
``position`` 1.9.0 ❔
|
||
|
``comment`` 1.9.0 ❔
|
||
|
============ ===== =
|
||
|
|
||
|
.. _deleteBookmark:
|
||
|
|
||
|
``deleteBookmark``
|
||
|
❔ 1.9.0
|
||
|
|
||
|
=============== ===== =
|
||
|
Parameter Vers.
|
||
|
=============== ===== =
|
||
|
``id`` 1.9.0 ❔
|
||
|
=============== ===== =
|
||
|
|
||
|
.. _getPlayQueue:
|
||
|
|
||
|
``getPlayQueue``
|
||
|
❔ 1.12.0
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _savePlayQueue:
|
||
|
|
||
|
``savePlayQueue``
|
||
|
❔ 1.12.0
|
||
|
|
||
|
============ ====== =
|
||
|
Parameter Vers.
|
||
|
============ ====== =
|
||
|
``id`` 1.12.0 ❔
|
||
|
``current`` 1.12.0 ❔
|
||
|
``position`` 1.12.0 ❔
|
||
|
============ ====== =
|
||
|
|
||
|
Library scanning
|
||
|
^^^^^^^^^^^^^^^^
|
||
|
|
||
|
.. _getScanStatus:
|
||
|
|
||
|
``getScanStatus``
|
||
|
✔️ 1.15.0
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
.. _startScan:
|
||
|
|
||
|
``startScan``
|
||
|
✔️ 1.15.0
|
||
|
|
||
|
No parameter
|
||
|
|
||
|
Changes by version
|
||
|
------------------
|
||
|
|
||
|
Version 1.9.0
|
||
|
^^^^^^^^^^^^^
|
||
|
|
||
|
Added methods:
|
||
|
|
||
|
* :ref:`getGenres <getGenres>`
|
||
|
* :ref:`getSongsByGenre <getSongsByGenre>`
|
||
|
* :ref:`hls <hls>`
|
||
|
* :ref:`refreshPodcasts <refreshPodcasts>`
|
||
|
* :ref:`createPodcastChannel <createPodcastChannel>`
|
||
|
* :ref:`deletePodcastChannel <deletePodcastChannel>`
|
||
|
* :ref:`deletePodcastEpisode <deletePodcastEpisode>`
|
||
|
* :ref:`downloadPodcastEpisode <downloadPodcastEpisode>`
|
||
|
* :ref:`getInternetRadioStations <getInternetRadioStations>`
|
||
|
* :ref:`getUsers <getUsers>`
|
||
|
* :ref:`getBookmarks <getBookmarks>`
|
||
|
* :ref:`createBookmark <createBookmark>`
|
||
|
* :ref:`deleteBookmark <deleteBookmark>`
|
||
|
|
||
|
Added method parameters:
|
||
|
|
||
|
* :ref:`updatePlaylist <updatePlaylist>`
|
||
|
|
||
|
* ``public``
|
||
|
|
||
|
* :ref:`scrobble <scrobble>`
|
||
|
|
||
|
* ``time``
|
||
|
|
||
|
* :ref:`getPodcasts <getPodcasts>`
|
||
|
|
||
|
* ``includeEpisodes``
|
||
|
* ``id``
|
||
|
|
||
|
Version 1.10.1
|
||
|
^^^^^^^^^^^^^^
|
||
|
|
||
|
Added method parameters:
|
||
|
|
||
|
* :ref:`getAlbumList <getAlbumList>`
|
||
|
|
||
|
* ``fromYear``
|
||
|
* ``toYear``
|
||
|
* ``genre``
|
||
|
|
||
|
* :ref:`getAlbumList2 <getAlbumList2>`
|
||
|
|
||
|
* ``fromYear``
|
||
|
* ``toYear``
|
||
|
* ``genre``
|
||
|
|
||
|
Version 1.10.2
|
||
|
^^^^^^^^^^^^^^
|
||
|
|
||
|
Added methods:
|
||
|
|
||
|
* :ref:`updateUser <updateUser>`
|
||
|
|
||
|
Version 1.11.0
|
||
|
^^^^^^^^^^^^^^
|
||
|
|
||
|
Added methods:
|
||
|
|
||
|
* :ref:`getArtistInfo <getArtistInfo>`
|
||
|
* :ref:`getArtistInfo2 <getArtistInfo2>`
|
||
|
* :ref:`getSimilarSongs <getSimilarSongs>`
|
||
|
* :ref:`getSimilarSongs2 <getSimilarSongs2>`
|
||
|
|
||
|
Version 1.12.0
|
||
|
^^^^^^^^^^^^^^
|
||
|
|
||
|
Added methods:
|
||
|
|
||
|
* :ref:`getPlayQueue <getPlayQueue>`
|
||
|
* :ref:`savePlayQueue <savePlayQueue>`
|
||
|
|
||
|
Added method parameters:
|
||
|
|
||
|
* :ref:`getAlbumList <getAlbumList>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
* :ref:`getAlbumList2 <getAlbumList2>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
* :ref:`getSongsByGenre <getSongsByGenre>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
* :ref:`getStarred <getStarred>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
* :ref:`getStarred2 <getStarred2>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
* :ref:`search2 <search2>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
* :ref:`search3 <search3>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
* :ref:`createUser <createUser>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
* :ref:`updateUser <updateUser>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
Version 1.13.0
|
||
|
^^^^^^^^^^^^^^
|
||
|
|
||
|
Added global parameters:
|
||
|
|
||
|
* ``t``
|
||
|
* ``s``
|
||
|
|
||
|
Added methods:
|
||
|
|
||
|
* :ref:`getTopSongs <getTopSongs>`
|
||
|
|
||
|
Added method parameters:
|
||
|
|
||
|
* :ref:`updateUser <updateUser>`
|
||
|
|
||
|
* ``maxBitRate``
|
||
|
|
||
|
Version 1.14.0
|
||
|
^^^^^^^^^^^^^^
|
||
|
|
||
|
Added methods:
|
||
|
|
||
|
* :ref:`getAlbumInfo <getAlbumInfo>`
|
||
|
* :ref:`getAlbumInfo2 <getAlbumInfo2>`
|
||
|
* :ref:`getNewestPodcasts <getNewestPodcasts>`
|
||
|
|
||
|
Added method parameters:
|
||
|
|
||
|
* :ref:`getArtists <getArtists>`
|
||
|
|
||
|
* ``musicFolderId``
|
||
|
|
||
|
* :ref:`createUser <createUser>`
|
||
|
|
||
|
* ``videoConversionRole``
|
||
|
|
||
|
* :ref:`updateUser <updateUser>`
|
||
|
|
||
|
* ``videoConversionRole``
|
||
|
|
||
|
Version 1.15.0
|
||
|
^^^^^^^^^^^^^^
|
||
|
|
||
|
Added error code ``41``
|
||
|
|
||
|
Added methods:
|
||
|
|
||
|
* :ref:`getVideoInfo <getVideoInfo>`
|
||
|
* :ref:`getCaptions <getCaptions>`
|
||
|
* :ref:`getScanStatus <getScanStatus>`
|
||
|
* :ref:`startScan <startScan>`
|
||
|
|
||
|
Added method parameters:
|
||
|
|
||
|
* :ref:`stream <stream>`
|
||
|
|
||
|
* ``converted``
|
||
|
|
||
|
* :ref:`hls <hls>`
|
||
|
|
||
|
* ``audioTrack``
|
||
|
|
||
|
Version 1.16.0
|
||
|
^^^^^^^^^^^^^^
|
||
|
|
||
|
Added methods:
|
||
|
|
||
|
* :ref:`createInternetRadioStation <createInternetRadioStation>`
|
||
|
* :ref:`updateInternetRadioStation <updateInternetRadioStation>`
|
||
|
* :ref:`deleteInternetRadioStation <deleteInternetRadioStation>`
|