Request parameters for getItemImage operation in ImageApi.

ImageApiGetItemImageRequest

interface ImageApiGetItemImageRequest {
    backgroundColor?: string;
    blur?: number;
    fillHeight?: number;
    fillWidth?: number;
    foregroundLayer?: string;
    format?: ImageFormat;
    height?: number;
    imageIndex?: number;
    imageType: ImageType;
    itemId: string;
    maxHeight?: number;
    maxWidth?: number;
    percentPlayed?: number;
    quality?: number;
    tag?: string;
    unplayedCount?: number;
    width?: number;
}

Properties

backgroundColor?: string

Optional. Apply a background color for transparent images.

ImageApiGetItemImage

blur?: number

Optional. Blur image.

ImageApiGetItemImage

fillHeight?: number

Height of box to fill.

ImageApiGetItemImage

fillWidth?: number

Width of box to fill.

ImageApiGetItemImage

foregroundLayer?: string

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

ImageApiGetItemImage

format?: ImageFormat

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

ImageApiGetItemImage

height?: number

The fixed image height to return.

ImageApiGetItemImage

imageIndex?: number

Image index.

ImageApiGetItemImage

imageType: ImageType

Image type.

ImageApiGetItemImage

itemId: string

Item id.

ImageApiGetItemImage

maxHeight?: number

The maximum image height to return.

ImageApiGetItemImage

maxWidth?: number

The maximum image width to return.

ImageApiGetItemImage

percentPlayed?: number

Optional. Percent to render for the percent played overlay.

ImageApiGetItemImage

quality?: number

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

ImageApiGetItemImage

tag?: string

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

ImageApiGetItemImage

unplayedCount?: number

Optional. Unplayed count overlay to render.

ImageApiGetItemImage

width?: number

The fixed image width to return.

ImageApiGetItemImage