graphbrainz/docs/extensions/fanart-tv.md
Brian Beck e77143fbd7
Bump deps, use latest updateSchema feature from graphql-markdown (#45)
* Bump deps, use latest updateSchema feature from graphql-markdown
2017-11-01 22:40:52 -07:00

9.8 KiB
Raw Permalink Blame History

Extension: fanart.tv

Retrieve high quality artwork for artists, releases, and labels from fanart.tv.

This extension uses its own cache, separate from the MusicBrainz loader cache.

Configuration

This extension can be configured using environment variables:

  • FANART_API_KEY: The fanart.tv API key to use. This is required for any fields added by the extension to successfully resolve.
  • FANART_BASE_URL: The base URL at which to access the fanart.tv API. Defaults to http://webservice.fanart.tv/v3/.
  • FANART_CACHE_SIZE: The number of items to keep in the cache. Defaults to GRAPHBRAINZ_CACHE_SIZE if defined, or 8192.
  • FANART_CACHE_TTL: The number of seconds to keep items in the cache. Defaults to GRAPHBRAINZ_CACHE_TTL if defined, or 86400000 (one day).

Schema Types

Table of Contents

Objects

Artist

🔹 This type has been extended. See the base schema for a description and additional fields.

Field Argument Type Description
fanArt FanArtArtist

Images of the artist from fanart.tv. This field is provided by the fanart.tv extension.

FanArtAlbum

An object containing lists of the different types of release group images from fanart.tv.

Field Argument Type Description
albumCovers [FanArtImage]

A list of 1000x1000 JPG images of the cover artwork of the release group.

discImages [FanArtDiscImage]

A list of 1000x1000 PNG images of the physical disc media for the release group, with transparent backgrounds.

FanArtArtist

An object containing lists of the different types of artist images from fanart.tv.

Field Argument Type Description
backgrounds [FanArtImage]

A list of 1920x1080 JPG images picturing the artist, suitable for use as backgrounds.

banners [FanArtImage]

A list of 1000x185 JPG images containing the artist and their logo or name.

logos [FanArtImage]

A list of 400x155 PNG images containing the artists logo or name, with transparent backgrounds.

logosHD [FanArtImage]

A list of 800x310 PNG images containing the artists logo or name, with transparent backgrounds.

thumbnails [FanArtImage]

A list of 1000x1000 JPG thumbnail images picturing the artist (usually containing every member of a band).

FanArtDiscImage

A disc image from fanart.tv.

Field Argument Type Description
imageID ID

The ID of the image on fanart.tv.

url URLString

The URL of the image.

size FanArtImageSize

The size of the image to retrieve.

likeCount Int

The number of likes the image has received by fanart.tv users.

discNumber Int

The disc number.

size Int

The width and height of the (square) disc image.

FanArtImage

A single image from fanart.tv.

Field Argument Type Description
imageID ID

The ID of the image on fanart.tv.

url URLString

The URL of the image.

size FanArtImageSize

The size of the image to retrieve.

likeCount Int

The number of likes the image has received by fanart.tv users.

FanArtLabel

An object containing lists of the different types of label images from fanart.tv.

Field Argument Type Description
logos [FanArtLabelImage]

A list of 400x270 PNG images containing the labels logo. There will usually be a black version, a color version, and a white version, all with transparent backgrounds.

FanArtLabelImage

A music label image from fanart.tv.

Field Argument Type Description
imageID ID

The ID of the image on fanart.tv.

url URLString

The URL of the image.

size FanArtImageSize

The size of the image to retrieve.

likeCount Int

The number of likes the image has received by fanart.tv users.

color String

The type of color content in the image (usually “white” or “colour”).

Label

🔹 This type has been extended. See the base schema for a description and additional fields.

Field Argument Type Description
fanArt FanArtLabel

Images of the label from fanart.tv. This field is provided by the fanart.tv extension.

ReleaseGroup

🔹 This type has been extended. See the base schema for a description and additional fields.

Field Argument Type Description
fanArt FanArtAlbum

Images of the release group from fanart.tv. This field is provided by the fanart.tv extension.

Enums

FanArtImageSize

The image sizes that may be requested at fanart.tv.

Value Description
FULL

The images full original dimensions.

PREVIEW

A maximum dimension of 200px.