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

ImageApi

class ImageApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun deleteCustomSplashscreen(): Response<Unit>

Delete a custom splashscreen.

Link copied to clipboard
suspend fun deleteItemImage(itemId: <Error class: unknown class>, imageType: <Error class: unknown class>, imageIndex: Int? = null): Response<Unit>

Delete an item's image.

Link copied to clipboard
suspend fun deleteItemImageByIndex(itemId: <Error class: unknown class>, imageType: <Error class: unknown class>, imageIndex: Int): Response<Unit>

Delete an item's image.

Link copied to clipboard
suspend fun deleteUserImage(userId: <Error class: unknown class>? = null): Response<Unit>

Delete the user's image.

Link copied to clipboard
suspend fun getArtistImage(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getArtistImage(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): Response<<Error class: unknown class>>

Get artist image by name.

Link copied to clipboard
fun getArtistImageUrl(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): String

Get artist image by name.

Link copied to clipboard
suspend fun getGenreImage(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getGenreImage(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 genre image by name.

Link copied to clipboard
suspend fun getGenreImageByIndex(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getGenreImageByIndex(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): Response<<Error class: unknown class>>

Get genre image by name.

Link copied to clipboard
fun getGenreImageByIndexUrl(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): String

Get genre image by name.

Link copied to clipboard
fun getGenreImageUrl(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): String

Get genre image by name.

Link copied to clipboard
suspend fun getItemImage(request: <Error class: unknown class>): Response<<Error class: unknown class>>
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.

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

Gets the item's image.

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

Gets the item's image.

Link copied to clipboard
suspend fun getItemImageByIndex(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getItemImageByIndex(itemId: <Error class: unknown class>, imageType: <Error class: unknown class>, 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: <Error class: unknown class>? = null, percentPlayed: Double? = null, unplayedCount: Int? = null, blur: Int? = null, backgroundColor: String? = null, foregroundLayer: String? = null): Response<<Error class: unknown class>>

Gets the item's image.

Link copied to clipboard
fun getItemImageByIndexUrl(itemId: <Error class: unknown class>, imageType: <Error class: unknown class>, 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: <Error class: unknown class>? = null, percentPlayed: Double? = null, unplayedCount: Int? = null, blur: Int? = null, backgroundColor: String? = null, foregroundLayer: String? = null): String

Gets the item's image.

Link copied to clipboard
suspend fun getItemImageInfos(itemId: <Error class: unknown class>): Response<List<<Error class: unknown class>>>

Get item image infos.

Link copied to clipboard
fun getItemImageUrl(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): String

Gets the item's image.

Link copied to clipboard
suspend fun getMusicGenreImage(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getMusicGenreImage(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 music genre image by name.

Link copied to clipboard
suspend fun getMusicGenreImageByIndex(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getMusicGenreImageByIndex(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): Response<<Error class: unknown class>>

Get music genre image by name.

Link copied to clipboard
fun getMusicGenreImageByIndexUrl(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): String

Get music genre image by name.

Link copied to clipboard
fun getMusicGenreImageUrl(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): String

Get music genre image by name.

Link copied to clipboard
suspend fun getPersonImage(request: <Error class: unknown class>): Response<<Error class: unknown class>>
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.

Link copied to clipboard
suspend fun getPersonImageByIndex(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getPersonImageByIndex(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): Response<<Error class: unknown class>>

Get person image by name.

Link copied to clipboard
fun getPersonImageByIndexUrl(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): String

Get person image by name.

Link copied to clipboard
fun getPersonImageUrl(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): String

Get person image by name.

Link copied to clipboard
suspend fun getSplashscreen(request: <Error class: unknown class> = GetSplashscreenRequest()): Response<<Error class: unknown class>>
suspend fun getSplashscreen(tag: String? = null, format: <Error class: unknown class>? = null, maxWidth: Int? = null, maxHeight: Int? = null, width: Int? = null, height: Int? = null, fillWidth: Int? = null, fillHeight: Int? = null, blur: Int? = null, backgroundColor: String? = null, foregroundLayer: String? = null, quality: Int? = 90): Response<<Error class: unknown class>>

Generates or gets the splashscreen.

Link copied to clipboard
fun getSplashscreenUrl(tag: String? = null, format: <Error class: unknown class>? = null, maxWidth: Int? = null, maxHeight: Int? = null, width: Int? = null, height: Int? = null, fillWidth: Int? = null, fillHeight: Int? = null, blur: Int? = null, backgroundColor: String? = null, foregroundLayer: String? = null, quality: Int? = 90): String

Generates or gets the splashscreen.

Link copied to clipboard
suspend fun getStudioImage(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getStudioImage(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 studio image by name.

Link copied to clipboard
suspend fun getStudioImageByIndex(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getStudioImageByIndex(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): Response<<Error class: unknown class>>

Get studio image by name.

Link copied to clipboard
fun getStudioImageByIndexUrl(name: String, imageType: <Error class: unknown class>, imageIndex: Int, 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): String

Get studio image by name.

Link copied to clipboard
fun getStudioImageUrl(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): String

Get studio image by name.

Link copied to clipboard
suspend fun getUserImage(request: <Error class: unknown class> = GetUserImageRequest()): Response<<Error class: unknown class>>
suspend fun getUserImage(userId: <Error class: unknown class>? = null, 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 user profile image.

Link copied to clipboard
fun getUserImageUrl(userId: <Error class: unknown class>? = null, 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): String

Get user profile image.

Link copied to clipboard
suspend fun postUserImage(userId: <Error class: unknown class>? = null, data: <Error class: unknown class>): Response<Unit>

Sets the user image.

Link copied to clipboard
suspend fun setItemImage(itemId: <Error class: unknown class>, imageType: <Error class: unknown class>, data: <Error class: unknown class>): Response<Unit>

Set item image.

Link copied to clipboard
suspend fun setItemImageByIndex(itemId: <Error class: unknown class>, imageType: <Error class: unknown class>, imageIndex: Int, data: <Error class: unknown class>): Response<Unit>

Set item image.

Link copied to clipboard
suspend fun updateItemImageIndex(itemId: <Error class: unknown class>, imageType: <Error class: unknown class>, imageIndex: Int, newIndex: Int): Response<Unit>

Updates the index for an item image.

Link copied to clipboard
suspend fun uploadCustomSplashscreen(data: <Error class: unknown class>): Response<Unit>

Uploads a custom splashscreen. The body is expected to the image contents base64 encoded.