JEjellyfin
LiveTv

Gets available live tv channels.

get/LiveTv/Channels

Request

Query parameters

type'TV' | 'Radio'

Enum ChannelType.

Optional. Filter by channel type.

userIdstring uuid nullable

Optional. Filter by user and attach user data.

startIndexinteger nullable

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

isMovieboolean nullable

Optional. Filter for movies.

isSeriesboolean nullable

Optional. Filter for series.

isNewsboolean nullable

Optional. Filter for news.

isKidsboolean nullable

Optional. Filter for kids.

isSportsboolean nullable

Optional. Filter for sports.

limitinteger nullable

Optional. The maximum number of records to return.

isFavoriteboolean nullable

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

isLikedboolean nullable

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

isDislikedboolean nullable

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

enableImagesboolean nullable

Optional. Include image information in output.

imageTypeLimitinteger nullable

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

enableImageTypesImageType[] nullable

"Optional. The image types to include in the output.

fieldsItemFields[] nullable

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

enableUserDataboolean nullable

Optional. Include user data.

sortBystring[] nullable

Optional. Key to sort by.

sortOrder'Ascending' | 'Descending'

An enum representing the sorting order.

Optional. Sort order.

enableFavoriteSortingboolean

Optional. Incorporate favorite and like status into channel sorting.

addCurrentProgramboolean

Optional. Adds current program info to each channel.

Response

Available live tv channels returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.

Changes

No recorded changes to this operation across all 1 revision of this API.