net.subclient.subsonic

Interface Connection

All Known Implementing Classes:

SubsonicConnection

public interface Connection

Connection interface defining all the methods needed in the Subsonic connection

Author:

Alejandro Celaya Alastrué

Method Summary

Methods

Modifier and Type	Method and Description
SubsonicResponse	createPlaylist(java.util.ArrayList<java.lang.String> songsList, java.lang.String name)
SubsonicResponse	deletePlaylist(java.lang.String playlistId)
java.io.InputStream	download(java.lang.String uniqueId)
GetAlbumsResponse	getAlbumsList(GetAlbumsType type)
GetAlbumsResponse	getAlbumsList(GetAlbumsType type, int size)
GetAlbumsResponse	getAlbumsList(GetAlbumsType type, int size, int offset)
java.awt.image.BufferedImage	getCoverArt(java.lang.String coverId)
java.awt.image.BufferedImage	getCoverArt(java.lang.String coverArt, int size)
GetIndexesResponse	getIndexes()
GetIndexesResponse	getIndexes(long modifiedSince)
GetIndexesResponse	getIndexes(java.lang.String musicFolderId)
GetLicenseResponse	getLicense()
GetMusicDirectoryResponse	getMusicDirectory(java.lang.String uniqueFolderId)
GetMusicFoldersResponse	getMusicFolders()
GetPlaylistResponse	getPlaylist(java.lang.String playlistId)
GetPlaylistsResponse	getPlaylists()
GetPodcastResponse	getPodcastEpisodes(java.lang.String podcastId)
GetPodcastsResponse	getPodcasts()
GetRandomSongsResponse	getRandomSongs()
GetRandomSongsResponse	getRandomSongs(java.lang.String folderId)
GetRandomSongsResponse	getRandomSongs(java.lang.String folderId, int size)
java.lang.String	getStreamURL(java.lang.String uniqueId)
java.lang.String	getStreamURL(java.lang.String uniqueId, int maxBitRate)
boolean	ping()
SearchResponse	search(java.lang.String query)
SearchResponse	search(java.lang.String query, int count)
SearchResponse	search(java.lang.String query, int count, int offset)
SubsonicResponse	setRating(AlbumRating rating)
java.io.InputStream	stream(java.lang.String uniqueId)
java.io.InputStream	stream(java.lang.String uniqueId, int maxBitRate)

Method Detail

ping

boolean ping()

Returns:

boolean

getLicense

GetLicenseResponse getLicense()
                              throws com.google.gson.JsonSyntaxException,
                                     java.io.IOException,
                                     SubsonicException,
                                     InvalidResponseException,
                                     javax.xml.ws.http.HTTPException

Returns:

GetLicenseResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

javax.xml.ws.http.HTTPException

getMusicFolders

GetMusicFoldersResponse getMusicFolders()
                                        throws com.google.gson.JsonSyntaxException,
                                               java.io.IOException,
                                               SubsonicException,
                                               InvalidResponseException,
                                               javax.xml.ws.http.HTTPException

Returns:

GetMusicFoldersResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

javax.xml.ws.http.HTTPException

getIndexes

GetIndexesResponse getIndexes()
                              throws com.google.gson.JsonSyntaxException,
                                     java.io.IOException,
                                     SubsonicException,
                                     InvalidResponseException,
                                     javax.xml.ws.http.HTTPException

Returns:

GetIndexesResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

javax.xml.ws.http.HTTPException

getIndexes

GetIndexesResponse getIndexes(java.lang.String musicFolderId)
                              throws com.google.gson.JsonSyntaxException,
                                     java.io.IOException,
                                     SubsonicException,
                                     InvalidResponseException,
                                     javax.xml.ws.http.HTTPException

Parameters:

musicFolderId -

Returns:

GetIndexesResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

javax.xml.ws.http.HTTPException

getIndexes

GetIndexesResponse getIndexes(long modifiedSince)
                              throws com.google.gson.JsonSyntaxException,
                                     java.io.IOException,
                                     SubsonicException,
                                     InvalidResponseException,
                                     javax.xml.ws.http.HTTPException

Parameters:

modifiedSince -

Returns:

GetIndexesResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

javax.xml.ws.http.HTTPException

getMusicDirectory

GetMusicDirectoryResponse getMusicDirectory(java.lang.String uniqueFolderId)
                                            throws com.google.gson.JsonSyntaxException,
                                                   java.io.IOException,
                                                   SubsonicException,
                                                   InvalidResponseException,
                                                   javax.xml.ws.http.HTTPException

Parameters:

uniqueFolderId -

Returns:

GetMusicDirectoryResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

javax.xml.ws.http.HTTPException

search

SearchResponse search(java.lang.String query)
                      throws com.google.gson.JsonSyntaxException,
                             java.io.IOException,
                             SubsonicException,
                             InvalidResponseException,
                             CompatibilityException,
                             javax.xml.ws.http.HTTPException

Parameters:

query -

Returns:

SearchResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

search

SearchResponse search(java.lang.String query,
                    int count)
                      throws com.google.gson.JsonSyntaxException,
                             java.io.IOException,
                             SubsonicException,
                             InvalidResponseException,
                             CompatibilityException,
                             javax.xml.ws.http.HTTPException

Parameters:

query -

count -

Returns:

SearchResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

search

SearchResponse search(java.lang.String query,
                    int count,
                    int offset)
                      throws com.google.gson.JsonSyntaxException,
                             java.io.IOException,
                             SubsonicException,
                             InvalidResponseException,
                             CompatibilityException,
                             javax.xml.ws.http.HTTPException

Parameters:

query -

count -

offset -

Returns:

SearchResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

getPlaylists

GetPlaylistsResponse getPlaylists()
                                  throws com.google.gson.JsonSyntaxException,
                                         java.io.IOException,
                                         SubsonicException,
                                         InvalidResponseException,
                                         javax.xml.ws.http.HTTPException

Returns:

GetPlaylistsResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

javax.xml.ws.http.HTTPException

getPlaylist

GetPlaylistResponse getPlaylist(java.lang.String playlistId)
                                throws com.google.gson.JsonSyntaxException,
                                       java.io.IOException,
                                       SubsonicException,
                                       InvalidResponseException,
                                       javax.xml.ws.http.HTTPException

Parameters:

playlistId -

Returns:

GetPlaylistResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

javax.xml.ws.http.HTTPException

createPlaylist

SubsonicResponse createPlaylist(java.util.ArrayList<java.lang.String> songsList,
                              java.lang.String name)
                                throws com.google.gson.JsonSyntaxException,
                                       java.io.IOException,
                                       SubsonicException,
                                       InvalidResponseException,
                                       CompatibilityException,
                                       javax.xml.ws.http.HTTPException

Parameters:

songsList -

name -

Returns:

SubsonicResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

deletePlaylist

SubsonicResponse deletePlaylist(java.lang.String playlistId)
                                throws com.google.gson.JsonSyntaxException,
                                       java.io.IOException,
                                       SubsonicException,
                                       InvalidResponseException,
                                       CompatibilityException,
                                       javax.xml.ws.http.HTTPException

Parameters:

playlistId -

Returns:

SubsonicResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

getAlbumsList

GetAlbumsResponse getAlbumsList(GetAlbumsType type)
                                throws com.google.gson.JsonSyntaxException,
                                       java.io.IOException,
                                       SubsonicException,
                                       InvalidResponseException,
                                       CompatibilityException,
                                       javax.xml.ws.http.HTTPException

Parameters:

type -

Returns:

GetAlbumsResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

java.lang.IllegalArgumentException

javax.xml.ws.http.HTTPException

getAlbumsList

GetAlbumsResponse getAlbumsList(GetAlbumsType type,
                              int size)
                                throws com.google.gson.JsonSyntaxException,
                                       java.io.IOException,
                                       SubsonicException,
                                       InvalidResponseException,
                                       CompatibilityException,
                                       javax.xml.ws.http.HTTPException

Parameters:

type -

size -

Returns:

GetAlbumsResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

java.lang.IllegalArgumentException

javax.xml.ws.http.HTTPException

getAlbumsList

GetAlbumsResponse getAlbumsList(GetAlbumsType type,
                              int size,
                              int offset)
                                throws com.google.gson.JsonSyntaxException,
                                       java.io.IOException,
                                       SubsonicException,
                                       InvalidResponseException,
                                       CompatibilityException,
                                       javax.xml.ws.http.HTTPException

Parameters:

type -

size -

offset -

Returns:

GetAlbumsResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

java.lang.IllegalArgumentException

javax.xml.ws.http.HTTPException

getRandomSongs

