Class AudioSubtitleLoader

Transcribe audio and load subtitles for the transcript as srt or vtt format.

Hierarchy

  • CreateTranscriptLoader
    • AudioSubtitleLoader

Constructors

constructor

Properties

client transcribeParams? transcriptId?

Methods

load transcribeOrGetTranscript

Constructors

constructor

  • new AudioSubtitleLoader(transcribeParams, subtitleFormat, assemblyAIOptions?): AudioSubtitleLoader

  • Create a new AudioSubtitleLoader.

    Parameters

    • transcribeParams: TranscriptParams | TranscribeParams

      The parameters to transcribe audio.

    • subtitleFormat: SubtitleFormat

      The format of the subtitles, either srt or vtt.

    • Optional assemblyAIOptions: AssemblyAIOptions

      The options to configure the AssemblyAI loader. Configure the assemblyAIOptions.apiKey with your AssemblyAI API key, or configure it as the ASSEMBLYAI_API_KEY environment variable.

    Returns AudioSubtitleLoader

  • new AudioSubtitleLoader(transcriptId, subtitleFormat, assemblyAIOptions?): AudioSubtitleLoader

  • Create a new AudioSubtitleLoader.

    Parameters

    • transcriptId: string

      The ID of the transcript to retrieve.

    • subtitleFormat: SubtitleFormat

      The format of the subtitles, either srt or vtt.

    • Optional assemblyAIOptions: AssemblyAIOptions

      The options to configure the AssemblyAI loader. Configure the assemblyAIOptions.apiKey with your AssemblyAI API key, or configure it as the ASSEMBLYAI_API_KEY environment variable.

    Returns AudioSubtitleLoader

Properties

Protected client

client: AssemblyAI

Protected Optional transcribeParams

transcribeParams?: TranscriptParams | TranscribeParams

Protected Optional transcriptId

transcriptId?: string

Methods

load

  • load(): Promise<Document<Record<string, any>>[]>

  • Transcribe audio and load subtitles for the transcript as srt or vtt format.

    Returns Promise<Document<Record<string, any>>[]>

    A promise that resolves a document containing the subtitles as the page content.

Protected transcribeOrGetTranscript

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc