jellyfin-model/org.jellyfin.sdk.model.api.request/GetItemImageRequest

GetItemImageRequest

@Serializable

data class GetItemImageRequest(val itemId: UUID, val imageType: ImageType, val maxWidth: Int? = null, val maxHeight: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val tag: String? = null, val format: ImageFormat? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null, val imageIndex: Int? = null)

The item's image.

Constructors

GetItemImageRequest

constructor(itemId: UUID, imageType: ImageType, 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: ImageFormat? = null, percentPlayed: Double? = null, unplayedCount: Int? = null, blur: Int? = null, backgroundColor: String? = null, foregroundLayer: String? = null, imageIndex: Int? = null)

Properties

backgroundColor

@SerialName(value = "backgroundColor")

val backgroundColor: String?

Optional. Apply a background color for transparent images.

@SerialName(value = "blur")

val blur: Int?

Optional. Blur image.

@SerialName(value = "fillHeight")

val fillHeight: Int?

Height of box to fill.

@SerialName(value = "fillWidth")

val fillWidth: Int?

Width of box to fill.

foregroundLayer

@SerialName(value = "foregroundLayer")

val foregroundLayer: String?

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

@SerialName(value = "format")

val format: ImageFormat?

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

@SerialName(value = "height")

val height: Int?

The fixed image height to return.

@SerialName(value = "imageIndex")

val imageIndex: Int?

Image index.

@SerialName(value = "imageType")

val imageType: ImageType

Image type.

@SerialName(value = "itemId")

val itemId: UUID

Item id.

@SerialName(value = "maxHeight")

val maxHeight: Int?

The maximum image height to return.

@SerialName(value = "maxWidth")

val maxWidth: Int?

The maximum image width to return.

@SerialName(value = "percentPlayed")

val percentPlayed: Double?

Optional. Percent to render for the percent played overlay.

@SerialName(value = "quality")

val quality: Int?

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

@SerialName(value = "tag")

val tag: String?

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

@SerialName(value = "unplayedCount")

val unplayedCount: Int?

Optional. Unplayed count overlay to render.

@SerialName(value = "width")

val width: Int?

The fixed image width to return.