Class SubtitleApi

SubtitleApi - object-oriented interface

Export

SubtitleApi

Hierarchy

BaseAPI
- SubtitleApi

Index

Constructors

Properties

axios basePath configuration

Methods

deleteSubtitle downloadRemoteSubtitles getFallbackFont getFallbackFontList getRemoteSubtitles getSubtitle getSubtitlePlaylist getSubtitleWithTicks searchRemoteSubtitles uploadSubtitle

Constructors

constructor

new SubtitleApi(configuration?, basePath?, axios?): SubtitleApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SubtitleApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

deleteSubtitle

deleteSubtitle(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SubtitleApiDeleteSubtitleRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Deletes an external subtitle file.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1183

downloadRemoteSubtitles

downloadRemoteSubtitles(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SubtitleApiDownloadRemoteSubtitlesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Downloads a remote subtitle.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1195

getFallbackFont

getFallbackFont(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: SubtitleApiGetFallbackFontRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a fallback font file.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1207

getFallbackFontList

getFallbackFontList(options?): Promise<AxiosResponse<FontFile[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FontFile[], any>>
Summary
Gets a list of available fallback font files.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1218

getRemoteSubtitles

getRemoteSubtitles(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: SubtitleApiGetRemoteSubtitlesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets the remote subtitles.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1230

getSubtitle

getSubtitle(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: SubtitleApiGetSubtitleRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets subtitles in a specified format.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1242

getSubtitlePlaylist

getSubtitlePlaylist(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: SubtitleApiGetSubtitlePlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets an HLS subtitle playlist.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1254

getSubtitleWithTicks

getSubtitleWithTicks(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: SubtitleApiGetSubtitleWithTicksRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets subtitles in a specified format.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1266

searchRemoteSubtitles

searchRemoteSubtitles(requestParameters, options?): Promise<AxiosResponse<RemoteSubtitleInfo[], any>>
Parameters
- requestParameters: SubtitleApiSearchRemoteSubtitlesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSubtitleInfo[], any>>
Summary
Search remote subtitles.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1278

uploadSubtitle

uploadSubtitle(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SubtitleApiUploadSubtitleRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Upload an external subtitle file.

Throws
Memberof
SubtitleApi
- Defined in generated-client/api/subtitle-api.ts:1290