@jellyfin/sdk
    Preparing search index...

    Interface LiveTvApiGetLiveTvProgramsRequest

    Request parameters for getLiveTvPrograms operation in LiveTvApi.

    LiveTvApiGetLiveTvProgramsRequest

    interface LiveTvApiGetLiveTvProgramsRequest {
        channelIds?: string[];
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableTotalRecordCount?: boolean;
        enableUserData?: boolean;
        fields?: ItemFields[];
        genreIds?: string[];
        genres?: string[];
        hasAired?: boolean;
        imageTypeLimit?: number;
        isAiring?: boolean;
        isKids?: boolean;
        isMovie?: boolean;
        isNews?: boolean;
        isSeries?: boolean;
        isSports?: boolean;
        librarySeriesId?: string;
        limit?: number;
        maxEndDate?: string;
        maxStartDate?: string;
        minEndDate?: string;
        minStartDate?: string;
        seriesTimerId?: string;
        sortBy?: ItemSortBy[];
        sortOrder?: SortOrder[];
        startIndex?: number;
        userId?: string;
    }
    Index

    Properties

    channelIds? enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? fields? genreIds? genres? hasAired? imageTypeLimit? isAiring? isKids? isMovie? isNews? isSeries? isSports? librarySeriesId? limit? maxEndDate? maxStartDate? minEndDate? minStartDate? seriesTimerId? sortBy? sortOrder? startIndex? userId?

    Properties

    channelIds?: string[]

    The channels to return guide information for.

    LiveTvApiGetLiveTvPrograms

    enableImages?: boolean

    Optional. Include image information in output.

    LiveTvApiGetLiveTvPrograms

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    LiveTvApiGetLiveTvPrograms

    enableTotalRecordCount?: boolean

    Retrieve total record count.

    LiveTvApiGetLiveTvPrograms

    enableUserData?: boolean

    Optional. Include user data.

    LiveTvApiGetLiveTvPrograms

    fields?: ItemFields[]

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

    LiveTvApiGetLiveTvPrograms

    genreIds?: string[]

    The genre ids to return guide information for.

    LiveTvApiGetLiveTvPrograms

    genres?: string[]

    The genres to return guide information for.

    LiveTvApiGetLiveTvPrograms

    hasAired?: boolean

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

    LiveTvApiGetLiveTvPrograms

    imageTypeLimit?: number

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

    LiveTvApiGetLiveTvPrograms

    isAiring?: boolean

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

    LiveTvApiGetLiveTvPrograms

    isKids?: boolean

    Optional. Filter for kids.

    LiveTvApiGetLiveTvPrograms

    isMovie?: boolean

    Optional. Filter for movies.

    LiveTvApiGetLiveTvPrograms

    isNews?: boolean

    Optional. Filter for news.

    LiveTvApiGetLiveTvPrograms

    isSeries?: boolean

    Optional. Filter for series.

    LiveTvApiGetLiveTvPrograms

    isSports?: boolean

    Optional. Filter for sports.

    LiveTvApiGetLiveTvPrograms

    librarySeriesId?: string

    Optional. Filter by library series id.

    LiveTvApiGetLiveTvPrograms

    limit?: number

    Optional. The maximum number of records to return.

    LiveTvApiGetLiveTvPrograms

    maxEndDate?: string

    Optional. The maximum premiere end date.

    LiveTvApiGetLiveTvPrograms

    maxStartDate?: string

    Optional. The maximum premiere start date.

    LiveTvApiGetLiveTvPrograms

    minEndDate?: string

    Optional. The minimum premiere end date.

    LiveTvApiGetLiveTvPrograms

    minStartDate?: string

    Optional. The minimum premiere start date.

    LiveTvApiGetLiveTvPrograms

    seriesTimerId?: string

    Optional. Filter by series timer id.

    LiveTvApiGetLiveTvPrograms

    sortBy?: ItemSortBy[]

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

    LiveTvApiGetLiveTvPrograms

    sortOrder?: SortOrder[]

    Sort Order - Ascending,Descending.

    LiveTvApiGetLiveTvPrograms

    startIndex?: number

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

    LiveTvApiGetLiveTvPrograms

    userId?: string

    Optional. Filter by user id.

    LiveTvApiGetLiveTvPrograms

    Settings

    Member Visibility

    On This Page

    Properties