@jellyfin/sdk
    Preparing search index...

    Interface LiveTvApiGetLiveTvChannelsRequest

    Request parameters for getLiveTvChannels operation in LiveTvApi.

    LiveTvApiGetLiveTvChannelsRequest

    interface LiveTvApiGetLiveTvChannelsRequest {
        addCurrentProgram?: boolean;
        enableFavoriteSorting?: boolean;
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
        fields?: ItemFields[];
        imageTypeLimit?: number;
        isDisliked?: boolean;
        isFavorite?: boolean;
        isKids?: boolean;
        isLiked?: boolean;
        isMovie?: boolean;
        isNews?: boolean;
        isSeries?: boolean;
        isSports?: boolean;
        limit?: number;
        sortBy?: ItemSortBy[];
        sortOrder?: SortOrder;
        startIndex?: number;
        type?: ChannelType;
        userId?: string;
    }
    Index

    Properties

    addCurrentProgram? enableFavoriteSorting? enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? isDisliked? isFavorite? isKids? isLiked? isMovie? isNews? isSeries? isSports? limit? sortBy? sortOrder? startIndex? type? userId?

    Properties

    addCurrentProgram?: boolean

    Optional. Adds current program info to each channel.

    LiveTvApiGetLiveTvChannels

    enableFavoriteSorting?: boolean

    Optional. Incorporate favorite and like status into channel sorting.

    LiveTvApiGetLiveTvChannels

    enableImages?: boolean

    Optional. Include image information in output.

    LiveTvApiGetLiveTvChannels

    enableImageTypes?: ImageType[]

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

    LiveTvApiGetLiveTvChannels

    enableUserData?: boolean

    Optional. Include user data.

    LiveTvApiGetLiveTvChannels

    fields?: ItemFields[]

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

    LiveTvApiGetLiveTvChannels

    imageTypeLimit?: number

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

    LiveTvApiGetLiveTvChannels

    isDisliked?: boolean

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

    LiveTvApiGetLiveTvChannels

    isFavorite?: boolean

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

    LiveTvApiGetLiveTvChannels

    isKids?: boolean

    Optional. Filter for kids.

    LiveTvApiGetLiveTvChannels

    isLiked?: boolean

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

    LiveTvApiGetLiveTvChannels

    isMovie?: boolean

    Optional. Filter for movies.

    LiveTvApiGetLiveTvChannels

    isNews?: boolean

    Optional. Filter for news.

    LiveTvApiGetLiveTvChannels

    isSeries?: boolean

    Optional. Filter for series.

    LiveTvApiGetLiveTvChannels

    isSports?: boolean

    Optional. Filter for sports.

    LiveTvApiGetLiveTvChannels

    limit?: number

    Optional. The maximum number of records to return.

    LiveTvApiGetLiveTvChannels

    sortBy?: ItemSortBy[]

    Optional. Key to sort by.

    LiveTvApiGetLiveTvChannels

    sortOrder?: SortOrder

    Optional. Sort order.

    LiveTvApiGetLiveTvChannels

    startIndex?: number

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

    LiveTvApiGetLiveTvChannels

    type?: ChannelType

    Optional. Filter by channel type.

    LiveTvApiGetLiveTvChannels

    userId?: string

    Optional. Filter by user and attach user data.

    LiveTvApiGetLiveTvChannels

    Settings

    Member Visibility

    On This Page

    Properties