v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Subtitle

Gets subtitles in a specified format.

get/Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/{startPositionTicks}/Stream.{format}

Path parameters

itemIdstring uuid required

The item id.

The item id.

mediaSourceIdstring required

The media source id.

The media source id.

indexinteger required

The subtitle stream index.

The subtitle stream index.

startPositionTicksinteger required

Optional. The start position of the subtitle in ticks.

Optional. The start position of the subtitle in ticks.

formatstring required

The format of the returned subtitle.

The format of the returned subtitle.

Query parameters

endPositionTicksinteger nullable

Optional. The end position of the subtitle in ticks.

Optional. The end position of the subtitle in ticks.

copyTimestampsboolean

Optional. Whether to copy the timestamps.

Optional. Whether to copy the timestamps.

addVttTimeMapboolean

Optional. Whether to add a VTT time map.

Optional. Whether to add a VTT time map.

Response

File returned.