jellyfin-model/org.jellyfin.sdk.model.api.request/GetSubtitleWithTicksRequest

GetSubtitleWithTicksRequest

@Serializable

data class GetSubtitleWithTicksRequest(val routeItemId: UUID, val routeMediaSourceId: String, val routeIndex: Int, val routeStartPositionTicks: Long, val routeFormat: String, val endPositionTicks: Long? = null, val copyTimestamps: Boolean? = false, val addVttTimeMap: Boolean? = false)

Subtitles in a specified format.

Constructors

GetSubtitleWithTicksRequest

constructor(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeStartPositionTicks: Long, routeFormat: String, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false)

Properties

@SerialName(value = "addVttTimeMap")

val addVttTimeMap: Boolean?

Optional. Whether to add a VTT time map.

@SerialName(value = "copyTimestamps")

val copyTimestamps: Boolean?

Optional. Whether to copy the timestamps.

endPositionTicks

@SerialName(value = "endPositionTicks")

val endPositionTicks: Long?

Optional. The end position of the subtitle in ticks.

@SerialName(value = "routeFormat")

val routeFormat: String

The (route) format of the returned subtitle.

@SerialName(value = "routeIndex")

val routeIndex: Int

The (route) subtitle stream index.

@SerialName(value = "routeItemId")

val routeItemId: UUID

The (route) item id.

routeMediaSourceId

@SerialName(value = "routeMediaSourceId")

val routeMediaSourceId: String

The (route) media source id.

routeStartPositionTicks

@SerialName(value = "routeStartPositionTicks")

val routeStartPositionTicks: Long

The (route) start position of the subtitle in ticks.