Interface ImageRequestParameters

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

interface ImageRequestParameters {
    addPlayedIndicator?: boolean;
    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;
}

Properties

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

Properties

OptionaladdPlayedIndicator

addPlayedIndicator?: boolean

OptionalbackgroundColor

backgroundColor?: string

Optionalblur

blur?: number

OptionalcropWhitespace

cropWhitespace?: boolean

OptionalfillHeight

fillHeight?: number

OptionalfillWidth

fillWidth?: number

OptionalforegroundLayer

foregroundLayer?: string

Optionalformat

format?: ImageFormat

Optionalheight

height?: number

OptionalimageIndex

imageIndex?: number

OptionalmaxHeight

maxHeight?: number

OptionalmaxWidth

maxWidth?: number

OptionalpercentPlayed

percentPlayed?: number

Optionalquality

quality?: number

Optionaltag

tag?: string

OptionalunplayedCount

unplayedCount?: number

Optionalwidth

width?: number

Settings

Member Visibility

On This Page

Properties