Class SubtitleApi

SubtitleApi - object-oriented interface

Hierarchy

BaseAPI
- SubtitleApi

Index

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

deleteSubtitle

deleteSubtitle(
requestParameters: SubtitleApiDeleteSubtitleRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SubtitleApiDeleteSubtitleRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/subtitle-api.ts:1077

downloadRemoteSubtitles

downloadRemoteSubtitles(
requestParameters: SubtitleApiDownloadRemoteSubtitlesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SubtitleApiDownloadRemoteSubtitlesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/subtitle-api.ts:1088

getFallbackFont

getFallbackFont(
requestParameters: SubtitleApiGetFallbackFontRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: SubtitleApiGetFallbackFontRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/subtitle-api.ts:1099

getFallbackFontList

getFallbackFontList(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FontFile[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FontFile[], any, {}>>

Throws
- Defined in generated-client/api/subtitle-api.ts:1109

getRemoteSubtitles

getRemoteSubtitles(
requestParameters: SubtitleApiGetRemoteSubtitlesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: SubtitleApiGetRemoteSubtitlesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/subtitle-api.ts:1120

getSubtitle

getSubtitle(
requestParameters: SubtitleApiGetSubtitleRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: SubtitleApiGetSubtitleRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/subtitle-api.ts:1131

getSubtitlePlaylist

getSubtitlePlaylist(
requestParameters: SubtitleApiGetSubtitlePlaylistRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: SubtitleApiGetSubtitlePlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/subtitle-api.ts:1142

getSubtitleWithTicks

getSubtitleWithTicks(
requestParameters: SubtitleApiGetSubtitleWithTicksRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: SubtitleApiGetSubtitleWithTicksRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/subtitle-api.ts:1153

searchRemoteSubtitles

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

Throws
- Defined in generated-client/api/subtitle-api.ts:1164

uploadSubtitle

uploadSubtitle(
requestParameters: SubtitleApiUploadSubtitleRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SubtitleApiUploadSubtitleRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/subtitle-api.ts:1175

Class SubtitleApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SubtitleApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

deleteSubtitle

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

downloadRemoteSubtitles

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

getFallbackFont

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

getFallbackFontList

Parameters

Returns Promise<AxiosResponse<FontFile[], any, {}>>

Throws

getRemoteSubtitles

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

getSubtitle

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

getSubtitlePlaylist

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

getSubtitleWithTicks

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

searchRemoteSubtitles

Parameters

Returns Promise<AxiosResponse<RemoteSubtitleInfo[], any, {}>>

Throws

uploadSubtitle

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration