jellyfin-api/org.jellyfin.sdk.api.operations/StudiosApi/getStudios

getStudios

suspend fun getStudios(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(), isFavorite: Boolean? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, enableImages: Boolean? = true, enableTotalRecordCount: Boolean? = true): Response<<Error class: unknown class>>

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

Parameters

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.

isFavorite

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

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.

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.

enableImages

Optional, include image information in output.

enableTotalRecordCount

Total record count.

suspend fun getStudios(request: <Error class: unknown class> = GetStudiosRequest()): Response<<Error class: unknown class>>

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

Parameters

request

The request parameters