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

GetAlbumArtistsRequest

@Serializable

data class GetAlbumArtistsRequest(val minCommunityRating: Double? = null, val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val filters: Collection<ItemFilter>? = null, val isFavorite: Boolean? = null, val mediaTypes: Collection<MediaType>? = null, val genres: Collection<String>? = null, val genreIds: Collection<UUID>? = null, val officialRatings: Collection<String>? = null, val tags: Collection<String>? = null, val years: Collection<Int>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val person: String? = null, val personIds: Collection<UUID>? = null, val personTypes: Collection<String>? = null, val studios: Collection<String>? = null, val studioIds: Collection<UUID>? = null, val userId: UUID? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null, val enableImages: Boolean? = true, val enableTotalRecordCount: Boolean? = true)

All album artists from a given item, folder, or the entire library.

Constructors

constructor(minCommunityRating: Double? = null, startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, parentId: UUID? = null, fields: Collection<ItemFields>? = null, excludeItemTypes: Collection<BaseItemKind>? = null, includeItemTypes: Collection<BaseItemKind>? = null, filters: Collection<ItemFilter>? = null, isFavorite: Boolean? = null, mediaTypes: Collection<MediaType>? = null, genres: Collection<String>? = null, genreIds: Collection<UUID>? = null, officialRatings: Collection<String>? = null, tags: Collection<String>? = null, years: Collection<Int>? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, person: String? = null, personIds: Collection<UUID>? = null, personTypes: Collection<String>? = null, studios: Collection<String>? = null, studioIds: Collection<UUID>? = null, userId: UUID? = null, nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, sortBy: Collection<ItemSortBy>? = null, sortOrder: Collection<SortOrder>? = null, enableImages: Boolean? = true, enableTotalRecordCount: Boolean? = true)

Properties

enableImages

@SerialName(value = "enableImages")

val enableImages: Boolean?

Optional, include image information in output.

enableImageTypes

@SerialName(value = "enableImageTypes")

val enableImageTypes: Collection<ImageType>?

Optional. The image types to include in the output.

enableTotalRecordCount

@SerialName(value = "enableTotalRecordCount")

val enableTotalRecordCount: Boolean?

Total record count.

enableUserData

@SerialName(value = "enableUserData")

val enableUserData: Boolean?

Optional, include user data.

excludeItemTypes

@SerialName(value = "excludeItemTypes")

val excludeItemTypes: Collection<BaseItemKind>?

Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.

fields

@SerialName(value = "fields")

val fields: Collection<ItemFields>?

Optional. Specify additional fields of information to return in the output.

filters

@SerialName(value = "filters")

val filters: Collection<ItemFilter>?

Optional. Specify additional filters to apply.

genreIds

@SerialName(value = "genreIds")

val genreIds: Collection<UUID>?

Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

genres

@SerialName(value = "genres")

val genres: Collection<String>?

Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

imageTypeLimit

@SerialName(value = "imageTypeLimit")

val imageTypeLimit: Int?

Optional, the max number of images to return, per image type.

includeItemTypes

@SerialName(value = "includeItemTypes")

val includeItemTypes: Collection<BaseItemKind>?

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

isFavorite

@SerialName(value = "isFavorite")

val isFavorite: Boolean?

Optional filter by items that are marked as favorite, or not.

limit

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

mediaTypes

@SerialName(value = "mediaTypes")

val mediaTypes: Collection<MediaType>?

Optional filter by MediaType. Allows multiple, comma delimited.

minCommunityRating

@SerialName(value = "minCommunityRating")

val minCommunityRating: Double?

Optional filter by minimum community rating.

nameLessThan

@SerialName(value = "nameLessThan")

val nameLessThan: String?

Optional filter by items whose name is equally or lesser than a given input string.

nameStartsWith

@SerialName(value = "nameStartsWith")

val nameStartsWith: String?

Optional filter by items whose name is sorted equally than a given input string.

nameStartsWithOrGreater

@SerialName(value = "nameStartsWithOrGreater")

val nameStartsWithOrGreater: String?

Optional filter by items whose name is sorted equally or greater than a given input string.

officialRatings

@SerialName(value = "officialRatings")

val officialRatings: Collection<String>?

Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

parentId

@SerialName(value = "parentId")

val parentId: UUID?

Specify this to localize the search to a specific item or folder. Omit to use the root.

person

@SerialName(value = "person")

val person: String?

Optional. If specified, results will be filtered to include only those containing the specified person.

personIds

@SerialName(value = "personIds")

val personIds: Collection<UUID>?

Optional. If specified, results will be filtered to include only those containing the specified person ids.

personTypes

@SerialName(value = "personTypes")

val personTypes: Collection<String>?

Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.

searchTerm