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

getPersonImage

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

Get person image by name.

Parameters

name

Person name.

imageType

Image type.

tag

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

format

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

maxWidth

The maximum image width to return.

maxHeight

The maximum image height to return.

percentPlayed

Optional. Percent to render for the percent played overlay.

unplayedCount

Optional. Unplayed count overlay to render.

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.

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 getPersonImage(request: <Error class: unknown class>): Response<<Error class: unknown class>>

Get person image by name.

Parameters

request

The request parameters