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