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

GetRecordingsRequest

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

val channelId: String? = null

Optional. Filter by channel id.

val enableImages: Boolean? = null

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

Optional. Return total record count.

val enableUserData: Boolean? = null

Optional. Include user data.

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.

val isInProgress: Boolean? = null

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

val isKids: Boolean? = null

Optional. Filter for kids.

val isLibraryItem: Boolean? = null

Optional. Filter for is library item.

val isMovie: Boolean? = null

Optional. Filter for movies.

val isNews: Boolean? = null

Optional. Filter for news.

val isSeries: Boolean? = null

Optional. Filter for series.

val isSports: Boolean? = null

Optional. Filter for sports.

val limit: Int? = null

Optional. The maximum number of records to return.

val seriesTimerId: String? = null

Optional. Filter by recordings belonging to a series timer.

val startIndex: Int? = null

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

val status: RecordingStatus? = null

Optional. Filter by recording status.

val userId: UUID? = null

Optional. Filter by user and attach user data.