Class VOTClient<V>

apiToken

fetch

import { ofetch } from "ofetch";

import VOTClient from "../packages/node/dist/client";
import { getVideoData } from "../packages/node/dist/utils/videoData";

// https://github.com/unjs/ofetch
const client = new VOTClient({
  fetchFn: ofetch.native,
});

const videoData = await getVideoData("https://youtu.be/LK6nLR1bzpI", {
  fetchFn: ofetch.native,
});
Copy

fetchOpts

headers

headersVOT

host

hostSchemaRe

hostVOT

paths

requestLang

responseLang

schema

schemaVOT

sessions

userAgent

createSession

• createSession(
      module: SessionModule,
  ): Promise<{ expires: number; secretKey: string; uuid: string }>

  Parameters

  • module: SessionModule

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

getOpts

• getOpts(
      body: unknown,
      headers?: Record<string, string>,
      method?: string,
  ): { body: unknown; headers: { [x: string]: string }; method: string }

  Parameters

  • body: unknown
  • Optionalheaders: Record<string, string>
  • Optionalmethod: string

  Returns { body: unknown; headers: { [x: string]: string }; method: string }

getSession

• getSession(module: SessionModule): Promise<ClientSession>

  Parameters

  • module: SessionModule

  Returns Promise<ClientSession>

getSubtitles

• getSubtitles(
      __namedParameters: VideoSubtitlesOpts<V>,
  ): Promise<GetSubtitlesResponse>

  Parameters

  • __namedParameters: VideoSubtitlesOpts<V>

  Returns Promise<GetSubtitlesResponse>

isCustomLink

• isCustomLink(url: string): boolean

  Parameters

  • url: string

  Returns boolean

pingStream

• pingStream(__namedParameters: StreamPingOptions): Promise<boolean>

  Parameters

  • __namedParameters: StreamPingOptions

  Returns Promise<boolean>

request

• request<T = ArrayBuffer>(
      path: string,
      body: Uint8Array,
      headers?: Record<string, string>,
      method?: string,
  ): Promise<ClientResponse<T>>

  The standard method for requesting the Yandex API, if necessary, you can override how it is done in the example

  Example

  import { getVideoData } from "../packages/node/dist/utils/videoData";
  import { ClientResponse } from "../packages/core/dist/types/client";
  
  // https://github.com/axios/axios
  const client = new (class AxiosVOTClient extends VOTClient {
    async request<T = unknown>(
      path: string,
      body: Uint8Array,
      headers: Record<string, string> = {},
      method = "POST",
    ): Promise<ClientResponse<T>> {
      try {
        const res = await axios({
          url: `https://${this.host}${path}`,
          method,
          headers: {
            ...this.headers,
            ...headers,
          },
          data: body,
          responseType: "arraybuffer",
          ...this.fetchOpts,
        });
        return {
          success: res.status === 200,
          data: res.data as T,
        };
      } catch (err) {
        return {
          success: false,
          data: (err as Error)?.message,
        };
      }
    }
    //...
  })();
  
  const videoData = await getVideoData("https://youtu.be/LK6nLR1bzpI");
  Copy

  Type Parameters

  • T = ArrayBuffer

  Parameters

  • path: string
  • body: Uint8Array
  • Optionalheaders: Record<string, string>
  • Optionalmethod: string

  Returns Promise<ClientResponse<T>>

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>>

requestVOT

• requestVOT<T = unknown>(
      path: string,
      body: any,
      headers?: Record<string, string>,
  ): Promise<ClientResponse<T>>

  Type Parameters

  • T = unknown

  Parameters

  • path: string
  • body: any
  • Optionalheaders: Record<string, string>

  Returns Promise<ClientResponse<T>>

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>

• 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>

requestVtransFailAudio

• requestVtransFailAudio(
      url: string,
  ): Promise<ClientResponse<VideoTranslationFailAudioResponse>>

  Parameters

  • url: string

  Returns Promise<ClientResponse<VideoTranslationFailAudioResponse>>

translateStream

• translateStream(
      __namedParameters: StreamTranslationOpts<V>,
  ): Promise<StreamTranslationResponse>

  Parameters

  • __namedParameters: StreamTranslationOpts<V>

  Returns Promise<StreamTranslationResponse>

translateVideo

• translateVideo(
      __namedParameters: VideoTranslationOpts<V>,
  ): Promise<VideoTranslationResponse>

  Parameters

  • __namedParameters: VideoTranslationOpts<V>

  Returns Promise<VideoTranslationResponse>

translateVideoCache

• translateVideoCache(
      __namedParameters: VideoTranslationCacheOpts<V>,
  ): Promise<VideoTranslationCacheResponse>

  Parameters

  • __namedParameters: VideoTranslationCacheOpts<V>

  Returns Promise<VideoTranslationCacheResponse>