Class VOTWorkerClient<V>

Type Parameters

V extends string = VideoService

Hierarchy (View Summary)

VOTClient<V>
- VOTWorkerClient
  - VOTWorkerClient

Constructors

constructor

new VOTWorkerClient<V extends string = VideoService>(
opts?: VOTOpts,
): VOTWorkerClient<V>
Type Parameters
- V extends string = VideoService
Parameters
- Optionalopts: VOTOpts
Returns VOTWorkerClient<V>
Overrides VOTClient.constructor
- Defined in packages/core/dist/client.d.ts:66

Properties

apiToken

apiToken: string | undefined

fetch

fetch: FetchFunction

fetchOpts

fetchOpts: Record<string, unknown>

headers

headers: Record<string, string>

headersVOT

headersVOT: Record<string, string>

host

host: string

hostSchemaRe

hostSchemaRe: RegExp

hostVOT

hostVOT: string

paths

paths: {
    streamPing: string;
    streamTranslation: string;
    videoSubtitles: string;
    videoTranslation: string;
    videoTranslationAudio: string;
    videoTranslationCache: string;
    videoTranslationFailAudio: string;
}

requestLang

requestLang:
    | "en"
    | "auto"
    | "ru"
    | "zh"
    | "ko"
    | "lt"
    | "lv"
    | "ar"
    | "fr"
    | "it"
    | "es"
    | "de"
    | "ja"

responseLang

responseLang: "en" | "ru" | "kk"

schema

schema: URLSchema

schemaVOT

schemaVOT: URLSchema

sessions

sessions: VOTSessions

userAgent

userAgent: string

Accessors

`Protected`apiTokenHeader

get apiTokenHeader(): Record<string, string>
Returns Record<string, string>
Inherited from VOTClient.apiTokenHeader
- Defined in packages/core/dist/client.d.ts:50

Methods

createSession

createSession(
module: SessionModule,
): Promise<{ expires: number; secretKey: string; uuid: string }>
Parameters
- module: SessionModule
Returns Promise<{ expires: number; secretKey: string; uuid: string }>
Inherited from VOTClient.createSession
- Defined in packages/core/dist/client.d.ts:26

getOpts

getOpts(
    body: unknown,
    headers?: Record<string, string>,
    method?: string,
): RequestInit
Parameters
- body: unknown
- Optionalheaders: Record<string, string>
- Optionalmethod: string
Returns RequestInit
Inherited from VOTClient.getOpts
- Defined in packages/core/dist/client.d.ts:24

getSession

getSession(module: SessionModule): Promise<ClientSession>
Parameters
- module: SessionModule
Returns Promise<ClientSession>
Inherited from VOTClient.getSession
- Defined in packages/core/dist/client.d.ts:25

getSubtitles

getSubtitles(
__namedParameters: VideoSubtitlesOpts<V>,
): Promise<GetSubtitlesResponse>
Parameters
- __namedParameters: VideoSubtitlesOpts<V>
Returns Promise<GetSubtitlesResponse>
Inherited from VOTClient.getSubtitles
- Defined in packages/core/dist/client.d.ts:61

`Protected`getSubtitlesVOTImpl

getSubtitlesVOTImpl(
__namedParameters: GetSubtitlesVOTOpts<V>,
): Promise<GetSubtitlesResponse>
Parameters
- __namedParameters: GetSubtitlesVOTOpts<V>
Returns Promise<GetSubtitlesResponse>
Inherited from VOTClient.getSubtitlesVOTImpl
- Defined in packages/core/dist/client.d.ts:60

`Protected`getSubtitlesYAImpl

getSubtitlesYAImpl(
__namedParameters: VideoSubtitlesOpts<V>,
): Promise<GetSubtitlesResponse>
Parameters
- __namedParameters: VideoSubtitlesOpts<V>
Returns Promise<GetSubtitlesResponse>
Inherited from VOTClient.getSubtitlesYAImpl
- Defined in packages/core/dist/client.d.ts:59

isCustomLink

isCustomLink(url: string): boolean
Parameters
- url: string
Returns boolean
Inherited from VOTClient.isCustomLink
- Defined in packages/core/dist/client.d.ts:47

pingStream

pingStream(__namedParameters: StreamPingOptions): Promise<boolean>
Parameters
- __namedParameters: StreamPingOptions
Returns Promise<boolean>
Inherited from VOTClient.pingStream
- Defined in packages/core/dist/client.d.ts:62

request

request<T = ArrayBuffer>(
    path: string,
    body: Uint8Array,
    headers?: Record<string, string>,
    method?: string,
): Promise<ClientResponse<T>>
Type Parameters
- T = ArrayBuffer
Parameters
- path: string
- body: Uint8Array
- Optionalheaders: Record<string, string>
- Optionalmethod: string
Returns Promise<ClientResponse<T>>
Overrides VOTClient.request
- Defined in packages/core/dist/client.d.ts:67

requestJSON

requestJSON<T = unknown>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
    method?: string,
): Promise<ClientResponse<T>>
Type Parameters
- T = unknown
Parameters
- path: string
- Optionalbody: unknown
- Optionalheaders: Record<string, string>
- Optionalmethod: string
Returns Promise<ClientResponse<T>>
Overrides VOTClient.requestJSON
- Defined in packages/core/dist/client.d.ts:68

requestVOT

requestVOT<T = unknown>(
    path: string,
    body: Record<string, unknown>,
    headers?: Record<string, string>,
): Promise<ClientResponse<T>>
Type Parameters
- T = unknown
Parameters
- path: string
- body: Record<string, unknown>
- Optionalheaders: Record<string, string>
Returns Promise<ClientResponse<T>>
Inherited from VOTClient.requestVOT
- Defined in packages/core/dist/client.d.ts:51

requestVtransAudio

requestVtransAudio(
    url: string,
    translationId: string,
    audioBuffer: AudioBufferObject,
    partialAudio?: undefined,
    headers?: Record<string, string>,
): Promise<VideoTranslationAudioResponse>
Parameters
- url: string
- translationId: string
- audioBuffer: AudioBufferObject
- OptionalpartialAudio: undefined
- Optionalheaders: Record<string, string>
Returns Promise<VideoTranslationAudioResponse>
Inherited from VOTClient.requestVtransAudio
- Defined in packages/core/dist/client.d.ts:55
requestVtransAudio(
    url: string,
    translationId: string,
    audioBuffer: PartialAudioBufferObject,
    partialAudio: PartialAudioObject,
    headers?: Record<string, string>,
): Promise<VideoTranslationAudioResponse>
Parameters
- url: string
- translationId: string
- audioBuffer: PartialAudioBufferObject
- partialAudio: PartialAudioObject
- Optionalheaders: Record<string, string>
Returns Promise<VideoTranslationAudioResponse>
Inherited from VOTClient.requestVtransAudio
- Defined in packages/core/dist/client.d.ts:56

requestVtransFailAudio

requestVtransFailAudio(
url: string,
): Promise<ClientResponse<VideoTranslationFailAudioResponse>>
Parameters
- url: string
Returns Promise<ClientResponse<VideoTranslationFailAudioResponse>>
Inherited from VOTClient.requestVtransFailAudio
- Defined in packages/core/dist/client.d.ts:54

translateStream

translateStream(
__namedParameters: StreamTranslationOpts<V>,
): Promise<StreamTranslationResponse>
Parameters
- __namedParameters: StreamTranslationOpts<V>
Returns Promise<StreamTranslationResponse>
Inherited from VOTClient.translateStream
- Defined in packages/core/dist/client.d.ts:63

translateVideo

translateVideo(
__namedParameters: VideoTranslationOpts<V>,
): Promise<VideoTranslationResponse>
Parameters
- __namedParameters: VideoTranslationOpts<V>
Returns Promise<VideoTranslationResponse>
Inherited from VOTClient.translateVideo
- Defined in packages/core/dist/client.d.ts:58

translateVideoCache

translateVideoCache(
__namedParameters: VideoTranslationCacheOpts<V>,
): Promise<VideoTranslationCacheResponse>
Parameters
- __namedParameters: VideoTranslationCacheOpts<V>
Returns Promise<VideoTranslationCacheResponse>
Inherited from VOTClient.translateVideoCache
- Defined in packages/core/dist/client.d.ts:57

`Protected`translateVideoVOTImpl

translateVideoVOTImpl(
__namedParameters: VideoTranslationVOTOpts<V>,
): Promise<VideoTranslationResponse>
Parameters
- __namedParameters: VideoTranslationVOTOpts<V>
Returns Promise<VideoTranslationResponse>
Inherited from VOTClient.translateVideoVOTImpl
- Defined in packages/core/dist/client.d.ts:53

`Protected`translateVideoYAImpl

translateVideoYAImpl(
__namedParameters: VideoTranslationOpts<V>,
): Promise<VideoTranslationResponse>
Parameters
- __namedParameters: VideoTranslationOpts<V>
Returns Promise<VideoTranslationResponse>
Inherited from VOTClient.translateVideoYAImpl
- Defined in packages/core/dist/client.d.ts:52

Class VOTWorkerClient<V>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VOTWorkerClient<V>

Properties

apiToken

fetch

fetchOpts

headers

headersVOT

host

hostSchemaRe

hostVOT

paths

requestLang

responseLang

schema

schemaVOT

sessions

userAgent

Accessors

ProtectedapiTokenHeader

Returns Record<string, string>

Methods

createSession

Parameters

Returns Promise<{ expires: number; secretKey: string; uuid: string }>

getOpts

Parameters

Returns RequestInit

getSession

Parameters

Returns Promise<ClientSession>

getSubtitles

Parameters

Returns Promise<GetSubtitlesResponse>

ProtectedgetSubtitlesVOTImpl

Parameters

Returns Promise<GetSubtitlesResponse>

ProtectedgetSubtitlesYAImpl

Parameters

Returns Promise<GetSubtitlesResponse>

isCustomLink

Parameters

Returns boolean

pingStream

Parameters

Returns Promise<boolean>

request

Type Parameters

Parameters

Returns Promise<ClientResponse<T>>

requestJSON

Type Parameters

Parameters

Returns Promise<ClientResponse<T>>

requestVOT

Type Parameters

Parameters

Returns Promise<ClientResponse<T>>

requestVtransAudio

Parameters

Returns Promise<VideoTranslationAudioResponse>

Parameters

Returns Promise<VideoTranslationAudioResponse>

requestVtransFailAudio

Parameters

Returns Promise<ClientResponse<VideoTranslationFailAudioResponse>>

translateStream

Parameters

Returns Promise<StreamTranslationResponse>

`Protected`apiTokenHeader

`Protected`getSubtitlesVOTImpl

`Protected`getSubtitlesYAImpl

`Protected`translateVideoVOTImpl

`Protected`translateVideoYAImpl