GetRandomSongsResponse getRandomSongs()
                                      throws com.google.gson.JsonSyntaxException,
                                             java.io.IOException,
                                             SubsonicException,
                                             InvalidResponseException,
                                             CompatibilityException,
                                             javax.xml.ws.http.HTTPException

Returns:

GetRandomSongsResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

getRandomSongs

GetRandomSongsResponse getRandomSongs(java.lang.String folderId)
                                      throws com.google.gson.JsonSyntaxException,
                                             java.io.IOException,
                                             SubsonicException,
                                             InvalidResponseException,
                                             CompatibilityException,
                                             javax.xml.ws.http.HTTPException

Parameters:

folderId -

Returns:

GetRandomSongsResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

getRandomSongs

GetRandomSongsResponse getRandomSongs(java.lang.String folderId,
                                    int size)
                                      throws com.google.gson.JsonSyntaxException,
                                             java.io.IOException,
                                             SubsonicException,
                                             InvalidResponseException,
                                             CompatibilityException,
                                             javax.xml.ws.http.HTTPException

Parameters:

folderId -

size -

Returns:

GetRandomSongsResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

getPodcasts

GetPodcastsResponse getPodcasts()
                                throws com.google.gson.JsonSyntaxException,
                                       java.io.IOException,
                                       SubsonicException,
                                       InvalidResponseException,
                                       CompatibilityException,
                                       javax.xml.ws.http.HTTPException

Returns:

GetPodcastsResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

getPodcastEpisodes

GetPodcastResponse getPodcastEpisodes(java.lang.String podcastId)
                                      throws com.google.gson.JsonSyntaxException,
                                             java.io.IOException,
                                             SubsonicException,
                                             InvalidResponseException,
                                             CompatibilityException,
                                             javax.xml.ws.http.HTTPException

Parameters:

podcastId -

Returns:

GetPodcastResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

setRating

SubsonicResponse setRating(AlbumRating rating)
                           throws com.google.gson.JsonSyntaxException,
                                  java.io.IOException,
                                  SubsonicException,
                                  InvalidResponseException,
                                  CompatibilityException,
                                  javax.xml.ws.http.HTTPException

Parameters:

rating -

Returns:

SubsonicResponse

Throws:

com.google.gson.JsonSyntaxException

java.io.IOException

SubsonicException

InvalidResponseException

CompatibilityException

javax.xml.ws.http.HTTPException

download

java.io.InputStream download(java.lang.String uniqueId)
                             throws javax.xml.ws.http.HTTPException,
                                    java.io.IOException,
                                    InvalidResponseException

Parameters:

uniqueId -

Returns:

InputStream

Throws:

javax.xml.ws.http.HTTPException

java.io.IOException

InvalidResponseException

stream

java.io.InputStream stream(java.lang.String uniqueId)
                           throws javax.xml.ws.http.HTTPException,
                                  java.io.IOException,
                                  InvalidResponseException

Parameters:

uniqueId -

Returns:

InputStream

Throws:

javax.xml.ws.http.HTTPException

java.io.IOException

InvalidResponseException

stream

java.io.InputStream stream(java.lang.String uniqueId,
                         int maxBitRate)
                           throws java.io.IOException,
                                  InvalidResponseException,
                                  javax.xml.ws.http.HTTPException

Parameters:

uniqueId -

maxBitRate -

Returns:

InputStream

Throws:

java.io.IOException

InvalidResponseException

javax.xml.ws.http.HTTPException

getStreamURL

java.lang.String getStreamURL(java.lang.String uniqueId)

Parameters:

uniqueId -

Returns:

String

getStreamURL

java.lang.String getStreamURL(java.lang.String uniqueId,
                            int maxBitRate)

Parameters:

uniqueId -

maxBitRate -

Returns:

String

getCoverArt

java.awt.image.BufferedImage getCoverArt(java.lang.String coverId)
                                         throws java.io.IOException,
                                                InvalidResponseException,
                                                javax.xml.ws.http.HTTPException

Parameters:

coverId -

Returns:

BufferedImage

Throws:

java.io.IOException

InvalidResponseException

javax.xml.ws.http.HTTPException

getCoverArt

java.awt.image.BufferedImage getCoverArt(java.lang.String coverArt,
                                       int size)
                                         throws java.io.IOException,
                                                InvalidResponseException,
                                                javax.xml.ws.http.HTTPException

Parameters:

coverArt -

size -

Returns:

BufferedImage

Throws:

java.io.IOException

InvalidResponseException

javax.xml.ws.http.HTTPException