Package org.hihn.listenbrainz

Class LbMiscApi

java.lang.Object

org.hihn.listenbrainz.LbMiscApi

public class LbMiscApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LbMiscApi.APIcolorRequest
class	LbMiscApi.APIfreshReleasesRequest
class	LbMiscApi.APIgetDumpInfoRequest
class	LbMiscApi.APIlbRadioRequest

Constructor Summary

Constructors

Constructor	Description
LbMiscApi()
LbMiscApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
LbMiscApi.APIcolorRequest	color(String color)	Fetch a list of releases that have cover art that has a predominant color that is close to the given color.
LbMiscApi.APIfreshReleasesRequest	freshReleases()	This endpoint fetches upcoming and recently released (fresh) releases.
ApiClient	getApiClient()
String	getCustomBaseUrl()
LbMiscApi.APIgetDumpInfoRequest	getDumpInfo()	Get information about ListenBrainz data dumps.
int	getHostIndex()
LbMiscApi.APIlbRadioRequest	lbRadio(String prompt, Mode mode)	Generate a playlist with LB Radio.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LbMiscApi

public LbMiscApi()

LbMiscApi

public LbMiscApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

color

public LbMiscApi.APIcolorRequest color(String color)

Fetch a list of releases that have cover art that has a predominant color that is close to the given color.

Parameters:

color - Color must be a 6 digit hex color code. (required)

Returns:

APIcolorRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success.	-

freshReleases

public LbMiscApi.APIfreshReleasesRequest freshReleases()

This endpoint fetches upcoming and recently released (fresh) releases.

Returns:

APIfreshReleasesRequest

Http Response Details:

Status Code	Description	Response Headers
200	Yay, you have data!	-
400	Invalid date or number of days passed.	-

getDumpInfo

public LbMiscApi.APIgetDumpInfoRequest getDumpInfo()

Get information about ListenBrainz data dumps. You need to pass the id parameter in a GET request to get data about that particular dump.

Returns:

APIgetDumpInfoRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success.	-
400	You did not provide a valid dump ID. See error message for details.	-
404	Dump with given ID does not exist.	-

lbRadio

public LbMiscApi.APIlbRadioRequest lbRadio(String prompt,
 Mode mode)

Generate a playlist with LB Radio.

Parameters:

prompt - The LB Radio prompt from which to generate playlists. (required)

mode - The mode that LB radio should use. Must be easy, medium or hard. (required)

Returns:

APIlbRadioRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success.	-