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

GetRecordingsRequest

@Serializable

data class GetRecordingsRequest(val channelId: String? = null, val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val status: RecordingStatus? = null, val isInProgress: Boolean? = null, val seriesTimerId: String? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val fields: Collection<ItemFields>? = null, val enableUserData: Boolean? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val isNews: Boolean? = null, val isLibraryItem: Boolean? = null, val enableTotalRecordCount: Boolean? = true)

Live tv recordings.

Constructors

GetRecordingsRequest

constructor(channelId: String? = null, userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, status: RecordingStatus? = null, isInProgress: Boolean? = null, seriesTimerId: String? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, fields: Collection<ItemFields>? = null, enableUserData: Boolean? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, isNews: Boolean? = null, isLibraryItem: Boolean? = null, enableTotalRecordCount: Boolean? = true)

Properties

@SerialName(value = "channelId")

val channelId: String?

Optional. Filter by channel id.

@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?

Optional. Return total record count.

@SerialName(value = "enableUserData")

val enableUserData: Boolean?

Optional. Include user data.

@SerialName(value = "fields")

val fields: Collection<ItemFields>?

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

@SerialName(value = "imageTypeLimit")

val imageTypeLimit: Int?

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

@SerialName(value = "isInProgress")

val isInProgress: Boolean?

Optional. Filter by recordings that are in progress, or not.

@SerialName(value = "isKids")

val isKids: Boolean?

Optional. Filter for kids.

@SerialName(value = "isLibraryItem")

val isLibraryItem: Boolean?

Optional. Filter for is library item.

@SerialName(value = "isMovie")

val isMovie: Boolean?

Optional. Filter for movies.

@SerialName(value = "isNews")

val isNews: Boolean?

Optional. Filter for news.

@SerialName(value = "isSeries")

val isSeries: Boolean?

Optional. Filter for series.

@SerialName(value = "isSports")

val isSports: Boolean?

Optional. Filter for sports.

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

@SerialName(value = "seriesTimerId")

val seriesTimerId: String?

Optional. Filter by recordings belonging to a series timer.

@SerialName(value = "startIndex")

val startIndex: Int?

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

@SerialName(value = "status")

val status: RecordingStatus?

Optional. Filter by recording status.

@SerialName(value = "userId")

val userId: UUID?

Optional. Filter by user and attach user data.