Interface SubtitleApiGetSubtitleRequest

Request parameters for getSubtitle operation in SubtitleApi.

Export

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;
}

Properties

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

Properties

Optional ReadonlyaddVttTimeMap

addVttTimeMap?: boolean

Optional. Whether to add a VTT time map.

Memberof

SubtitleApiGetSubtitle

Optional ReadonlycopyTimestamps

copyTimestamps?: boolean

Optional. Whether to copy the timestamps.

Memberof

SubtitleApiGetSubtitle

Optional ReadonlyendPositionTicks

endPositionTicks?: number

Optional. The end position of the subtitle in ticks.

Memberof

SubtitleApiGetSubtitle

Optional Readonlyformat

format?: string

The format of the returned subtitle.

Memberof

SubtitleApiGetSubtitle

Optional Readonlyindex

index?: number

The subtitle stream index.

Memberof

SubtitleApiGetSubtitle

Optional ReadonlyitemId

itemId?: string

The item id.

Memberof

SubtitleApiGetSubtitle

Optional ReadonlymediaSourceId

mediaSourceId?: string

The media source id.

Memberof

SubtitleApiGetSubtitle

ReadonlyrouteFormat

routeFormat: string

The (route) format of the returned subtitle.

Memberof

SubtitleApiGetSubtitle

ReadonlyrouteIndex

routeIndex: number

The (route) subtitle stream index.

Memberof

SubtitleApiGetSubtitle

ReadonlyrouteItemId

routeItemId: string

The (route) item id.

Memberof

SubtitleApiGetSubtitle

ReadonlyrouteMediaSourceId

routeMediaSourceId: string

The (route) media source id.

Memberof

SubtitleApiGetSubtitle

Optional ReadonlystartPositionTicks

startPositionTicks?: number

The start position of the subtitle in ticks.

Memberof

SubtitleApiGetSubtitle

Settings

Member Visibility

On This Page

Properties