Class WebVTTConverter

constructor

• new WebVTTConverter(): WebVTTConverter

  Returns WebVTTConverter

_name

defaultImportOptions

Static ReadonlyTIMESTAMP_PATTERN

export

• export(
      annotation: OAnnotJSON,
      audiofile: OAudiofile,
      options?: WebVTTConverterExportOptions,
  ): ExportResult

  exports AnnotJSON to another annotation format considering an audio file and a level number (optional).

  Parameters

  • annotation: OAnnotJSON

    the AnnotJSON

  • audiofile: OAudiofile

    information about the audio file

  • Optionaloptions: WebVTTConverterExportOptions

    Options for this converter returns resulted file or error.

  Returns ExportResult

formatNumber

• formatNumber(num: number, length: number): string

  Parameters

  • num: number
  • length: number

  Returns string

getTimeStringFromSamples

• getTimeStringFromSamples(samples: number, sampleRate: number): string

  Parameters

  • samples: number
  • sampleRate: number

  Returns string

import

• import(
      file: IFile,
      audiofile: OAudiofile,
      options?: WebVTTConverterImportOptions,
  ): ImportResult

  converts an file to AnnotJSON considering the audio file. The audio file must be the one used for this transcript file.

  Parameters

  • file: IFile

    the transcript file

  • audiofile: OAudiofile

    information about the audio file. returns object with an annotjson or an error.

  • options: WebVTTConverterImportOptions = ...

  Returns ImportResult

needsOptionsForExport

• needsOptionsForExport(
      annotation: OAnnotJSON,
      audiofile: OAudiofile,
  ): FormGeneratorJSONSchema

  checks if the converter needs further options to export a file.

  Parameters

  • annotation: OAnnotJSON

    annotation

  • audiofile: OAudiofile

    information about the audio file.

  Returns FormGeneratorJSONSchema

needsOptionsForImport

• needsOptionsForImport(
      file: IFile,
      audiofile: OAudiofile,
  ): FormGeneratorJSONSchema

  checks if the converter needs further options to import the file.

  Parameters

  • file: IFile

    the transcript file

  • audiofile: OAudiofile

    information about the audio file.

  Returns FormGeneratorJSONSchema

StaticgetSamplesFromTimeString

• getSamplesFromTimeString(timeString: string, sampleRate: number): number

  Parameters

  • timeString: string
  • sampleRate: number

  Returns number