Class AudioVideoSdk

constructor

• new AudioVideoSdk(args?: { client?: Client; key?: string }): AudioVideoSdk

  Parameters

  • Optionalargs: { client?: Client; key?: string }

  Returns AudioVideoSdk

Static Readonly__registry

avatars

• avatars<ThrowOnError extends boolean = false>(
      options?: Options<AvatarsData, ThrowOnError>,
  ): RequestResult<AvatarsResponses, AvatarsErrors, ThrowOnError, "fields">

  Get available avatars

  Retrieves the list of all available avatars for the user's enterprise.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • Optionaloptions: Options<AvatarsData, ThrowOnError>

  Returns RequestResult<AvatarsResponses, AvatarsErrors, ThrowOnError, "fields">

dub

• dub<ThrowOnError extends boolean = false>(
      options: Options<DubData, ThrowOnError>,
  ): RequestResult<DubResponses, DubErrors, ThrowOnError, "fields">

  Dub audio or video

  Generate dubbed video or audio. A composited lip sync can also be added for video dubbing.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<DubData, ThrowOnError>

  Returns RequestResult<DubResponses, DubErrors, ThrowOnError, "fields">

generateAvatar

• generateAvatar<ThrowOnError extends boolean = false>(
      options: Options<GenerateAvatarData, ThrowOnError>,
  ): RequestResult<
      GenerateAvatarResponses,
      GenerateAvatarErrors,
      ThrowOnError,
      "fields",
  >

  Generate avatar video from text

  Generates an avatar video from a provided transcript or audio file. You can provide the transcript either as plain text or a pre-signed URL. The API is asynchronous, so the response will include a job ID and a status URL for tracking the running job.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GenerateAvatarData, ThrowOnError>

  Returns RequestResult<
      GenerateAvatarResponses,
      GenerateAvatarErrors,
      ThrowOnError,
      "fields",
  >

generateReframedVideo

• generateReframedVideo<ThrowOnError extends boolean = false>(
      options: Options<GenerateReframedVideoData, ThrowOnError>,
  ): RequestResult<
      GenerateReframedVideoResponses,
      GenerateReframedVideoErrors,
      ThrowOnError,
      "fields",
  >

  Reframe video

  This endpoint enables you to reframe video using AI. Provide video input with a pre-signed URL to generate reframed video output.

  This API has more limited capabilities than the v2 endpoint, and may be deprecated soon. It's recommended to use the v2 endpoint instead.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GenerateReframedVideoData, ThrowOnError>

  Returns RequestResult<
      GenerateReframedVideoResponses,
      GenerateReframedVideoErrors,
      ThrowOnError,
      "fields",
  >

generateReframedVideoV2

• generateReframedVideoV2<ThrowOnError extends boolean = false>(
      options: Options<GenerateReframedVideoV2Data, ThrowOnError>,
  ): RequestResult<
      GenerateReframedVideoV2Responses,
      GenerateReframedVideoV2Errors,
      ThrowOnError,
      "fields",
  >

  Reframe video v2

  This endpoint enables you to reframe the input media. You can provide a video input via a pre-signed URL to generate reframed output video.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GenerateReframedVideoV2Data, ThrowOnError>

  Returns RequestResult<
      GenerateReframedVideoV2Responses,
      GenerateReframedVideoV2Errors,
      ThrowOnError,
      "fields",
  >

generateSpeech

• generateSpeech<ThrowOnError extends boolean = false>(
      options: Options<GenerateSpeechData, ThrowOnError>,
  ): RequestResult<
      GenerateSpeechResponses,
      GenerateSpeechErrors,
      ThrowOnError,
      "fields",
  >

  Generate speech from text

  This endpoint generates speech from a transcript. You can provide the transcript either as plain text or a pre-signed URL. The response will include a job ID and a status URL for tracking the job.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GenerateSpeechData, ThrowOnError>

  Returns RequestResult<
      GenerateSpeechResponses,
      GenerateSpeechErrors,
      ThrowOnError,
      "fields",
  >

