Sign in

v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Image

Gets the item's image.

get/Items/{itemId}/Images/{imageType}

Path parameters

itemIdstring uuid required

Item id.

Item id.

imageType'Primary' | 'Art' | 'Backdrop' | 'Banner' | 'Logo' | 'Thumb' | 'Disc' | 'Box' | 'Screenshot' | 'Menu' | 'Chapter' | 'BoxRear' | 'Profile' required

Enum ImageType.

Image type.

Query parameters

maxWidthinteger nullable

The maximum image width to return.

The maximum image width to return.

maxHeightinteger nullable

The maximum image height to return.

The maximum image height to return.

widthinteger nullable

The fixed image width to return.

The fixed image width to return.

heightinteger nullable

The fixed image height to return.

The fixed image height to return.

qualityinteger nullable

Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

tagstring nullable

Optional. Supply the cache tag from the item object to receive strong caching headers.

Optional. Supply the cache tag from the item object to receive strong caching headers.

cropWhitespaceboolean nullable

Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.

Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.

format'Bmp' | 'Gif' | 'Jpg' | 'Png' | 'Webp'

Enum ImageOutputFormat.

Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.

addPlayedIndicatorboolean nullable

Optional. Add a played indicator.

Optional. Add a played indicator.

percentPlayednumber double nullable

Optional. Percent to render for the percent played overlay.

Optional. Percent to render for the percent played overlay.

unplayedCountinteger nullable

Optional. Unplayed count overlay to render.

Optional. Unplayed count overlay to render.

blurinteger nullable

Optional. Blur image.

Optional. Blur image.

backgroundColorstring nullable

Optional. Apply a background color for transparent images.

Optional. Apply a background color for transparent images.

foregroundLayerstring nullable

Optional. Apply a foreground layer on top of the image.

Optional. Apply a foreground layer on top of the image.

imageIndexinteger nullable

Image index.

Image index.

Response

Image stream returned.