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

getLiveTvPrograms

suspend fun getLiveTvPrograms(channelIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, minStartDate: <Error class: unknown class>? = null, hasAired: Boolean? = null, isAiring: Boolean? = null, maxStartDate: <Error class: unknown class>? = null, minEndDate: <Error class: unknown class>? = null, maxEndDate: <Error class: unknown class>? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, startIndex: Int? = null, limit: Int? = null, sortBy: Collection<<Error class: unknown class>>? = emptyList(), sortOrder: Collection<<Error class: unknown class>>? = emptyList(), genres: Collection<String>? = emptyList(), genreIds: Collection<<Error class: unknown class>>? = emptyList(), enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<<Error class: unknown class>>? = emptyList(), enableUserData: Boolean? = null, seriesTimerId: String? = null, librarySeriesId: <Error class: unknown class>? = null, fields: Collection<<Error class: unknown class>>? = emptyList(), enableTotalRecordCount: Boolean? = true): Response<<Error class: unknown class>>

Gets available live tv epgs.

Parameters

channelIds

The channels to return guide information for.

userId

Optional. Filter by user id.

minStartDate

Optional. The minimum premiere start date.

hasAired

Optional. Filter by programs that have completed airing, or not.

isAiring

Optional. Filter by programs that are currently airing, or not.

maxStartDate

Optional. The maximum premiere start date.

minEndDate

Optional. The minimum premiere end date.

maxEndDate

Optional. The maximum premiere end date.

isMovie

Optional. Filter for movies.

isSeries

Optional. Filter for series.

isNews

Optional. Filter for news.

isKids

Optional. Filter for kids.

isSports

Optional. Filter for sports.

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.

sortBy

Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.

sortOrder

Sort Order - Ascending,Descending.

genres

The genres to return guide information for.

genreIds

The genre ids to return guide information for.

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.

enableUserData

Optional. Include user data.

seriesTimerId

Optional. Filter by series timer id.

librarySeriesId

Optional. Filter by library series id.

fields

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

enableTotalRecordCount

Retrieve total record count.

suspend fun getLiveTvPrograms(request: <Error class: unknown class> = GetLiveTvProgramsRequest()): Response<<Error class: unknown class>>

Gets available live tv epgs.

Parameters

request

The request parameters