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

GetItemImageByIndexRequest

data class GetItemImageByIndexRequest(val itemId: UUID, val imageType: ImageType, val imageIndex: Int, 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)

The item's image.

Constructors

GetItemImageByIndexRequest

constructor(itemId: UUID, imageType: ImageType, imageIndex: Int, 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)

Properties

backgroundColor

val backgroundColor: String? = null

Optional. Apply a background color for transparent images.

val blur: Int? = null

Optional. Blur image.

val fillHeight: Int? = null

Height of box to fill.

val fillWidth: Int? = null

Width of box to fill.

foregroundLayer

val foregroundLayer: String? = null

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

val format: ImageFormat? = null

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

val height: Int? = null

The fixed image height to return.

val imageIndex: Int

Image index.

val imageType: ImageType

Image type.

val itemId: UUID

Item id.

val maxHeight: Int? = null

The maximum image height to return.

val maxWidth: Int? = null

The maximum image width to return.

val percentPlayed: Double? = null

Optional. Percent to render for the percent played overlay.

val quality: Int? = null

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

val tag: String? = null

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

val unplayedCount: Int? = null

Optional. Unplayed count overlay to render.

val width: Int? = null

The fixed image width to return.