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

GetLiveTvProgramsRequest

@Serializable

data class GetLiveTvProgramsRequest(val channelIds: Collection<UUID>? = null, val userId: UUID? = null, val minStartDate: DateTime? = null, val hasAired: Boolean? = null, val isAiring: Boolean? = null, val maxStartDate: DateTime? = null, val minEndDate: DateTime? = null, val maxEndDate: DateTime? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val startIndex: Int? = null, val limit: Int? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null, val genres: Collection<String>? = null, val genreIds: Collection<UUID>? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null, val seriesTimerId: String? = null, val librarySeriesId: UUID? = null, val fields: Collection<ItemFields>? = null, val enableTotalRecordCount: Boolean? = true)

Available live tv epgs.

Constructors

constructor(channelIds: Collection<UUID>? = null, userId: UUID? = null, minStartDate: DateTime? = null, hasAired: Boolean? = null, isAiring: Boolean? = null, maxStartDate: DateTime? = null, minEndDate: DateTime? = null, maxEndDate: DateTime? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, startIndex: Int? = null, limit: Int? = null, sortBy: Collection<ItemSortBy>? = null, sortOrder: Collection<SortOrder>? = null, genres: Collection<String>? = null, genreIds: Collection<UUID>? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, enableUserData: Boolean? = null, seriesTimerId: String? = null, librarySeriesId: UUID? = null, fields: Collection<ItemFields>? = null, enableTotalRecordCount: Boolean? = true)

Properties

channelIds

@SerialName(value = "channelIds")

val channelIds: Collection<UUID>?

The channels to return guide information for.

enableImages

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

Retrieve total record count.

enableUserData

@SerialName(value = "enableUserData")

val enableUserData: Boolean?

Optional. Include user data.

fields

@SerialName(value = "fields")

val fields: Collection<ItemFields>?

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

genreIds

@SerialName(value = "genreIds")

val genreIds: Collection<UUID>?

The genre ids to return guide information for.

genres

@SerialName(value = "genres")

val genres: Collection<String>?

The genres to return guide information for.

hasAired

@SerialName(value = "hasAired")

val hasAired: Boolean?

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

imageTypeLimit

@SerialName(value = "imageTypeLimit")

val imageTypeLimit: Int?

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

isAiring

@SerialName(value = "isAiring")

val isAiring: Boolean?

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

isKids

@SerialName(value = "isKids")

val isKids: Boolean?

Optional. Filter for kids.

isMovie

@SerialName(value = "isMovie")

val isMovie: Boolean?

Optional. Filter for movies.

isNews

@SerialName(value = "isNews")

val isNews: Boolean?

Optional. Filter for news.

isSeries

@SerialName(value = "isSeries")

val isSeries: Boolean?

Optional. Filter for series.

isSports

@SerialName(value = "isSports")

val isSports: Boolean?

Optional. Filter for sports.

librarySeriesId

@SerialName(value = "librarySeriesId")

val librarySeriesId: UUID?

Optional. Filter by library series id.

limit

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

maxEndDate

@SerialName(value = "maxEndDate")

val maxEndDate: DateTime?

Optional. The maximum premiere end date.

maxStartDate

@SerialName(value = "maxStartDate")

val maxStartDate: DateTime?

Optional. The maximum premiere start date.

minEndDate

@SerialName(value = "minEndDate")

val minEndDate: DateTime?

Optional. The minimum premiere end date.

minStartDate

@SerialName(value = "minStartDate")

val minStartDate: DateTime?

Optional. The minimum premiere start date.

seriesTimerId

@SerialName(value = "seriesTimerId")

val seriesTimerId: String?

Optional. Filter by series timer id.

sortBy

@SerialName(value = "sortBy")

val sortBy: Collection<ItemSortBy>?

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

sortOrder

@SerialName(value = "sortOrder")

val sortOrder: Collection<SortOrder>?

Sort Order - Ascending,Descending.

startIndex

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

userId

@SerialName(value = "userId")

val userId: UUID?

Optional. Filter by user id.