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

GetLiveTvChannelsRequest

data class GetLiveTvChannelsRequest(val type: ChannelType? = null, val userId: UUID? = null, val startIndex: Int? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val limit: Int? = null, val isFavorite: Boolean? = null, val isLiked: Boolean? = null, val isDisliked: Boolean? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val fields: Collection<ItemFields>? = null, val enableUserData: Boolean? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: SortOrder? = null, val enableFavoriteSorting: Boolean? = false, val addCurrentProgram: Boolean? = true)

Available live tv channels.

Constructors

GetLiveTvChannelsRequest

constructor(type: ChannelType? = null, userId: UUID? = null, startIndex: Int? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, limit: Int? = null, isFavorite: Boolean? = null, isLiked: Boolean? = null, isDisliked: Boolean? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, fields: Collection<ItemFields>? = null, enableUserData: Boolean? = null, sortBy: Collection<ItemSortBy>? = null, sortOrder: SortOrder? = null, enableFavoriteSorting: Boolean? = false, addCurrentProgram: Boolean? = true)

Properties

addCurrentProgram

val addCurrentProgram: Boolean? = true

Optional. Adds current program info to each channel.

enableFavoriteSorting

val enableFavoriteSorting: Boolean? = false

Optional. Incorporate favorite and like status into channel sorting.

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.

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 isDisliked: Boolean? = null

Optional. Filter by channels that are disliked, or not.

val isFavorite: Boolean? = null

Optional. Filter by channels that are favorites, or not.

val isKids: Boolean? = null

Optional. Filter for kids.

val isLiked: Boolean? = null

Optional. Filter by channels that are liked, or not.

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 sortBy: Collection<ItemSortBy>? = null

Optional. Key to sort by.

val sortOrder: SortOrder? = null

Optional. Sort order.

val startIndex: Int? = null

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

val type: ChannelType? = null

Optional. Filter by channel type.

val userId: UUID? = null

Optional. Filter by user and attach user data.