Interface ImageRequestParameters

Interface representing supported request parameters for the getItemImage API. (May also work for other image APIs)

interface ImageRequestParameters {
    backgroundColor?: string;
    blur?: number;
    cropWhitespace?: boolean;
    fillHeight?: number;
    fillWidth?: number;
    foregroundLayer?: string;
    format?: ImageFormat;
    height?: number;
    imageIndex?: number;
    maxHeight?: number;
    maxWidth?: number;
    percentPlayed?: number;
    quality?: number;
    tag?: string;
    unplayedCount?: number;
    width?: number;
}

Index

Properties

backgroundColor? blur? cropWhitespace? fillHeight? fillWidth? foregroundLayer? format? height? imageIndex? maxHeight? maxWidth? percentPlayed? quality? tag? unplayedCount? width?

Properties

`Optional`backgroundColor

backgroundColor?: string

`Optional`blur

blur?: number

`Optional`cropWhitespace

cropWhitespace?: boolean

`Optional`fillHeight

fillHeight?: number

`Optional`fillWidth

fillWidth?: number

`Optional`foregroundLayer

foregroundLayer?: string

`Optional`format

format?: ImageFormat

`Optional`height

height?: number

`Optional`imageIndex

imageIndex?: number

`Optional`maxHeight

maxHeight?: number

`Optional`maxWidth

maxWidth?: number

`Optional`percentPlayed

percentPlayed?: number

`Optional`quality

quality?: number

`Optional`tag

tag?: string

`Optional`unplayedCount

unplayedCount?: number

`Optional`width

width?: number