Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias GetRecordingsData

    type GetRecordingsData = {
        body?: never;
        path?: never;
        query?: {
            channelId?: string;
            userId?: string;
            startIndex?: number;
            limit?: number;
            status?:
                | "New"
                | "InProgress"
                | "Completed"
                | "Cancelled"
                | "ConflictedOk"
                | "ConflictedNotOk"
                | "Error";
            isInProgress?: boolean;
            seriesTimerId?: string;
            enableImages?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            fields?: ItemFields[];
            enableUserData?: boolean;
            isMovie?: boolean;
            isSeries?: boolean;
            isKids?: boolean;
            isSports?: boolean;
            isNews?: boolean;
            isLibraryItem?: boolean;
            enableTotalRecordCount?: boolean;
        };
        url: "/LiveTv/Recordings";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        channelId?: string;
        userId?: string;
        startIndex?: number;
        limit?: number;
        status?:
            | "New"
            | "InProgress"
            | "Completed"
            | "Cancelled"
            | "ConflictedOk"
            | "ConflictedNotOk"
            | "Error";
        isInProgress?: boolean;
        seriesTimerId?: string;
        enableImages?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
        fields?: ItemFields[];
        enableUserData?: boolean;
        isMovie?: boolean;
        isSeries?: boolean;
        isKids?: boolean;
        isSports?: boolean;
        isNews?: boolean;
        isLibraryItem?: boolean;
        enableTotalRecordCount?: boolean;
    }

    Type Declaration

    • OptionalchannelId?: string

      Optional. Filter by channel id.

    • OptionaluserId?: string

      Optional. Filter by user and attach user data.

    • OptionalstartIndex?: number

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

    • Optionallimit?: number

      Optional. The maximum number of records to return.

    • Optionalstatus?:
          | "New"
          | "InProgress"
          | "Completed"
          | "Cancelled"
          | "ConflictedOk"
          | "ConflictedNotOk"
          | "Error"

      Optional. Filter by recording status.

    • OptionalisInProgress?: boolean

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

    • OptionalseriesTimerId?: string

      Optional. Filter by recordings belonging to a series timer.

    • OptionalenableImages?: boolean

      Optional. Include image information in output.

    • OptionalimageTypeLimit?: number

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

    • OptionalenableImageTypes?: ImageType[]

      Optional. The image types to include in the output.

    • Optionalfields?: ItemFields[]

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

    • OptionalenableUserData?: boolean

      Optional. Include user data.

    • OptionalisMovie?: boolean

      Optional. Filter for movies.

    • OptionalisSeries?: boolean

      Optional. Filter for series.

    • OptionalisKids?: boolean

      Optional. Filter for kids.

    • OptionalisSports?: boolean

      Optional. Filter for sports.

    • OptionalisNews?: boolean

      Optional. Filter for news.

    • OptionalisLibraryItem?: boolean

      Optional. Filter for is library item.

    • OptionalenableTotalRecordCount?: boolean

      Optional. Return total record count.

    url: "/LiveTv/Recordings"

    Settings
    Member Visibility

    On This Page
    Properties