GetPersonImageRequest

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

Get person image by name.

Constructors

Link copied to clipboard
constructor(name: String, imageType: ImageType, tag: String? = null, format: ImageFormat? = 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)

Properties

Link copied to clipboard

Optional. Apply a background color for transparent images.

Link copied to clipboard
val blur: Int?

Optional. Blur image.

Link copied to clipboard

Height of box to fill.

Link copied to clipboard

Width of box to fill.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val height: Int?

The fixed image height to return.

Link copied to clipboard

Image index.

Link copied to clipboard

Image type.

Link copied to clipboard

The maximum image height to return.

Link copied to clipboard

The maximum image width to return.

Link copied to clipboard

Person name.

Link copied to clipboard

Optional. Percent to render for the percent played overlay.

Link copied to clipboard
val quality: Int?

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

Link copied to clipboard
val tag: String?

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

Link copied to clipboard

Optional. Unplayed count overlay to render.

Link copied to clipboard
val width: Int?

The fixed image width to return.