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

GetLiveTvChannelsRequest

@Serializable

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

@SerialName(value = "addCurrentProgram")

val addCurrentProgram: Boolean?

Optional. Adds current program info to each channel.

enableFavoriteSorting

@SerialName(value = "enableFavoriteSorting")

val enableFavoriteSorting: Boolean?

Optional. Incorporate favorite and like status into channel sorting.

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

@SerialName(value = "enableUserData")

val enableUserData: Boolean?

Optional. Include user data.

@SerialName(value = "fields")

val fields: Collection<ItemFields>?

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

@SerialName(value = "imageTypeLimit")

val imageTypeLimit: Int?

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

@SerialName(value = "isDisliked")

val isDisliked: Boolean?

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

@SerialName(value = "isFavorite")

val isFavorite: Boolean?

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

@SerialName(value = "isKids")

val isKids: Boolean?

Optional. Filter for kids.

@SerialName(value = "isLiked")

val isLiked: Boolean?

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

@SerialName(value = "isMovie")

val isMovie: Boolean?

Optional. Filter for movies.

@SerialName(value = "isNews")

val isNews: Boolean?

Optional. Filter for news.

@SerialName(value = "isSeries")

val isSeries: Boolean?

Optional. Filter for series.

@SerialName(value = "isSports")

val isSports: Boolean?

Optional. Filter for sports.

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

@SerialName(value = "sortBy")

val sortBy: Collection<ItemSortBy>?

Optional. Key to sort by.

@SerialName(value = "sortOrder")

val sortOrder: SortOrder?

Optional. Sort order.

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

@SerialName(value = "type")

val type: ChannelType?

Optional. Filter by channel type.

@SerialName(value = "userId")

val userId: UUID?

Optional. Filter by user and attach user data.