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

    Type Alias GetSubtitleData

    type GetSubtitleData = {
        body?: never;
        path: {
            routeItemId: string;
            routeMediaSourceId: string;
            routeIndex: number;
            routeFormat: string;
        };
        query?: {
            itemId?: string;
            mediaSourceId?: string;
            index?: number;
            format?: string;
            endPositionTicks?: number;
            copyTimestamps?: boolean;
            addVttTimeMap?: boolean;
            startPositionTicks?: number;
        };
        url: "/Videos/{routeItemId}/{routeMediaSourceId}/Subtitles/{routeIndex}/Stream.{routeFormat}";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: {
        routeItemId: string;
        routeMediaSourceId: string;
        routeIndex: number;
        routeFormat: string;
    }

    Type Declaration

    • routeItemId: string

      The (route) item id.

    • routeMediaSourceId: string

      The (route) media source id.

    • routeIndex: number

      The (route) subtitle stream index.

    • routeFormat: string

      The (route) format of the returned subtitle.

    query?: {
        itemId?: string;
        mediaSourceId?: string;
        index?: number;
        format?: string;
        endPositionTicks?: number;
        copyTimestamps?: boolean;
        addVttTimeMap?: boolean;
        startPositionTicks?: number;
    }

    Type Declaration

    • OptionalitemId?: string

      The item id.

    • OptionalmediaSourceId?: string

      The media source id.

    • Optionalindex?: number

      The subtitle stream index.

    • Optionalformat?: string

      The format of the returned subtitle.

    • OptionalendPositionTicks?: number

      Optional. The end position of the subtitle in ticks.

    • OptionalcopyTimestamps?: boolean

      Optional. Whether to copy the timestamps.

    • OptionaladdVttTimeMap?: boolean

      Optional. Whether to add a VTT time map.

    • OptionalstartPositionTicks?: number

      The start position of the subtitle in ticks.

    url: "/Videos/{routeItemId}/{routeMediaSourceId}/Subtitles/{routeIndex}/Stream.{routeFormat}"

    Settings
    Member Visibility

    On This Page
    Properties