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

GetStudiosRequest

data class GetStudiosRequest(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 isFavorite: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val userId: UUID? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val enableImages: Boolean? = true, val enableTotalRecordCount: Boolean? = true)

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

Constructors

GetStudiosRequest

constructor(startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, parentId: UUID? = null, fields: Collection<ItemFields>? = null, excludeItemTypes: Collection<BaseItemKind>? = null, includeItemTypes: Collection<BaseItemKind>? = null, isFavorite: Boolean? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, userId: UUID? = null, nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, enableImages: Boolean? = true, enableTotalRecordCount: Boolean? = true)

Properties

val enableImages: Boolean? = true

Optional, include image information in output.

enableImageTypes

val enableImageTypes: Collection<ImageType>? = null

Optional. The image types to include in the output.

enableTotalRecordCount

val enableTotalRecordCount: Boolean? = true

Total record count.

val enableUserData: Boolean? = null

Optional, include user data.

excludeItemTypes

val excludeItemTypes: Collection<BaseItemKind>? = null

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

val fields: Collection<ItemFields>? = null

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

val imageTypeLimit: Int? = null

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

includeItemTypes

val includeItemTypes: Collection<BaseItemKind>? = null

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

val isFavorite: Boolean? = null

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

val limit: Int? = null

Optional. The maximum number of records to return.

val nameLessThan: String? = null

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

val nameStartsWith: String? = null

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

nameStartsWithOrGreater

val nameStartsWithOrGreater: String? = null

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

val parentId: UUID? = null

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

val searchTerm: String? = null

Optional. Search term.

val startIndex: Int? = null

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

val userId: UUID? = null

User id.