@jellyfin/sdk
    Preparing search index...

    Interface SubtitleApiGetSubtitleRequest

    Request parameters for getSubtitle operation in SubtitleApi.

    SubtitleApiGetSubtitleRequest

    interface SubtitleApiGetSubtitleRequest {
        addVttTimeMap?: boolean;
        copyTimestamps?: boolean;
        endPositionTicks?: number;
        format?: string;
        index?: number;
        itemId?: string;
        mediaSourceId?: string;
        routeFormat: string;
        routeIndex: number;
        routeItemId: string;
        routeMediaSourceId: string;
        startPositionTicks?: number;
    }
    Index

    Properties

    addVttTimeMap? copyTimestamps? endPositionTicks? format? index? itemId? mediaSourceId? routeFormat routeIndex routeItemId routeMediaSourceId startPositionTicks?

    Properties

    addVttTimeMap?: boolean

    Optional. Whether to add a VTT time map.

    SubtitleApiGetSubtitle

    copyTimestamps?: boolean

    Optional. Whether to copy the timestamps.

    SubtitleApiGetSubtitle

    endPositionTicks?: number

    Optional. The end position of the subtitle in ticks.

    SubtitleApiGetSubtitle

    format?: string

    The format of the returned subtitle.

    SubtitleApiGetSubtitle

    index?: number

    The subtitle stream index.

    SubtitleApiGetSubtitle

    itemId?: string

    The item id.

    SubtitleApiGetSubtitle

    mediaSourceId?: string

    The media source id.

    SubtitleApiGetSubtitle

    routeFormat: string

    The (route) format of the returned subtitle.

    SubtitleApiGetSubtitle

    routeIndex: number

    The (route) subtitle stream index.

    SubtitleApiGetSubtitle

    routeItemId: string

    The (route) item id.

    SubtitleApiGetSubtitle

    routeMediaSourceId: string

    The (route) media source id.

    SubtitleApiGetSubtitle

    startPositionTicks?: number

    The start position of the subtitle in ticks.

    SubtitleApiGetSubtitle

    Settings

    Member Visibility

    On This Page

    Properties