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

SubtitleApi

class SubtitleApi(api: ApiClient) : Api
Content copied to clipboard

Constructors

Link copied to clipboard
fun SubtitleApi(api: ApiClient)
Content copied to clipboard

Functions

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

Deletes an external subtitle file.

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

Downloads a remote subtitle.

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

Gets a fallback font file.

Link copied to clipboard
suspend fun getFallbackFontList(): Response<List<<ERROR CLASS>>>
Content copied to clipboard

Gets a list of available fallback font files.

Link copied to clipboard
fun getFallbackFontUrl(name: String, includeCredentials: Boolean = true): String
Content copied to clipboard

Gets a fallback font file.

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

Gets the remote subtitles.

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

Gets subtitles in a specified format.

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

Gets subtitles in a specified format.

Link copied to clipboard
suspend fun getSubtitlePlaylist(    itemId: <ERROR CLASS>,     index: Int,     mediaSourceId: String,     segmentLength: Int): Response<ByteReadChannel>
Content copied to clipboard

Gets an HLS subtitle playlist.

Link copied to clipboard
fun getSubtitlePlaylistUrl(    itemId: <ERROR CLASS>,     index: Int,     mediaSourceId: String,     segmentLength: Int,     includeCredentials: Boolean = true): String
Content copied to clipboard

Gets an HLS subtitle playlist.

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

Gets subtitles in a specified format.

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

Gets subtitles in a specified format.

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

Search remote subtitles.

Link copied to clipboard
suspend fun uploadSubtitle(itemId: <ERROR CLASS>, data: <ERROR CLASS>): Response<Unit>
Content copied to clipboard

Upload an external subtitle file.