jellyfin-api/org.jellyfin.sdk.api.operations/ImageApi/getItemImage

getItemImage

suspend fun getItemImage(itemId: <Error class: unknown class>, imageType: <Error class: unknown class>, maxWidth: Int? = null, maxHeight: Int? = null, width: Int? = null, height: Int? = null, quality: Int? = null, fillWidth: Int? = null, fillHeight: Int? = null, tag: String? = null, format: <Error class: unknown class>? = null, percentPlayed: Double? = null, unplayedCount: Int? = null, blur: Int? = null, backgroundColor: String? = null, foregroundLayer: String? = null, imageIndex: Int? = null): Response<<Error class: unknown class>>

Gets the item's image.

Parameters

itemId

Item id.

imageType

Image type.

maxWidth

The maximum image width to return.

maxHeight

The maximum image height to return.

width

The fixed image width to return.

height

The fixed image height to return.

quality

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

fillWidth

Width of box to fill.

fillHeight

Height of box to fill.

tag

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

format

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

percentPlayed

Optional. Percent to render for the percent played overlay.

unplayedCount

Optional. Unplayed count overlay to render.

blur

Optional. Blur image.

backgroundColor

Optional. Apply a background color for transparent images.

foregroundLayer

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

imageIndex

Image index.

suspend fun getItemImage(request: <Error class: unknown class>): Response<<Error class: unknown class>>

Gets the item's image.

Parameters

request

The request parameters