Package org.hihn.listenbrainz

Class LbArtApi

java.lang.Object

org.hihn.listenbrainz.LbArtApi

public class LbArtApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LbArtApi.APIcreateCoverArtGridForUserRequest
class	LbArtApi.APIcreateCoverArtGridRequest
class	LbArtApi.APIcreateCustomCoverArtRequest
class	LbArtApi.APIyearInMusicRequest

Constructor Summary

Constructors

Constructor	Description
LbArtApi()
LbArtApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
LbArtApi.APIcreateCoverArtGridRequest	createCoverArtGrid(CreateCoverArtGrid createCoverArtGrid)	Create a cover art grid SVG file from the POSTed JSON data to this endpoint.
LbArtApi.APIcreateCoverArtGridForUserRequest	createCoverArtGridForUser(String userName, AllowedStatisticsRange timeRange, Integer dimension, Integer layout, Integer imageSize)	Create a cover art grid SVG file from the stats of a given user.
LbArtApi.APIcreateCustomCoverArtRequest	createCustomCoverArt(CoverTypes customName, String userName, AllowedStatisticsRange timeRange, Integer imageSize)	Create a custom cover art SVG file from the stats of a given user.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
LbArtApi.APIyearInMusicRequest	yearInMusic(Integer year, String userName, YearInMusicImage image)	Create the shareable svg image using YIM stats.

Methods inherited from class java.lang.Object

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

Constructor Details

LbArtApi

public LbArtApi()

LbArtApi

public LbArtApi(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)

createCoverArtGrid

public LbArtApi.APIcreateCoverArtGridRequest createCoverArtGrid(CreateCoverArtGrid createCoverArtGrid)

Create a cover art grid SVG file from the POSTed JSON data to this endpoint.

Parameters:

createCoverArtGrid - (required)

Returns:

APIcreateCoverArtGridRequest

Http Response Details:

Status Code	Description	Response Headers
200	Cover art created successfully.	-
400	Invalid JSON or invalid options in JSON passed.	-

createCoverArtGridForUser

public LbArtApi.APIcreateCoverArtGridForUserRequest createCoverArtGridForUser(String userName,
 AllowedStatisticsRange timeRange,
 Integer dimension,
 Integer layout,
 Integer imageSize)

Create a cover art grid SVG file from the stats of a given user.

Parameters:

userName - The name of the user for whom to create the cover art. (required)

timeRange - Must be a statistics time range. (required)

dimension - The dimension to use for this grid. A grid of dimension 3 has 3 images across and 3 images down, for a total of 9 images. (required)

layout - The layout to be used for this grid. Layout 0 is always a simple grid, but other layouts may have image images be of different sizes. See https://art.listenbrainz.org for examples of the available layouts. (required)

imageSize - The size of the cover art image. (required)

Returns:

APIcreateCoverArtGridForUserRequest

Http Response Details:

Status Code	Description	Response Headers
200	Cover art created successfully.	-
400	Invalid JSON or invalid options in JSON passed.	-

createCustomCoverArt

public LbArtApi.APIcreateCustomCoverArtRequest createCustomCoverArt(CoverTypes customName,
 String userName,
 AllowedStatisticsRange timeRange,
 Integer imageSize)

Create a custom cover art SVG file from the stats of a given user.

Parameters:

customName - The name of cover art to be generated. (required)

userName - The name of the user for whom to create the cover art. (required)

timeRange - Must be a statistics time range. (required)

imageSize - The size of the cover art image. (required)

Returns:

APIcreateCustomCoverArtRequest

Http Response Details:

Status Code	Description	Response Headers
200	Cover art created successfully.	-
400	Invalid JSON or invalid options in JSON passed.	-

yearInMusic

public LbArtApi.APIyearInMusicRequest yearInMusic(Integer year,
 String userName,
 YearInMusicImage image)

Create the shareable svg image using YIM stats.

Parameters:

year - (required)

userName - The name of the user for whom to create the cover art. (required)

image - (required)

Returns:

APIyearInMusicRequest

Http Response Details:

Status Code	Description	Response Headers
200	Cover art created successfully.	-
400	Invalid JSON or invalid options in JSON passed.	-