getPresets

• getPresets<ThrowOnError extends boolean = false>(
      options?: Options<GetPresetsData, ThrowOnError>,
  ): RequestResult<
      GetPresetsResponses,
      GetPresetsErrors,
      ThrowOnError,
      "fields",
  >

  Fetch video rendering presets

  Returns a list of predefined social-first encoding presets for rendering outputs.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • Optionaloptions: Options<GetPresetsData, ThrowOnError>

  Returns RequestResult<GetPresetsResponses, GetPresetsErrors, ThrowOnError, "fields">

jobResultV2

• jobResultV2<ThrowOnError extends boolean = false>(
      options: Options<JobResultV2Data, ThrowOnError>,
  ): RequestResult<
      JobResultV2Responses,
      JobResultV2Errors,
      ThrowOnError,
      "fields",
  >

  Get job result

  This endpoint retrieves the result of an asynchronous reframed job initiated using the job ID.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<JobResultV2Data, ThrowOnError>

  Returns RequestResult<JobResultV2Responses, JobResultV2Errors, ThrowOnError, "fields">

status

• status<ThrowOnError extends boolean = false>(
      options: Options<StatusData, ThrowOnError>,
  ): RequestResult<StatusResponses, StatusErrors, ThrowOnError, "fields">

  Get job status

  Provides the status and result of an asynchronous job. For Dynamic Graphics Render (DGR), returns the status of a Describe template or Render job.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<StatusData, ThrowOnError>

  Returns RequestResult<StatusResponses, StatusErrors, ThrowOnError, "fields">

templateDescribe

• templateDescribe<ThrowOnError extends boolean = false>(
      options: Options<TemplateDescribeData, ThrowOnError>,
  ): RequestResult<
      TemplateDescribeResponses,
      TemplateDescribeErrors,
      ThrowOnError,
      "fields",
  >

  Describe template

  Analyzes a MOGRT (video template) file and returns a manifest of editable controls; fonts, images, audio, video and other supported values.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<TemplateDescribeData, ThrowOnError>

  Returns RequestResult<
      TemplateDescribeResponses,
      TemplateDescribeErrors,
      ThrowOnError,
      "fields",
  >

templateRender

• templateRender<ThrowOnError extends boolean = false>(
      options: Options<TemplateRenderData, ThrowOnError>,
  ): RequestResult<
      TemplateRenderResponses,
      TemplateRenderErrors,
      ThrowOnError,
      "fields",
  >

  Render template

  Renders one or more video variations by applying overrides and export presets. Submit up to 10 overrides per call for a subset of editable layers and get a pre-signed URL link to download the video file. For layers that are not editable, the system defaults are automatically applied at export.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<TemplateRenderData, ThrowOnError>

  Returns RequestResult<
      TemplateRenderResponses,
      TemplateRenderErrors,
      ThrowOnError,
      "fields",
  >

transcribe

• transcribe<ThrowOnError extends boolean = false>(
      options: Options<TranscribeData, ThrowOnError>,
  ): RequestResult<
      TranscribeResponses,
      TranscribeErrors,
      ThrowOnError,
      "fields",
  >

  Transcribe media

  Generates transcripts and captions for the input audio or video in the source language or in a target language.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<TranscribeData, ThrowOnError>

  Returns RequestResult<TranscribeResponses, TranscribeErrors, ThrowOnError, "fields">

voices

• voices<ThrowOnError extends boolean = false>(
      options?: Options<VoicesData, ThrowOnError>,
  ): RequestResult<VoicesResponses, VoicesErrors, ThrowOnError, "fields">

  Get available voices

  This endpoint provides the list of all available voices for the user's enterprise.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • Optionaloptions: Options<VoicesData, ThrowOnError>

  Returns RequestResult<VoicesResponses, VoicesErrors, ThrowOnError, "fields">