Interface ImageApiHeadStudioImageRequest

Request parameters for headStudioImage operation in ImageApi.

Export

ImageApiHeadStudioImageRequest

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

Properties

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

Properties

Optional ReadonlybackgroundColor

backgroundColor?: string

Optional. Apply a background color for transparent images.

Memberof

ImageApiHeadStudioImage

Optional Readonlyblur

blur?: number

Optional. Blur image.

Memberof

ImageApiHeadStudioImage

Optional ReadonlyfillHeight

fillHeight?: number

Height of box to fill.

Memberof

ImageApiHeadStudioImage

Optional ReadonlyfillWidth

fillWidth?: number

Width of box to fill.

Memberof

ImageApiHeadStudioImage

Optional ReadonlyforegroundLayer

foregroundLayer?: string

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

Memberof

ImageApiHeadStudioImage

Optional Readonlyformat

format?: ImageFormat

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

Memberof

ImageApiHeadStudioImage

Optional Readonlyheight

height?: number

The fixed image height to return.

Memberof

ImageApiHeadStudioImage

Optional ReadonlyimageIndex

imageIndex?: number

Image index.

Memberof

ImageApiHeadStudioImage

ReadonlyimageType

imageType: ImageType

Image type.

Memberof

ImageApiHeadStudioImage

Optional ReadonlymaxHeight

maxHeight?: number

The maximum image height to return.

Memberof

ImageApiHeadStudioImage

Optional ReadonlymaxWidth

maxWidth?: number

The maximum image width to return.

Memberof

ImageApiHeadStudioImage

Readonlyname

name: string

Studio name.

Memberof

ImageApiHeadStudioImage

Optional ReadonlypercentPlayed

percentPlayed?: number

Optional. Percent to render for the percent played overlay.

Memberof

ImageApiHeadStudioImage

Optional Readonlyquality

quality?: number

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

Memberof

ImageApiHeadStudioImage

Optional Readonlytag

tag?: string

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

Memberof

ImageApiHeadStudioImage

Optional ReadonlyunplayedCount

unplayedCount?: number

Optional. Unplayed count overlay to render.

Memberof

ImageApiHeadStudioImage

Optional Readonlywidth

width?: number

The fixed image width to return.

Memberof

ImageApiHeadStudioImage

Settings

Member Visibility

On This Page

Properties