@jellyfin/sdk
    Preparing search index...

    Interface LiveTvApiGetRecommendedProgramsRequest

    Request parameters for getRecommendedPrograms operation in LiveTvApi.

    interface LiveTvApiGetRecommendedProgramsRequest {
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableTotalRecordCount?: boolean;
        enableUserData?: boolean;
        fields?: ItemFields[];
        genreIds?: string[];
        hasAired?: boolean;
        imageTypeLimit?: number;
        isAiring?: boolean;
        isKids?: boolean;
        isMovie?: boolean;
        isNews?: boolean;
        isSeries?: boolean;
        isSports?: boolean;
        limit?: number;
        startIndex?: number;
        userId?: string;
    }
    Index

    Properties

    enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? fields? genreIds? hasAired? imageTypeLimit? isAiring? isKids? isMovie? isNews? isSeries? isSports? limit? startIndex? userId?

    Properties

    enableImages?: boolean

    Optional. Include image information in output.

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    enableTotalRecordCount?: boolean

    Retrieve total record count.

    enableUserData?: boolean

    Optional. include user data.

    fields?: ItemFields[]

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

    genreIds?: string[]

    The genres to return guide information for.

    hasAired?: boolean

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

    imageTypeLimit?: number

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

    isAiring?: boolean

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

    isKids?: boolean

    Optional. Filter for kids.

    isMovie?: boolean

    Optional. Filter for movies.

    isNews?: boolean

    Optional. Filter for news.

    isSeries?: boolean

    Optional. Filter for series.

    isSports?: boolean

    Optional. Filter for sports.

    limit?: number

    Optional. The maximum number of records to return.

    startIndex?: number

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

    userId?: string

    Optional. filter by user id.

    Settings

    Member Visibility

    On This Page

    Properties