jellyfin-api/org.jellyfin.sdk.api.operations/SubtitleApi

SubtitleApi

class SubtitleApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun deleteSubtitle(itemId: UUID, index: Int): Response<Unit>

Deletes an external subtitle file.

Link copied to clipboard
suspend fun downloadRemoteSubtitles(itemId: UUID, subtitleId: String): Response<Unit>

Downloads a remote subtitle.

Link copied to clipboard
suspend fun getFallbackFont(name: String): Response<ByteArray>

Gets a fallback font file.

Link copied to clipboard
suspend fun getFallbackFontList(): Response<List<FontFile>>

Gets a list of available fallback font files.

Link copied to clipboard
fun getFallbackFontUrl(name: String): String

Gets a fallback font file.

Link copied to clipboard
suspend fun getRemoteSubtitles(subtitleId: String): Response<String>

Gets the remote subtitles.

Link copied to clipboard
suspend fun getSubtitle(request: GetSubtitleRequest): Response<String>
suspend fun getSubtitle(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeFormat: String, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false, startPositionTicks: Long? = 0): Response<String>

Gets subtitles in a specified format.

Link copied to clipboard
suspend fun getSubtitleDeprecated(request: GetSubtitleDeprecatedRequest): Response<String>
suspend fun getSubtitleDeprecated(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeFormat: String, itemId: UUID? = null, mediaSourceId: String? = null, index: Int? = null, format: String? = null, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false, startPositionTicks: Long? = 0): Response<String>

Gets subtitles in a specified format.

Link copied to clipboard
fun getSubtitleDeprecatedUrl(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeFormat: String, itemId: UUID? = null, mediaSourceId: String? = null, index: Int? = null, format: String? = null, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false, startPositionTicks: Long? = 0): String

Gets subtitles in a specified format.

Link copied to clipboard
suspend fun getSubtitlePlaylist(itemId: UUID, index: Int, mediaSourceId: String, segmentLength: Int): Response<ByteArray>

Gets an HLS subtitle playlist.

Link copied to clipboard
fun getSubtitlePlaylistUrl(itemId: UUID, index: Int, mediaSourceId: String, segmentLength: Int): String

Gets an HLS subtitle playlist.

Link copied to clipboard
fun getSubtitleUrl(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeFormat: String, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false, startPositionTicks: Long? = 0): String

Gets subtitles in a specified format.

Link copied to clipboard
suspend fun getSubtitleWithTicks(request: GetSubtitleWithTicksRequest): Response<String>
suspend fun getSubtitleWithTicks(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeStartPositionTicks: Long, routeFormat: String, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false): Response<String>

Gets subtitles in a specified format.

Link copied to clipboard
suspend fun getSubtitleWithTicksDeprecated(request: GetSubtitleWithTicksDeprecatedRequest): Response<String>
suspend fun getSubtitleWithTicksDeprecated(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeStartPositionTicks: Long, routeFormat: String, itemId: UUID? = null, mediaSourceId: String? = null, index: Int? = null, startPositionTicks: Long? = null, format: String? = null, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false): Response<String>

Gets subtitles in a specified format.

Link copied to clipboard
fun getSubtitleWithTicksDeprecatedUrl(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeStartPositionTicks: Long, routeFormat: String, itemId: UUID? = null, mediaSourceId: String? = null, index: Int? = null, startPositionTicks: Long? = null, format: String? = null, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false): String

Gets subtitles in a specified format.

Link copied to clipboard
fun getSubtitleWithTicksUrl(routeItemId: UUID, routeMediaSourceId: String, routeIndex: Int, routeStartPositionTicks: Long, routeFormat: String, endPositionTicks: Long? = null, copyTimestamps: Boolean? = false, addVttTimeMap: Boolean? = false): String

Gets subtitles in a specified format.

Link copied to clipboard
suspend fun searchRemoteSubtitles(itemId: UUID, language: String, isPerfectMatch: Boolean? = null): Response<List<RemoteSubtitleInfo>>

Search remote subtitles.

Link copied to clipboard
suspend fun uploadSubtitle(itemId: UUID, data: UploadSubtitleDto): Response<Unit>

Upload an external subtitle file.

Generated by Dokka
© 2026 Copyright