jellyfin-api/org.jellyfin.sdk.api.operations/LiveTvApi/getRecordings

getRecordings

suspend fun getRecordings(channelId: String? = null, userId: <Error class: unknown class>? = null, startIndex: Int? = null, limit: Int? = null, status: <Error class: unknown class>? = null, isInProgress: Boolean? = null, seriesTimerId: String? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<<Error class: unknown class>>? = emptyList(), fields: Collection<<Error class: unknown class>>? = emptyList(), enableUserData: Boolean? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, isNews: Boolean? = null, isLibraryItem: Boolean? = null, enableTotalRecordCount: Boolean? = true): Response<<Error class: unknown class>>

Gets live tv recordings.

Parameters

channelId

Optional. Filter by channel id.

userId

Optional. Filter by user and attach user data.

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.

status

Optional. Filter by recording status.

isInProgress

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

seriesTimerId

Optional. Filter by recordings belonging to a series timer.

enableImages

Optional. Include image information in output.

imageTypeLimit

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

enableImageTypes

Optional. The image types to include in the output.

fields

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

enableUserData

Optional. Include user data.

isMovie

Optional. Filter for movies.

isSeries

Optional. Filter for series.

isKids

Optional. Filter for kids.

isSports

Optional. Filter for sports.

isNews

Optional. Filter for news.

isLibraryItem

Optional. Filter for is library item.

enableTotalRecordCount

Optional. Return total record count.

suspend fun getRecordings(request: <Error class: unknown class> = GetRecordingsRequest()): Response<<Error class: unknown class>>

Gets live tv recordings.

Parameters

request

The request parameters