Interface ImageApiGetItemImage2Request

Request parameters for getItemImage2 operation in ImageApi.

Export

ImageApiGetItemImage2Request

interface ImageApiGetItemImage2Request {
    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? blur? fillHeight? fillWidth? foregroundLayer? format height? imageIndex imageType itemId maxHeight maxWidth percentPlayed quality? tag unplayedCount width?

Properties

Optional ReadonlybackgroundColor

backgroundColor?: string

Optional. Apply a background color for transparent images.

Memberof

ImageApiGetItemImage2

Optional Readonlyblur

blur?: number

Optional. Blur image.

Memberof

ImageApiGetItemImage2

Optional ReadonlyfillHeight

fillHeight?: number

Height of box to fill.

Memberof

ImageApiGetItemImage2

Optional ReadonlyfillWidth

fillWidth?: number

Width of box to fill.

Memberof

ImageApiGetItemImage2

Optional ReadonlyforegroundLayer

foregroundLayer?: string

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

Memberof

ImageApiGetItemImage2

Readonlyformat

format: ImageFormat

Determines the output format of the image - original,gif,jpg,png.

Memberof

ImageApiGetItemImage2

Optional Readonlyheight

height?: number

The fixed image height to return.

Memberof

ImageApiGetItemImage2

ReadonlyimageIndex

imageIndex: number

Image index.

Memberof

ImageApiGetItemImage2

ReadonlyimageType

imageType: ImageType

Image type.

Memberof

ImageApiGetItemImage2

ReadonlyitemId

itemId: string

Item id.

Memberof

ImageApiGetItemImage2

ReadonlymaxHeight

maxHeight: number

The maximum image height to return.

Memberof

ImageApiGetItemImage2

ReadonlymaxWidth

maxWidth: number

The maximum image width to return.

Memberof

ImageApiGetItemImage2

ReadonlypercentPlayed

percentPlayed: number

Optional. Percent to render for the percent played overlay.

Memberof

ImageApiGetItemImage2

Optional Readonlyquality

quality?: number

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

Memberof

ImageApiGetItemImage2

Readonlytag

tag: string

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

Memberof

ImageApiGetItemImage2

ReadonlyunplayedCount

unplayedCount: number

Optional. Unplayed count overlay to render.

Memberof

ImageApiGetItemImage2

Optional Readonlywidth

width?: number

The fixed image width to return.

Memberof

ImageApiGetItemImage2

Settings

Member Visibility

On This Page

Properties