/OpenSubsonicClient

Kotlin multiplatform client for the OpenSubsonic API

Primary LanguageKotlinApache License 2.0Apache-2.0

OpenSubsonic client

A client implementation for the OpenSubsonic API. Currently, there is no support for videos.

Implemented API endpoints

System

Endpoint Status
ping ✔️
getLicense ✔️
getOpenSubsonicExtensions TODO

Browsing

Endpoint Status Note
getIndexes Not Planned Maybe later
getMusicFolders Not Planned Maybe later
getMusicDirectory Not Planned Maybe later
getGenres ✔️
getArtists ✔️
getArtist ✔️
getAlbum ✔️
getSong ✔️
getVideos Not Planned Maybe later
getVideoInfo Not Planned Maybe later
getArtistInfo ✔️
getArtistInfo2 ✔️
getAlbumInfo ✔️
getAlbumInfo2 ✔️
getSimilarSongs ✔️
getSimilarSongs2 ✔️
getTopSongs ✔️

Album/song lists

Endpoint Status Note
getAlbumList ✔️ Use getAlbumList2
getAlbumList2 ✔️
getRandomSongs ✔️
getSongsByGenre ✔️
getNowPlaying ✔️
getStarred ✔️
getStarred2 ✔️

Searching

Endpoint Status Note
search Not Planned Use search3
search2 Not Planned Use search3
search3 ✔️

Playlists

Endpoint Status
getPlaylists ✔️
getPlaylist ✔️
createPlaylist ✔️
updatePlaylist ✔️
deletePlaylist ✔️

Media retrieval

Endpoint Status Note
stream ✔️
download ✔️
getCoverArt ✔️
hls Not Planned Maybe later
getCaptions Not Planned Maybe later
getLyrics ✔️
getAvatar ✔️

Media annotation

Endpoint Status
star ✔️
unstar ✔️
setRating ✔️
scrobble ✔️

Sharing

Endpoint Status
getShares ✔️
createShare ✔️
updateShare ✔️
deleteShare ✔️

Podcast

Endpoint Status
getPodcasts TODO
getNewestPodcasts TODO
refreshPodcasts TODO
createPodcastChannel TODO
deletePodcastChannel TODO
deletePodcastEpisode TODO
downloadPodcastEpisode TODO

Jukebox

Endpoint Status
jukeboxControl TODO

Internet radio

Endpoint Status
getInternetRadioStations ✔️
createInternetRadioStation ✔️
updateInternetRadioStation ✔️
deleteInternetRadioStation ✔️

Chat

Endpoint Status
getChatMessages ✔️
addChatMessage ✔️

User management

Endpoint Status
getUser TODO
getUsers TODO
createUser TODO
updateUser TODO
deleteUser TODO
changePassword TODO

Bookmarks

Endpoint Status
getBookmarks ✔️
createBookmark ✔️
deleteBookmark ✔️
getPlayQueue TODO
savePlayQueue ✔️

Media library scanning

Endpoint Status
getScanStatus ✔️
startScan ✔️