Class Converter<I, O>Abstract

constructor

• new Converter<I extends object = object, O extends object = object>(): Converter<
      I,
      O,
  >

  Type Parameters

  • I extends object = object
  • O extends object = object

  Returns Converter<I, O>

defaultImportOptions

applications

• get applications(): { application: SupportedApplication; recommended?: boolean }[]

  Returns { application: SupportedApplication; recommended?: boolean }[]

conversion

• get conversion(): { export: boolean; import: boolean }

  Returns { export: boolean; import: boolean }

encoding

• get encoding(): string

  Returns string

extensions

• get extensions(): string[]

  Returns string[]

multitiers

• get multitiers(): boolean

  Returns boolean

name

• get name(): OctraAnnotationFormatType

  Returns OctraAnnotationFormatType

notice

• get notice(): string

  Returns string

Abstractexport

• export(annotation: OAnnotJSON, audiofile: OAudiofile, options?: O): 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: O

    Options for this converter returns resulted file or error.

  Returns ExportResult

getDefaultOptions

• getDefaultOptions<S extends object>(
      schema: FormGeneratorJSONSchema | undefined,
  ): S | undefined

  returns the default options generated by the corresponding JSON schema.

  Type Parameters

  • S extends object

  Parameters

  • schema: FormGeneratorJSONSchema | undefined

  Returns S | undefined

Abstractimport

• import(file: IFile, audiofile: OAudiofile, options?: I): 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.

  • Optionaloptions: I

  Returns ImportResult

AbstractneedsOptionsForExport

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

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

  Parameters

  • annotation: OAnnotJSON

    annotation

  • audiofile: OAudiofile

    information about the audio file.

  Returns FormGeneratorJSONSchema | undefined

AbstractneedsOptionsForImport

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

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