github/supysonic
1
0
Fork 0
mirror of https://github.com/spl0k/supysonic.git synced 2024-09-19 19:01:03 +00:00
Code Issues Releases Wiki Activity

Simplify API cross references

Browse Source
This commit is contained in:
Alban Féron 2021-01-02 17:24:30 +01:00
parent 1c65fdede6
commit c8db5b81ab
No known key found for this signature in database
GPG Key ID: 8CE0313646D16165
1 changed files with 132 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

264
docs/api.rst
View File

@ -28,86 +28,86 @@ or with version 1.8.0.
All methods / pseudo-TOC All methods / pseudo-TOC
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
============================================================== ====== = =========================== ====== =
Method Vers. Method Vers.
============================================================== ====== = =========================== ====== =
:ref:`ping <ping>` ✔️ ping_ ✔️
:ref:`getLicense <getLicense>` ✔️ getLicense_ ✔️
:ref:`getMusicFolders <getMusicFolders>` ✔️ getMusicFolders_ ✔️
:ref:`getIndexes <getIndexes>` ✔️ getIndexes_ ✔️
:ref:`getMusicDirectory <getMusicDirectory>` ✔️ getMusicDirectory_ ✔️
:ref:`getGenres <getGenres>` 1.9.0 ✔️ getGenres_ 1.9.0 ✔️
:ref:`getArtists <getArtists>` ✔️ getArtists_ ✔️
:ref:`getArtist <getArtist>` ✔️ getArtist_ ✔️
:ref:`getAlbum <getAlbum>` ✔️ getAlbum_ ✔️
:ref:`getSong <getSong>` ✔️ getSong_ ✔️
:ref:`getVideos <getVideos>` ❌ getVideos_ ❌
:ref:`getVideoInfo <getVideoInfo>` 1.15.0 🔴 getVideoInfo_ 1.15.0 🔴
:ref:`getArtistInfo <getArtistInfo>` 1.11.0 📅 getArtistInfo_ 1.11.0 📅
:ref:`getArtistInfo2 <getArtistInfo2>` 1.11.0 📅 getArtistInfo2_ 1.11.0 📅
:ref:`getAlbumInfo <getAlbumInfo>` 1.14.0 📅 getAlbumInfo_ 1.14.0 📅
:ref:`getAlbumInfo2 <getAlbumInfo2>` 1.14.0 📅 getAlbumInfo2_ 1.14.0 📅
:ref:`getSimilarSongs <getSimilarSongs>` 1.11.0 ❔ getSimilarSongs_ 1.11.0 ❔
:ref:`getSimilarSongs2 <getSimilarSongs2>` 1.11.0 ❔ getSimilarSongs2_ 1.11.0 ❔
:ref:`getTopSongs <getTopSongs>` 1.13.0 ❔ getTopSongs_ 1.13.0 ❔
:ref:`getAlbumList <getAlbumList>` ✔️ getAlbumList_ ✔️
:ref:`getAlbumList2 <getAlbumList2>` ✔️ getAlbumList2_ ✔️
:ref:`getRandomSongs <getRandomSongs>` ✔️ getRandomSongs_ ✔️
:ref:`getSongsByGenre <getSongsByGenre>` 1.9.0 ✔️ getSongsByGenre_ 1.9.0 ✔️
:ref:`getNowPlaying <getNowPlaying>` ✔️ getNowPlaying_ ✔️
:ref:`getStarred <getStarred>` ✔️ getStarred_ ✔️
:ref:`getStarred2 <getStarred2>` ✔️ getStarred2_ ✔️
:ref:`search <search->` ✔️ search_ ✔️
:ref:`search2 <search2>` ✔️ search2_ ✔️
:ref:`search3 <search3>` ✔️ search3_ ✔️
:ref:`getPlaylists <getPlaylists>` ✔️ getPlaylists_ ✔️
:ref:`getPlaylist <getPlaylist>` ✔️ getPlaylist_ ✔️
:ref:`createPlaylist <createPlaylist>` ✔️ createPlaylist_ ✔️
:ref:`updatePlaylist <updatePlaylist>` ✔️ updatePlaylist_ ✔️
:ref:`deletePlaylist <deletePlaylist>` ✔️ deletePlaylist_ ✔️
:ref:`stream <stream>` ✔️ stream_ ✔️
:ref:`download <download>` ✔️ download_ ✔️
:ref:`hls <hls>` 1.9.0 🔴 hls_ 1.9.0 🔴
:ref:`getCaptions <getCaptions>` 1.15.0 🔴 getCaptions_ 1.15.0 🔴
:ref:`getCoverArt <getCoverArt>` ✔️ getCoverArt_ ✔️
:ref:`getLyrics <getLyrics>` ✔️ getLyrics_ ✔️
:ref:`getAvatar <getAvatar>` ❌ getAvatar_ ❌
:ref:`star <star>` ✔️ star_ ✔️
:ref:`unstar <unstar>` ✔️ unstar_ ✔️
:ref:`setRating <setRating>` ✔️ setRating_ ✔️
:ref:`scrobble <scrobble>` ✔️ scrobble_ ✔️
:ref:`getShares <getShares>` ❌ getShares_ ❌
:ref:`createShare <createShare>` ❌ createShare_ ❌
:ref:`updateShare <updateShare>` ❌ updateShare_ ❌
:ref:`deleteShare <deleteShare>` ❌ deleteShare_ ❌
:ref:`getPodcasts <getPodcasts>` ❔ getPodcasts_ ❔
:ref:`getNewestPodcasts <getNewestPodcasts>` 1.14.0 ❔ getNewestPodcasts_ 1.14.0 ❔
:ref:`refreshPodcasts <refreshPodcasts>` 1.9.0 ❔ refreshPodcasts_ 1.9.0 ❔
:ref:`createPodcastChannel <createPodcastChannel>` 1.9.0 ❔ createPodcastChannel_ 1.9.0 ❔
:ref:`deletePodcastChannel <deletePodcastChannel>` 1.9.0 ❔ deletePodcastChannel_ 1.9.0 ❔
:ref:`deletePodcastEpisode <deletePodcastEpisode>` 1.9.0 ❔ deletePodcastEpisode_ 1.9.0 ❔
:ref:`downloadPodcastEpisode <downloadPodcastEpisode>` 1.9.0 ❔ downloadPodcastEpisode_ 1.9.0 ❔
:ref:`jukeboxControl <jukeboxControl>` ✔️ jukeboxControl_ ✔️
:ref:`getInternetRadioStations <getInternetRadioStations>` 1.9.0 ✔️ getInternetRadioStations_ 1.9.0 ✔️
:ref:`createInternetRadioStation <createInternetRadioStation>` 1.16.0 ✔️ createInternetRadioStation_ 1.16.0 ✔️
:ref:`updateInternetRadioStation <updateInternetRadioStation>` 1.16.0 ✔️ updateInternetRadioStation_ 1.16.0 ✔️
:ref:`deleteInternetRadioStation <deleteInternetRadioStation>` 1.16.0 ✔️ deleteInternetRadioStation_ 1.16.0 ✔️
:ref:`getChatMessages <getChatMessages>` ✔️ getChatMessages_ ✔️
:ref:`addChatMessage <addChatMessage>` ✔️ addChatMessage_ ✔️
:ref:`getUser <getUser>` ✔️ getUser_ ✔️
:ref:`getUsers <getUsers>` 1.9.0 ✔️ getUsers_ 1.9.0 ✔️
:ref:`createUser <createUser>` ✔️ createUser_ ✔️
:ref:`updateUser <updateUser>` 1.10.2 ✔️ updateUser_ 1.10.2 ✔️
:ref:`deleteUser <deleteUser>` ✔️ deleteUser_ ✔️
:ref:`changePassword <changePassword>` ✔️ changePassword_ ✔️
:ref:`getBookmarks <getBookmarks>` 1.9.0 ❔ getBookmarks_ 1.9.0 ❔
:ref:`createBookmark <createBookmark>` 1.9.0 ❔ createBookmark_ 1.9.0 ❔
:ref:`deleteBookmark <deleteBookmark>` 1.9.0 ❔ deleteBookmark_ 1.9.0 ❔
:ref:`getPlayQueue <getPlayQueue>` 1.12.0 ❔ getPlayQueue_ 1.12.0 ❔
:ref:`savePlayQueue <savePlayQueue>` 1.12.0 ❔ savePlayQueue_ 1.12.0 ❔
:ref:`getScanStatus <getScanStatus>` 1.15.0 ✔️ getScanStatus_ 1.15.0 ✔️
:ref:`startScan <startScan>` 1.15.0 ✔️ startScan_ 1.15.0 ✔️
============================================================== ====== = =========================== ====== =
Global Global
^^^^^^ ^^^^^^
@ -449,7 +449,7 @@ Album/song lists
Searching Searching
^^^^^^^^^ ^^^^^^^^^
.. _search-: .. _search:
``search`` ``search``
✔️ ✔️
@ -1104,31 +1104,31 @@ Version 1.9.0
Added methods: Added methods:
* :ref:`getGenres <getGenres>` * getGenres_
* :ref:`getSongsByGenre <getSongsByGenre>` * getSongsByGenre_
* :ref:`hls <hls>` * hls_
* :ref:`refreshPodcasts <refreshPodcasts>` * refreshPodcasts_
* :ref:`createPodcastChannel <createPodcastChannel>` * createPodcastChannel_
* :ref:`deletePodcastChannel <deletePodcastChannel>` * deletePodcastChannel_
* :ref:`deletePodcastEpisode <deletePodcastEpisode>` * deletePodcastEpisode_
* :ref:`downloadPodcastEpisode <downloadPodcastEpisode>` * downloadPodcastEpisode_
* :ref:`getInternetRadioStations <getInternetRadioStations>` * getInternetRadioStations_
* :ref:`getUsers <getUsers>` * getUsers_
* :ref:`getBookmarks <getBookmarks>` * getBookmarks_
* :ref:`createBookmark <createBookmark>` * createBookmark_
* :ref:`deleteBookmark <deleteBookmark>` * deleteBookmark_
Added method parameters: Added method parameters:
* :ref:`updatePlaylist <updatePlaylist>` * updatePlaylist_
* ``public`` * ``public``
* :ref:`scrobble <scrobble>` * scrobble_
* ``time`` * ``time``
* :ref:`getPodcasts <getPodcasts>` * getPodcasts_
* ``includeEpisodes`` * ``includeEpisodes``
* ``id`` * ``id``
@ -1138,13 +1138,13 @@ Version 1.10.1
Added method parameters: Added method parameters:
* :ref:`getAlbumList <getAlbumList>` * getAlbumList_
* ``fromYear`` * ``fromYear``
* ``toYear`` * ``toYear``
* ``genre`` * ``genre``
* :ref:`getAlbumList2 <getAlbumList2>` * getAlbumList2_
* ``fromYear`` * ``fromYear``
* ``toYear`` * ``toYear``
@ -1155,61 +1155,61 @@ Version 1.10.2
Added methods: Added methods:
* :ref:`updateUser <updateUser>` * updateUser_
Version 1.11.0 Version 1.11.0
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
Added methods: Added methods:
* :ref:`getArtistInfo <getArtistInfo>` * getArtistInfo_
* :ref:`getArtistInfo2 <getArtistInfo2>` * getArtistInfo2_
* :ref:`getSimilarSongs <getSimilarSongs>` * getSimilarSongs_
* :ref:`getSimilarSongs2 <getSimilarSongs2>` * getSimilarSongs2_
Version 1.12.0 Version 1.12.0
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
Added methods: Added methods:
* :ref:`getPlayQueue <getPlayQueue>` * getPlayQueue_
* :ref:`savePlayQueue <savePlayQueue>` * savePlayQueue_
Added method parameters: Added method parameters:
* :ref:`getAlbumList <getAlbumList>` * getAlbumList_
* ``musicFolderId`` * ``musicFolderId``
* :ref:`getAlbumList2 <getAlbumList2>` * getAlbumList2_
* ``musicFolderId`` * ``musicFolderId``
* :ref:`getSongsByGenre <getSongsByGenre>` * getSongsByGenre_
* ``musicFolderId`` * ``musicFolderId``
* :ref:`getStarred <getStarred>` * getStarred_
* ``musicFolderId`` * ``musicFolderId``
* :ref:`getStarred2 <getStarred2>` * getStarred2_
* ``musicFolderId`` * ``musicFolderId``
* :ref:`search2 <search2>` * search2_
* ``musicFolderId`` * ``musicFolderId``
* :ref:`search3 <search3>` * search3_
* ``musicFolderId`` * ``musicFolderId``
* :ref:`createUser <createUser>` * createUser_
* ``musicFolderId`` * ``musicFolderId``
* :ref:`updateUser <updateUser>` * updateUser_
* ``musicFolderId`` * ``musicFolderId``
@ -1223,11 +1223,11 @@ Added global parameters:
Added methods: Added methods:
* :ref:`getTopSongs <getTopSongs>` * getTopSongs_
Added method parameters: Added method parameters:
* :ref:`updateUser <updateUser>` * updateUser_
* ``maxBitRate`` * ``maxBitRate``
@ -1236,21 +1236,21 @@ Version 1.14.0
Added methods: Added methods:
* :ref:`getAlbumInfo <getAlbumInfo>` * getAlbumInfo_
* :ref:`getAlbumInfo2 <getAlbumInfo2>` * getAlbumInfo2_
* :ref:`getNewestPodcasts <getNewestPodcasts>` * getNewestPodcasts_
Added method parameters: Added method parameters:
* :ref:`getArtists <getArtists>` * getArtists_
* ``musicFolderId`` * ``musicFolderId``
* :ref:`createUser <createUser>` * createUser_
* ``videoConversionRole`` * ``videoConversionRole``
* :ref:`updateUser <updateUser>` * updateUser_
* ``videoConversionRole`` * ``videoConversionRole``
@ -1261,18 +1261,18 @@ Added error code ``41``
Added methods: Added methods:
* :ref:`getVideoInfo <getVideoInfo>` * getVideoInfo_
* :ref:`getCaptions <getCaptions>` * getCaptions_
* :ref:`getScanStatus <getScanStatus>` * getScanStatus_
* :ref:`startScan <startScan>` * startScan_
Added method parameters: Added method parameters:
* :ref:`stream <stream>` * stream_
* ``converted`` * ``converted``
* :ref:`hls <hls>` * hls_
* ``audioTrack`` * ``audioTrack``
@ -1281,6 +1281,6 @@ Version 1.16.0
Added methods: Added methods:
* :ref:`createInternetRadioStation <createInternetRadioStation>` * createInternetRadioStation_
* :ref:`updateInternetRadioStation <updateInternetRadioStation>` * updateInternetRadioStation_
* :ref:`deleteInternetRadioStation <deleteInternetRadioStation>` * deleteInternetRadioStation_