-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit da3d1e4
Showing
156 changed files
with
8,876 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: Airsonic Integration | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ master ] | ||
| pull_request: | ||
| branches: [ master ] | ||
|
|
||
| jobs: | ||
| build: | ||
|
|
||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Set up JDK 11 | ||
| uses: actions/setup-java@v1 | ||
| with: | ||
| java-version: 11 | ||
| - name: Build with Maven | ||
| run: mvn -B package --file pom.xml -Dgroups=airsonic -DskipCodeCoverageCheck=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| name: Build | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ master ] | ||
| pull_request: | ||
| branches: [ master ] | ||
|
|
||
| jobs: | ||
| build: | ||
|
|
||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Set up JDK 11 | ||
| uses: actions/setup-java@v1 | ||
| with: | ||
| java-version: 11 | ||
| - name: Build with Maven | ||
| run: mvn -B package --file pom.xml -DexcludedGroups=airsonic,subsonic,fails-on-github | ||
| - name: Upload coverage to Codecov | ||
| uses: codecov/codecov-action@v1 | ||
| with: | ||
| token: ${{ secrets.CODECOV_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: Subsonic Integration | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ master ] | ||
| pull_request: | ||
| branches: [ master ] | ||
|
|
||
| jobs: | ||
| build: | ||
|
|
||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Set up JDK 11 | ||
| uses: actions/setup-java@v1 | ||
| with: | ||
| java-version: 11 | ||
| - name: Build with Maven | ||
| run: mvn -B package --file pom.xml -Dgroups=subsonic -DskipCodeCoverageCheck=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| .idea/ | ||
| target/ | ||
| **/*.iml | ||
| **/Main.java |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| # Subsonic Java Client | ||
| [](https://search.maven.org/artifact/net.beardbot/subsonic-client) [](https://github.com/calne-ca/subsonic-java-client/actions?query=workflow%3ABuild) [](https://github.com/calne-ca/subsonic-java-client/actions?query=workflow%3A%22Airsonic+Integration%22) [](https://github.com/calne-ca/subsonic-java-client/actions?query=workflow%3A%22Subsonic+Integration%22) [](https://codecov.io/gh/calne-ca/subsonic-java-client) | ||
|
|
||
| A Java Client for the [Subsonic API](http://www.subsonic.org/pages/api.jsp). | ||
|
|
||
| ## Compatibility | ||
| The client is based on the Subsonic API version 1.15.0. | ||
| The used API version will automatically be adapted to match the server's API version if the server uses an older API version than 1.15.0. | ||
| In this case only operations supported by the server's API version will work. | ||
| A minimum server API version of 1.13.0 is still required. | ||
|
|
||
| The client is automatically being tested against the latest [airsonic](https://airsonic.github.io/) and [subsonic](http://www.subsonic.org/) servers during its build process. | ||
| It should work with all servers that implement the Subsonic API. | ||
|
|
||
| ## Currently Supported Operations | ||
| Here's an overview of which operations this client currently supports. | ||
| Note that depending on the implementation some servers may not support specific operations even it should be supported by the API version of the server. | ||
| For example airsonic does not support any chat operations while subsonic does. | ||
|
|
||
| |API |Operation |Supported| | ||
| |-----------------------|---------------------------|---------| | ||
| |System |**ping** |**yes** | | ||
| | |**getLicense** |**yes** | | ||
| |Browsing |**getMusicFolders** |**yes** | | ||
| | |**getIndexes** |**yes** | | ||
| | |**getMusicDirectory** |**yes** | | ||
| | |**getGenres** |**yes** | | ||
| | |**getArtists** |**yes** | | ||
| | |**getArtist** |**yes** | | ||
| | |**getAlbum** |**yes** | | ||
| | |**getSong** |**yes** | | ||
| | |getVideos |no | | ||
| | |getVideoInfo |no | | ||
| | |getArtistInfo |no | | ||
| | |getArtistInfo2 |no | | ||
| | |getAlbumInfo |no | | ||
| | |getAlbumInfo2 |no | | ||
| | |getSimilarSongs |no | | ||
| | |getSimilarSongs2 |no | | ||
| | |getTopSongs |no | | ||
| |Album/song lists |getAlbumList |no | | ||
| | |getAlbumList2 |no | | ||
| | |getRandomSongs |no | | ||
| | |getSongsByGenre |no | | ||
| | |**getNowPlaying** |**yes** | | ||
| | |getStarred |no | | ||
| | |getStarred2 |no | | ||
| |Searching |search |no | | ||
| | |**search2** |**yes** | | ||
| | |**search3** |**yes** | | ||
| |Playlists |**getPlaylists** |**yes** | | ||
| | |**getPlaylist** |**yes** | | ||
| | |**createPlaylist** |**yes** | | ||
| | |**updatePlaylist** |**yes** | | ||
| | |**deletePlaylist** |**yes** | | ||
| |Media retrieval |**stream** |**yes** | | ||
| | |**download** |**yes** | | ||
| | |hls |no | | ||
| | |getCaptions |no | | ||
| | |**getCoverArt** |**yes** | | ||
| | |getLyrics |no | | ||
| | |**getAvatar** |**yes** | | ||
| |Media annotation |star |no | | ||
| | |unstar |no | | ||
| | |setRating |no | | ||
| | |**scrobble** |**yes** | | ||
| |Sharing |getShares |no | | ||
| | |createShare |no | | ||
| | |updateShare |no | | ||
| | |deleteShare |no | | ||
| |Podcasts |getPodcasts |no | | ||
| | |getNewestPodcasts |no | | ||
| | |refreshPodcasts |no | | ||
| | |createPodcastChannel |no | | ||
| | |deletePodcastChannel |no | | ||
| | |deletePodcastEpisode |no | | ||
| | |downloadPodcastEpisode |no | | ||
| |Jukebox |jukeboxControl |no | | ||
| |Internet radio |getInternetRadioStations |no | | ||
| | |createInternetRadioStation |no | | ||
| | |createInternetRadioStation |no | | ||
| | |updateInternetRadioStation |no | | ||
| | |deleteInternetRadioStation |no | | ||
| |Chat |getChatMessages |no | | ||
| | |addChatMessage |no | | ||
| |User management |**getUser** |**yes** | | ||
| | |**getUsers** |**yes** | | ||
| | |**createUser** |**yes** | | ||
| | |**updateUser** |**yes** | | ||
| | |**deleteUser** |**yes** | | ||
| | |**changePassword** |**yes** | | ||
| |Bookmarks |getBookmarks |no | | ||
| | |createBookmark |no | | ||
| | |deleteBookmark |no | | ||
| | |getPlayQueue |no | | ||
| | |savePlayQueue |no | | ||
| |Media library scanning |**getScanStatus** |**yes** | | ||
| | |**startScan** |**yes** | | ||
|
|
||
| ## Usage | ||
| ### Initialization | ||
| ```java | ||
| SubsonicPreferences preferences = new SubsonicPreferences("http://localhost:13013/airsonic", "username", "password"); | ||
| preferences.setStreamBitRate(192); | ||
| preferences.setClientName("MySubsonicClient"); | ||
|
|
||
| Subsonic subsonic = new Subsonic(preferences); | ||
| ``` | ||
|
|
||
| ### Test connection | ||
| ```java | ||
| try { | ||
| if(subsonic.testConnection()){ | ||
| log.info("Succesfully connected to server!") | ||
| } else { | ||
| log.error("Failed to connect to server!") | ||
| } | ||
| } catch(SubsonicIncompatibilityException e) { | ||
| log.error("The server is not compatible with the client! Please upgrade you server!") | ||
| } | ||
| ``` | ||
|
|
||
| ### Using the API | ||
| Every Subsonic API group has a corresponding method in the Subsonic class. | ||
| For example to use the search3 operation from the *Searching* API group you do the following: | ||
|
|
||
| ```java | ||
| SearchResult3 searchResult = subsonic.searching().search3("Caravan Palace", | ||
| SearchParams.create().artistCount(0).albumCount(0).songCount(3)); | ||
| ``` | ||
|
|
||
| Some API operations have optional parameters. | ||
| Their values will, in some cases, be directly passed as arguments but usually the method expects a param class. | ||
| These param classes always have a static *create* method and multiple additional methods representing the parameters. | ||
|
|
||
| #### More examples | ||
| ```java | ||
| // Scan library and wait until finished | ||
| subsonic.libraryScan().startScan(); | ||
|
|
||
| while (subsonic.libraryScan().getScanStatus().isScanning()){ | ||
| Thread.sleep(1000); | ||
| } | ||
| ``` | ||
|
|
||
| ```java | ||
| // Fetch index and print it | ||
| List<Index> indexes = subsonic.browsing().getIndexes(); | ||
|
|
||
| for (Index index : indexes) { | ||
| System.out.println(index.getName()); | ||
| for (Artist artist : index.getArtists()) { | ||
| System.out.println("-- " + artist.getName()); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ```java | ||
| // Stream first song from index | ||
| String firstArtistDirectoryId = indexes.get(0).getArtists().get(0).getId(); | ||
|
|
||
| Directory directory = subsonic.browsing().getMusicDirectory(firstArtistDirectoryId); | ||
| Child child = directory.getchildren().get(0); | ||
|
|
||
| while (child.isDir()){ | ||
| directory = subsonic.browsing().getMusicDirectory(child.getId()); | ||
| child = directory.getchildren().get(0); | ||
| } | ||
|
|
||
| InputStream stream = subsonic.media().stream(child.getId()); | ||
| someAudioPlayer.play(stream); | ||
| ``` | ||
|
|
||
| ```java | ||
| // Create a new user with stream and download roles | ||
| subsonic.users().createUser("testUser", "password", "test@example.com", | ||
| CreateUserParams.create().roles(UserRole.STREAM,UserRole.DOWNLOAD)); | ||
| ``` | ||
| Every other operation supported by this client can be used in a similar way. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| lombok.addLombokGeneratedAnnotation = true |
Oops, something went wrong.