Class AnnotJSONConverter

Hierarchy (View Summary)

Converter
- AnnotJSONConverter

Index

Constructors

Properties

_applications _conversion _encoding _extensions _multitiers _name _notice defaultImportOptions options

Accessors

applications conversion encoding extensions multitiers name notice

Methods

export import needsOptionsForImport

Constructors

constructor

new AnnotJSONConverter(): AnnotJSONConverter
Returns AnnotJSONConverter
Overrides Converter.constructor
- Defined in converters/AnnotJSONConverter.ts:20

Properties

`Protected`_applications

_applications: { application: SupportedApplication; recommended?: boolean }[] = []

`Protected`_conversion

_conversion: { export: boolean; import: boolean } = ...

`Protected`_encoding

_encoding: string = ''

`Protected`_extensions

_extensions: string[] = []

`Protected`_multitiers

_multitiers: boolean = true

_name

_name: OctraAnnotationFormatType = 'AnnotJSON'

`Protected`_notice

_notice: string = ''

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

applications

get applications(): { application: SupportedApplication; recommended?: boolean }[]
Returns { application: SupportedApplication; recommended?: boolean }[]
Inherited from Converter.applications
- Defined in converters/Converter.ts:53

conversion

get conversion(): { export: boolean; import: boolean }
Returns { export: boolean; import: boolean }
Inherited from Converter.conversion
- Defined in converters/Converter.ts:42

encoding

get encoding(): string
Returns string
Inherited from Converter.encoding
- Defined in converters/Converter.ts:74

extensions

get extensions(): string[]
Returns string[]
Inherited from Converter.extensions
- Defined in converters/Converter.ts:68

multitiers

get multitiers(): boolean
Returns boolean
Inherited from Converter.multitiers
- Defined in converters/Converter.ts:87

name

get name(): OctraAnnotationFormatType
Returns OctraAnnotationFormatType
Inherited from Converter.name
- Defined in converters/Converter.ts:62

notice

get notice(): string
Returns string
Inherited from Converter.notice
- Defined in converters/Converter.ts:80

Methods

export

export(annotation: OAnnotJSON): ExportResult
exports AnnotJSON to another annotation format considering an audio file and a level number (optional).
Parameters
- annotation: OAnnotJSON
  the AnnotJSON
Returns ExportResult
Overrides Converter.export
- Defined in converters/AnnotJSONConverter.ts:41

import

import(file: IFile, audiofile: OAudiofile): 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.
Returns ImportResult
Overrides Converter.import
- Defined in converters/AnnotJSONConverter.ts:62

needsOptionsForImport

needsOptionsForImport(file: IFile, audiofile: OAudiofile): any
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 any
Overrides Converter.needsOptionsForImport
- Defined in converters/AnnotJSONConverter.ts:58