@jellyfin/sdk
    Preparing search index...

    Interface LiveTvApiGetRecordingsRequest

    Request parameters for getRecordings operation in LiveTvApi.

    LiveTvApiGetRecordingsRequest

    interface LiveTvApiGetRecordingsRequest {
        channelId?: string;
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableTotalRecordCount?: boolean;
        enableUserData?: boolean;
        fields?: ItemFields[];
        imageTypeLimit?: number;
        isInProgress?: boolean;
        isKids?: boolean;
        isLibraryItem?: boolean;
        isMovie?: boolean;
        isNews?: boolean;
        isSeries?: boolean;
        isSports?: boolean;
        limit?: number;
        seriesTimerId?: string;
        startIndex?: number;
        status?: RecordingStatus;
        userId?: string;
    }
    Index

    Properties

    channelId? enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? fields? imageTypeLimit? isInProgress? isKids? isLibraryItem? isMovie? isNews? isSeries? isSports? limit? seriesTimerId? startIndex? status? userId?

    Properties

    channelId?: string

    Optional. Filter by channel id.

    LiveTvApiGetRecordings

    enableImages?: boolean

    Optional. Include image information in output.

    LiveTvApiGetRecordings

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    LiveTvApiGetRecordings

    enableTotalRecordCount?: boolean

    Optional. Return total record count.

    LiveTvApiGetRecordings

    enableUserData?: boolean

    Optional. Include user data.

    LiveTvApiGetRecordings

    fields?: ItemFields[]

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

    LiveTvApiGetRecordings

    imageTypeLimit?: number

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

    LiveTvApiGetRecordings

    isInProgress?: boolean

    Optional. Filter by recordings that are in progress, or not.

    LiveTvApiGetRecordings

    isKids?: boolean

    Optional. Filter for kids.

    LiveTvApiGetRecordings

    isLibraryItem?: boolean

    Optional. Filter for is library item.

    LiveTvApiGetRecordings

    isMovie?: boolean

    Optional. Filter for movies.

    LiveTvApiGetRecordings

    isNews?: boolean

    Optional. Filter for news.

    LiveTvApiGetRecordings

    isSeries?: boolean

    Optional. Filter for series.

    LiveTvApiGetRecordings

    isSports?: boolean

    Optional. Filter for sports.

    LiveTvApiGetRecordings

    limit?: number

    Optional. The maximum number of records to return.

    LiveTvApiGetRecordings

    seriesTimerId?: string

    Optional. Filter by recordings belonging to a series timer.

    LiveTvApiGetRecordings

    startIndex?: number

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

    LiveTvApiGetRecordings

    status?: RecordingStatus

    Optional. Filter by recording status.

    LiveTvApiGetRecordings

    userId?: string

    Optional. Filter by user and attach user data.

    LiveTvApiGetRecordings

    Settings

    Member Visibility

    On This Page

    Properties