mirror of
https://github.com/spl0k/supysonic.git
synced 2024-11-14 14:12:17 +00:00
API doc: try to unify table, left align
This commit is contained in:
Alban Féron
parent
11887d07d2
commit
4735003bc4
4
docs/_static/custom.css
vendored
Normal file
4
docs/_static/custom.css
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
table.align-default {
|
||||||
|
margin-left: 0;
|
||||||
|
margin-right: 0;
|
||||||
|
}
|
||||||
403
docs/api.rst
403
docs/api.rst
@ -30,119 +30,128 @@ or with version 1.8.0.
|
|||||||
All methods / pseudo-TOC
|
All methods / pseudo-TOC
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
=========================== ====== =
|
.. table::
|
||||||
Method Vers.
|
:widths: 55 30 15
|
||||||
=========================== ====== =
|
|
||||||
ping_ ✔️
|
=========================== ====== =
|
||||||
getLicense_ ✔️
|
Method Vers.
|
||||||
getMusicFolders_ ✔️
|
=========================== ====== =
|
||||||
getIndexes_ ✔️
|
ping_ ✔️
|
||||||
getMusicDirectory_ ✔️
|
getLicense_ ✔️
|
||||||
getGenres_ 1.9.0 ✔️
|
getMusicFolders_ ✔️
|
||||||
getArtists_ ✔️
|
getIndexes_ ✔️
|
||||||
getArtist_ ✔️
|
getMusicDirectory_ ✔️
|
||||||
getAlbum_ ✔️
|
getGenres_ 1.9.0 ✔️
|
||||||
getSong_ ✔️
|
getArtists_ ✔️
|
||||||
getVideos_ ❌
|
getArtist_ ✔️
|
||||||
getVideoInfo_ 1.15.0 🔴
|
getAlbum_ ✔️
|
||||||
getArtistInfo_ 1.11.0 📅
|
getSong_ ✔️
|
||||||
getArtistInfo2_ 1.11.0 📅
|
getVideos_ ❌
|
||||||
getAlbumInfo_ 1.14.0 📅
|
getVideoInfo_ 1.15.0 🔴
|
||||||
getAlbumInfo2_ 1.14.0 📅
|
getArtistInfo_ 1.11.0 📅
|
||||||
getSimilarSongs_ 1.11.0 ❔
|
getArtistInfo2_ 1.11.0 📅
|
||||||
getSimilarSongs2_ 1.11.0 ❔
|
getAlbumInfo_ 1.14.0 📅
|
||||||
getTopSongs_ 1.13.0 ❔
|
getAlbumInfo2_ 1.14.0 📅
|
||||||
getAlbumList_ ✔️
|
getSimilarSongs_ 1.11.0 ❔
|
||||||
getAlbumList2_ ✔️
|
getSimilarSongs2_ 1.11.0 ❔
|
||||||
getRandomSongs_ ✔️
|
getTopSongs_ 1.13.0 ❔
|
||||||
getSongsByGenre_ 1.9.0 ✔️
|
getAlbumList_ ✔️
|
||||||
getNowPlaying_ ✔️
|
getAlbumList2_ ✔️
|
||||||
getStarred_ ✔️
|
getRandomSongs_ ✔️
|
||||||
getStarred2_ ✔️
|
getSongsByGenre_ 1.9.0 ✔️
|
||||||
:ref:`search <search->` ✔️
|
getNowPlaying_ ✔️
|
||||||
search2_ ✔️
|
getStarred_ ✔️
|
||||||
search3_ ✔️
|
getStarred2_ ✔️
|
||||||
getPlaylists_ ✔️
|
:ref:`search <search->` ✔️
|
||||||
getPlaylist_ ✔️
|
search2_ ✔️
|
||||||
createPlaylist_ ✔️
|
search3_ ✔️
|
||||||
updatePlaylist_ ✔️
|
getPlaylists_ ✔️
|
||||||
deletePlaylist_ ✔️
|
getPlaylist_ ✔️
|
||||||
stream_ ✔️
|
createPlaylist_ ✔️
|
||||||
download_ ✔️
|
updatePlaylist_ ✔️
|
||||||
hls_ 1.9.0 🔴
|
deletePlaylist_ ✔️
|
||||||
getCaptions_ 1.15.0 🔴
|
stream_ ✔️
|
||||||
getCoverArt_ ✔️
|
download_ ✔️
|
||||||
getLyrics_ ✔️
|
hls_ 1.9.0 🔴
|
||||||
getAvatar_ ❌
|
getCaptions_ 1.15.0 🔴
|
||||||
star_ ✔️
|
getCoverArt_ ✔️
|
||||||
unstar_ ✔️
|
getLyrics_ ✔️
|
||||||
setRating_ ✔️
|
getAvatar_ ❌
|
||||||
scrobble_ ✔️
|
star_ ✔️
|
||||||
getShares_ ❌
|
unstar_ ✔️
|
||||||
createShare_ ❌
|
setRating_ ✔️
|
||||||
updateShare_ ❌
|
scrobble_ ✔️
|
||||||
deleteShare_ ❌
|
getShares_ ❌
|
||||||
getPodcasts_ ❔
|
createShare_ ❌
|
||||||
getNewestPodcasts_ 1.14.0 ❔
|
updateShare_ ❌
|
||||||
refreshPodcasts_ 1.9.0 ❔
|
deleteShare_ ❌
|
||||||
createPodcastChannel_ 1.9.0 ❔
|
getPodcasts_ ❔
|
||||||
deletePodcastChannel_ 1.9.0 ❔
|
getNewestPodcasts_ 1.14.0 ❔
|
||||||
deletePodcastEpisode_ 1.9.0 ❔
|
refreshPodcasts_ 1.9.0 ❔
|
||||||
downloadPodcastEpisode_ 1.9.0 ❔
|
createPodcastChannel_ 1.9.0 ❔
|
||||||
jukeboxControl_ ✔️
|
deletePodcastChannel_ 1.9.0 ❔
|
||||||
getInternetRadioStations_ 1.9.0 ✔️
|
deletePodcastEpisode_ 1.9.0 ❔
|
||||||
createInternetRadioStation_ 1.16.0 ✔️
|
downloadPodcastEpisode_ 1.9.0 ❔
|
||||||
updateInternetRadioStation_ 1.16.0 ✔️
|
jukeboxControl_ ✔️
|
||||||
deleteInternetRadioStation_ 1.16.0 ✔️
|
getInternetRadioStations_ 1.9.0 ✔️
|
||||||
getChatMessages_ ✔️
|
createInternetRadioStation_ 1.16.0 ✔️
|
||||||
addChatMessage_ ✔️
|
updateInternetRadioStation_ 1.16.0 ✔️
|
||||||
getUser_ ✔️
|
deleteInternetRadioStation_ 1.16.0 ✔️
|
||||||
getUsers_ 1.9.0 ✔️
|
getChatMessages_ ✔️
|
||||||
createUser_ ✔️
|
addChatMessage_ ✔️
|
||||||
updateUser_ 1.10.2 ✔️
|
getUser_ ✔️
|
||||||
deleteUser_ ✔️
|
getUsers_ 1.9.0 ✔️
|
||||||
changePassword_ ✔️
|
createUser_ ✔️
|
||||||
getBookmarks_ 1.9.0 ❔
|
updateUser_ 1.10.2 ✔️
|
||||||
createBookmark_ 1.9.0 ❔
|
deleteUser_ ✔️
|
||||||
deleteBookmark_ 1.9.0 ❔
|
changePassword_ ✔️
|
||||||
getPlayQueue_ 1.12.0 ❔
|
getBookmarks_ 1.9.0 ❔
|
||||||
savePlayQueue_ 1.12.0 ❔
|
createBookmark_ 1.9.0 ❔
|
||||||
getScanStatus_ 1.15.0 ✔️
|
deleteBookmark_ 1.9.0 ❔
|
||||||
startScan_ 1.15.0 ✔️
|
getPlayQueue_ 1.12.0 ❔
|
||||||
=========================== ====== =
|
savePlayQueue_ 1.12.0 ❔
|
||||||
|
getScanStatus_ 1.15.0 ✔️
|
||||||
|
startScan_ 1.15.0 ✔️
|
||||||
|
=========================== ====== =
|
||||||
|
|
||||||
Global
|
Global
|
||||||
^^^^^^
|
^^^^^^
|
||||||
|
|
||||||
Parameters used for any request
|
Parameters used for any request
|
||||||
|
|
||||||
===== ====== =
|
.. table::
|
||||||
P. Vers.
|
:widths: 55 30 15
|
||||||
===== ====== =
|
|
||||||
``u`` ✔️
|
===== ====== =
|
||||||
``p`` ✔️
|
P. Vers.
|
||||||
``t`` 1.13.0 🔴
|
===== ====== =
|
||||||
``s`` 1.13.0 🔴
|
``u`` ✔️
|
||||||
``v`` ✔️
|
``p`` ✔️
|
||||||
``c`` ✔️
|
``t`` 1.13.0 🔴
|
||||||
``f`` ✔️
|
``s`` 1.13.0 🔴
|
||||||
===== ====== =
|
``v`` ✔️
|
||||||
|
``c`` ✔️
|
||||||
|
``f`` ✔️
|
||||||
|
===== ====== =
|
||||||
|
|
||||||
Error codes
|
Error codes
|
||||||
|
|
||||||
== ====== =
|
.. table::
|
||||||
# Vers.
|
:widths: 55 30 15
|
||||||
== ====== =
|
|
||||||
0 ✔️
|
== ====== =
|
||||||
10 ✔️
|
# Vers.
|
||||||
20 ✔️
|
== ====== =
|
||||||
30 ✔️
|
0 ✔️
|
||||||
40 ✔️
|
10 ✔️
|
||||||
41 1.15.0 📅
|
20 ✔️
|
||||||
50 ✔️
|
30 ✔️
|
||||||
60 ✔️
|
40 ✔️
|
||||||
70 ✔️
|
41 1.15.0 📅
|
||||||
== ====== =
|
50 ✔️
|
||||||
|
60 ✔️
|
||||||
|
70 ✔️
|
||||||
|
== ====== =
|
||||||
|
|
||||||
System
|
System
|
||||||
^^^^^^
|
^^^^^^
|
||||||
@ -176,6 +185,9 @@ Browsing
|
|||||||
``getIndexes``
|
``getIndexes``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
=================== ===== =
|
=================== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
=================== ===== =
|
=================== ===== =
|
||||||
@ -188,6 +200,9 @@ Browsing
|
|||||||
``getMusicDirectory``
|
``getMusicDirectory``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -206,6 +221,9 @@ Browsing
|
|||||||
``getArtists``
|
``getArtists``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
================= ====== =
|
================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
================= ====== =
|
================= ====== =
|
||||||
@ -217,6 +235,9 @@ Browsing
|
|||||||
``getArtist``
|
``getArtist``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -228,6 +249,9 @@ Browsing
|
|||||||
``getAlbum``
|
``getAlbum``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -239,6 +263,9 @@ Browsing
|
|||||||
``getSong``
|
``getSong``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -257,6 +284,9 @@ Browsing
|
|||||||
``getVideoInfo``
|
``getVideoInfo``
|
||||||
🔴 1.15.0
|
🔴 1.15.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ====== =
|
========= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ====== =
|
========= ====== =
|
||||||
@ -268,6 +298,9 @@ Browsing
|
|||||||
``getArtistInfo``
|
``getArtistInfo``
|
||||||
📅 1.11.0
|
📅 1.11.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
===================== ====== =
|
===================== ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
===================== ====== =
|
===================== ====== =
|
||||||
@ -281,6 +314,9 @@ Browsing
|
|||||||
``getArtistInfo2``
|
``getArtistInfo2``
|
||||||
📅 1.11.0
|
📅 1.11.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
===================== ====== =
|
===================== ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
===================== ====== =
|
===================== ====== =
|
||||||
@ -294,6 +330,9 @@ Browsing
|
|||||||
``getAlbumInfo``
|
``getAlbumInfo``
|
||||||
📅 1.14.0
|
📅 1.14.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ====== =
|
========= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ====== =
|
========= ====== =
|
||||||
@ -305,6 +344,9 @@ Browsing
|
|||||||
``getAlbumInfo2``
|
``getAlbumInfo2``
|
||||||
📅 1.14.0
|
📅 1.14.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ====== =
|
========= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ====== =
|
========= ====== =
|
||||||
@ -316,6 +358,9 @@ Browsing
|
|||||||
``getSimilarSongs``
|
``getSimilarSongs``
|
||||||
❔ 1.11.0
|
❔ 1.11.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ====== =
|
========= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ====== =
|
========= ====== =
|
||||||
@ -328,6 +373,9 @@ Browsing
|
|||||||
``getSimilarSongs2``
|
``getSimilarSongs2``
|
||||||
❔ 1.11.0
|
❔ 1.11.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ====== =
|
========= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ====== =
|
========= ====== =
|
||||||
@ -340,6 +388,9 @@ Browsing
|
|||||||
``getTopSongs``
|
``getTopSongs``
|
||||||
❔ 1.13.0
|
❔ 1.13.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========== ====== =
|
========== ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========== ====== =
|
========== ====== =
|
||||||
@ -355,6 +406,9 @@ Album/song lists
|
|||||||
``getAlbumList``
|
``getAlbumList``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
================= ====== =
|
================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
================= ====== =
|
================= ====== =
|
||||||
@ -375,6 +429,9 @@ Album/song lists
|
|||||||
``getAlbumList2``
|
``getAlbumList2``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
================= ====== =
|
================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
================= ====== =
|
================= ====== =
|
||||||
@ -395,6 +452,9 @@ Album/song lists
|
|||||||
``getRandomSongs``
|
``getRandomSongs``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
================= ===== =
|
================= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
================= ===== =
|
================= ===== =
|
||||||
@ -410,6 +470,9 @@ Album/song lists
|
|||||||
``getSongsByGenre``
|
``getSongsByGenre``
|
||||||
✔️ 1.9.0
|
✔️ 1.9.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
================= ====== =
|
================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
================= ====== =
|
================= ====== =
|
||||||
@ -431,6 +494,9 @@ Album/song lists
|
|||||||
``getStarred``
|
``getStarred``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
================= ====== =
|
================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
================= ====== =
|
================= ====== =
|
||||||
@ -442,6 +508,9 @@ Album/song lists
|
|||||||
``getStarred2``
|
``getStarred2``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
================= ====== =
|
================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
================= ====== =
|
================= ====== =
|
||||||
@ -456,6 +525,9 @@ Searching
|
|||||||
``search``
|
``search``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============= ===== =
|
============= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============= ===== =
|
============= ===== =
|
||||||
@ -473,6 +545,9 @@ Searching
|
|||||||
``search2``
|
``search2``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
================= ====== =
|
================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
================= ====== =
|
================= ====== =
|
||||||
@ -491,6 +566,9 @@ Searching
|
|||||||
``search3``
|
``search3``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
================= ====== =
|
================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
================= ====== =
|
================= ====== =
|
||||||
@ -512,6 +590,9 @@ Playlists
|
|||||||
``getPlaylists``
|
``getPlaylists``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============ ===== =
|
============ ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============ ===== =
|
============ ===== =
|
||||||
@ -523,6 +604,9 @@ Playlists
|
|||||||
``getPlaylist``
|
``getPlaylist``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -534,6 +618,9 @@ Playlists
|
|||||||
``createPlaylist``
|
``createPlaylist``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============== ===== =
|
============== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============== ===== =
|
============== ===== =
|
||||||
@ -547,6 +634,9 @@ Playlists
|
|||||||
``updatePlaylist``
|
``updatePlaylist``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
===================== ===== =
|
===================== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
===================== ===== =
|
===================== ===== =
|
||||||
@ -563,6 +653,9 @@ Playlists
|
|||||||
``deletePlaylist``
|
``deletePlaylist``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -577,6 +670,9 @@ Media retrieval
|
|||||||
``stream``
|
``stream``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========================= ====== =
|
========================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========================= ====== =
|
========================= ====== =
|
||||||
@ -594,6 +690,9 @@ Media retrieval
|
|||||||
``download``
|
``download``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -605,6 +704,9 @@ Media retrieval
|
|||||||
``hls``
|
``hls``
|
||||||
🔴 1.9.0
|
🔴 1.9.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============== ====== =
|
============== ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============== ====== =
|
============== ====== =
|
||||||
@ -618,6 +720,9 @@ Media retrieval
|
|||||||
``getCaptions``
|
``getCaptions``
|
||||||
🔴 1.15.0
|
🔴 1.15.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========== ====== =
|
========== ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========== ====== =
|
========== ====== =
|
||||||
@ -630,6 +735,9 @@ Media retrieval
|
|||||||
``getCoverArt``
|
``getCoverArt``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -642,6 +750,9 @@ Media retrieval
|
|||||||
``getLyrics``
|
``getLyrics``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========== ===== =
|
========== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========== ===== =
|
========== ===== =
|
||||||
@ -654,6 +765,9 @@ Media retrieval
|
|||||||
``getAvatar``
|
``getAvatar``
|
||||||
❌
|
❌
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============ ===== =
|
============ ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============ ===== =
|
============ ===== =
|
||||||
@ -668,6 +782,9 @@ Media annotation
|
|||||||
``star``
|
``star``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============ ===== =
|
============ ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============ ===== =
|
============ ===== =
|
||||||
@ -681,6 +798,9 @@ Media annotation
|
|||||||
``unstar``
|
``unstar``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============ ===== =
|
============ ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============ ===== =
|
============ ===== =
|
||||||
@ -694,6 +814,9 @@ Media annotation
|
|||||||
``setRating``
|
``setRating``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========== ===== =
|
========== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========== ===== =
|
========== ===== =
|
||||||
@ -706,6 +829,9 @@ Media annotation
|
|||||||
``scrobble``
|
``scrobble``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============== ===== =
|
============== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============== ===== =
|
============== ===== =
|
||||||
@ -729,6 +855,9 @@ Sharing
|
|||||||
``createShare``
|
``createShare``
|
||||||
❌
|
❌
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
=============== ===== =
|
=============== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
=============== ===== =
|
=============== ===== =
|
||||||
@ -742,6 +871,9 @@ Sharing
|
|||||||
``updateShare``
|
``updateShare``
|
||||||
❌
|
❌
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
=============== ===== =
|
=============== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
=============== ===== =
|
=============== ===== =
|
||||||
@ -755,6 +887,9 @@ Sharing
|
|||||||
``deleteShare``
|
``deleteShare``
|
||||||
❌
|
❌
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -769,6 +904,9 @@ Podcast
|
|||||||
``getPodcasts``
|
``getPodcasts``
|
||||||
❔
|
❔
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
=================== ===== =
|
=================== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
=================== ===== =
|
=================== ===== =
|
||||||
@ -781,6 +919,9 @@ Podcast
|
|||||||
``getNewestPodcasts``
|
``getNewestPodcasts``
|
||||||
❔ 1.14.0
|
❔ 1.14.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ====== =
|
========= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ====== =
|
========= ====== =
|
||||||
@ -799,6 +940,9 @@ Podcast
|
|||||||
``createPodcastChannel``
|
``createPodcastChannel``
|
||||||
❔ 1.9.0
|
❔ 1.9.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -810,6 +954,9 @@ Podcast
|
|||||||
``deletePodcastChannel``
|
``deletePodcastChannel``
|
||||||
❔ 1.9.0
|
❔ 1.9.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -821,6 +968,9 @@ Podcast
|
|||||||
``deletePodcastEpisode``
|
``deletePodcastEpisode``
|
||||||
❔ 1.9.0
|
❔ 1.9.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -832,6 +982,9 @@ Podcast
|
|||||||
``downloadPodcastEpisode``
|
``downloadPodcastEpisode``
|
||||||
❔ 1.9.0
|
❔ 1.9.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -846,6 +999,9 @@ Jukebox
|
|||||||
``jukeboxControl``
|
``jukeboxControl``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========== ===== =
|
========== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========== ===== =
|
========== ===== =
|
||||||
@ -871,6 +1027,9 @@ Internet radio
|
|||||||
``createInternetRadioStation``
|
``createInternetRadioStation``
|
||||||
❔ 1.16.0
|
❔ 1.16.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
=============== ====== =
|
=============== ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
=============== ====== =
|
=============== ====== =
|
||||||
@ -884,6 +1043,9 @@ Internet radio
|
|||||||
``updateInternetRadioStation``
|
``updateInternetRadioStation``
|
||||||
❔ 1.16.0
|
❔ 1.16.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
=============== ====== =
|
=============== ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
=============== ====== =
|
=============== ====== =
|
||||||
@ -898,6 +1060,9 @@ Internet radio
|
|||||||
``deleteInternetRadioStation``
|
``deleteInternetRadioStation``
|
||||||
❔ 1.16.0
|
❔ 1.16.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
=============== ====== =
|
=============== ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
=============== ====== =
|
=============== ====== =
|
||||||
@ -912,6 +1077,9 @@ Chat
|
|||||||
``getChatMessages``
|
``getChatMessages``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
========= ===== =
|
========= ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
========= ===== =
|
========= ===== =
|
||||||
@ -923,6 +1091,9 @@ Chat
|
|||||||
``addChatMessage``
|
``addChatMessage``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
=========== ===== =
|
=========== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
=========== ===== =
|
=========== ===== =
|
||||||
@ -937,6 +1108,9 @@ User management
|
|||||||
``getUser``
|
``getUser``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============ ===== =
|
============ ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============ ===== =
|
============ ===== =
|
||||||
@ -955,6 +1129,9 @@ User management
|
|||||||
``createUser``
|
``createUser``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
======================= ====== =
|
======================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
======================= ====== =
|
======================= ====== =
|
||||||
@ -982,6 +1159,9 @@ User management
|
|||||||
``updateUser``
|
``updateUser``
|
||||||
✔️ 1.10.2
|
✔️ 1.10.2
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
======================= ====== =
|
======================= ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
======================= ====== =
|
======================= ====== =
|
||||||
@ -1009,6 +1189,9 @@ User management
|
|||||||
``deleteUser``
|
``deleteUser``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============ ===== =
|
============ ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============ ===== =
|
============ ===== =
|
||||||
@ -1020,6 +1203,9 @@ User management
|
|||||||
``changePassword``
|
``changePassword``
|
||||||
✔️
|
✔️
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============ ===== =
|
============ ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============ ===== =
|
============ ===== =
|
||||||
@ -1042,6 +1228,9 @@ Bookmarks
|
|||||||
``createBookmark``
|
``createBookmark``
|
||||||
❔ 1.9.0
|
❔ 1.9.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============ ===== =
|
============ ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============ ===== =
|
============ ===== =
|
||||||
@ -1055,6 +1244,9 @@ Bookmarks
|
|||||||
``deleteBookmark``
|
``deleteBookmark``
|
||||||
❔ 1.9.0
|
❔ 1.9.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
=============== ===== =
|
=============== ===== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
=============== ===== =
|
=============== ===== =
|
||||||
@ -1073,6 +1265,9 @@ Bookmarks
|
|||||||
``savePlayQueue``
|
``savePlayQueue``
|
||||||
❔ 1.12.0
|
❔ 1.12.0
|
||||||
|
|
||||||
|
.. table::
|
||||||
|
:widths: 55 30 15
|
||||||
|
|
||||||
============ ====== =
|
============ ====== =
|
||||||
Parameter Vers.
|
Parameter Vers.
|
||||||
============ ====== =
|
============ ====== =
|
||||||
|
|||||||
@ -30,7 +30,7 @@ html_theme_options = {
|
|||||||
"github_user": "spl0k",
|
"github_user": "spl0k",
|
||||||
"github_repo": "supysonic",
|
"github_repo": "supysonic",
|
||||||
}
|
}
|
||||||
html_static_path = []
|
html_static_path = ["_static"]
|
||||||
|
|
||||||
# Default alabaseter sidebars + localtoc
|
# Default alabaseter sidebars + localtoc
|
||||||
html_sidebars = {
|
html_sidebars = {
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user