jellyfin-api/org.jellyfin.sdk.api.operations/ArtistsApi/getArtists

getArtists

suspend fun getArtists(minCommunityRating: Double? = null, startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, parentId: <Error class: unknown class>? = null, fields: Collection<<Error class: unknown class>>? = emptyList(), excludeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), includeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), filters: Collection<<Error class: unknown class>>? = emptyList(), isFavorite: Boolean? = null, mediaTypes: Collection<<Error class: unknown class>>? = emptyList(), genres: Collection<String>? = emptyList(), genreIds: Collection<<Error class: unknown class>>? = emptyList(), officialRatings: Collection<String>? = emptyList(), tags: Collection<String>? = emptyList(), years: Collection<Int>? = emptyList(), enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<<Error class: unknown class>>? = emptyList(), person: String? = null, personIds: Collection<<Error class: unknown class>>? = emptyList(), personTypes: Collection<String>? = emptyList(), studios: Collection<String>? = emptyList(), studioIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, sortBy: Collection<<Error class: unknown class>>? = emptyList(), sortOrder: Collection<<Error class: unknown class>>? = emptyList(), enableImages: Boolean? = true, enableTotalRecordCount: Boolean? = true): Response<<Error class: unknown class>>

Gets all artists from a given item, folder, or the entire library.

Parameters

minCommunityRating

Optional filter by minimum community rating.

startIndex

Optional. The record index to start at. All items with a lower index will be dropped from the results.

limit

Optional. The maximum number of records to return.

searchTerm

Optional. Search term.

parentId

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

fields

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

excludeItemTypes

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

includeItemTypes

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

filters

Optional. Specify additional filters to apply.

isFavorite

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

mediaTypes

Optional filter by MediaType. Allows multiple, comma delimited.

genres

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

genreIds

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

officialRatings

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

tags

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

years

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

enableUserData

Optional, include user data.

imageTypeLimit

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

enableImageTypes

Optional. The image types to include in the output.

person

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

personIds

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

personTypes

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

studios

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

studioIds

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

userId

User id.

nameStartsWithOrGreater

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

nameStartsWith

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

nameLessThan

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

sortBy

Optional. Specify one or more sort orders, comma delimited.

sortOrder

Sort Order - Ascending,Descending.

enableImages

Optional, include image information in output.

enableTotalRecordCount

Total record count.

suspend fun getArtists(request: <Error class: unknown class> = GetArtistsRequest()): Response<<Error class: unknown class>>

Gets all artists from a given item, folder, or the entire library.

Parameters

request

The request parameters