Skip to content

Latest commit

 

History

History
384 lines (303 loc) · 9.79 KB

cover-art-archive.md

File metadata and controls

384 lines (303 loc) · 9.79 KB

Extension: Cover Art Archive

Retrieve cover art images for releases from the Cover Art Archive.

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

Configuration

This extension can be configured using environment variables:

  • COVER_ART_ARCHIVE_BASE_URL: The base URL at which to access the Cover Art Archive API. Defaults to http://coverartarchive.org/.
  • COVER_ART_ARCHIVE_CACHE_SIZE: The number of items to keep in the cache. Defaults to GRAPHBRAINZ_CACHE_SIZE if defined, or 8192.
  • COVER_ART_ARCHIVE_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

CoverArtArchiveImage

An individual piece of album artwork from the Cover Art Archive.

Field Argument Type Description
fileID String!

The Internet Archive’s internal file ID for the image.

image URLString!

The URL at which the image can be found.

thumbnails CoverArtArchiveImageThumbnails!

A set of thumbnails for the image.

front Boolean!

Whether this image depicts the “main front” of the release.

back Boolean!

Whether this image depicts the “main back” of the release.

types [String]!

A list of image types describing what part(s) of the release the image includes.

edit Int

The MusicBrainz edit ID.

approved Boolean

Whether the image was approved by the MusicBrainz edit system.

comment String

A free-text comment left for the image.

CoverArtArchiveImageThumbnails

URLs for thumbnails of different sizes for a particular piece of cover art.

Field Argument Type Description
small URLString

The URL of a small version of the cover art, where the maximum dimension is 250px.

large URLString

The URL of a large version of the cover art, where the maximum dimension is 500px.

CoverArtArchiveRelease

An object containing a list of the cover art images for a release obtained from the Cover Art Archive, as well as a summary of what artwork is available.

Field Argument Type Description
front URLString

The URL of an image depicting the album cover or “main front” of the release, i.e. the front of the packaging of the audio recording (or in the case of a digital release, the image associated with it in a digital media store).

In the MusicBrainz schema, this field is a Boolean value indicating the presence of a front image, whereas here the value is the URL for the image itself if one exists. You can check for null if you just want to determine the presence of an image.

size CoverArtArchiveImageSize

The size of the image to retrieve. By default, the returned image will have its full original dimensions, but certain thumbnail sizes may be retrieved as well.

back URLString

The URL of an image depicting the “main back” of the release, i.e. the back of the packaging of the audio recording.

In the MusicBrainz schema, this field is a Boolean value indicating the presence of a back image, whereas here the value is the URL for the image itself. You can check for null if you just want to determine the presence of an image.

size CoverArtArchiveImageSize

The size of the image to retrieve. By default, the returned image will have its full original dimensions, but certain thumbnail sizes may be retrieved as well.

images [CoverArtArchiveImage]!

A list of images depicting the different sides and surfaces of a release’s media and packaging.

artwork Boolean!

Whether there is artwork present for this release.

count Int!

The number of artwork images present for this release.

release Release

The particular release shown in the returned cover art.

Release

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

Field Argument Type Description
coverArtArchive CoverArtArchiveRelease

An object containing a list and summary of the cover art images that are present for this release from the Cover Art Archive. This field is provided by the Cover Art Archive extension.

ReleaseGroup

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

Field Argument Type Description
coverArtArchive CoverArtArchiveRelease

The cover art for a release in the release group, obtained from the Cover Art Archive. A release in the release group will be chosen as representative of the release group. This field is provided by the Cover Art Archive extension.

Enums

CoverArtArchiveImageSize

The image sizes that may be requested at the Cover Art Archive.

Value Description
SMALL

A maximum dimension of 250px.

LARGE

A maximum dimension of 500px.

FULL

The image’s original dimensions, with no maximum.