ClassOctraAnnotation<S, T>

Type Parameters

S extends ASRContext
T extends OctraAnnotationSegment<S>

Constructors

constructor

new OctraAnnotation<S, T>(levels?, links?, idCounters?): OctraAnnotation<S, T>
Type Parameters
- S extends ASRContext
- T extends OctraAnnotationSegment<S>
Parameters
- Optionallevels: OctraAnnotationAnyLevel<T>[]
- Optionallinks: OctraAnnotationLink[]
- OptionalidCounters: {
      item: number;
      level: number;
      link: number;
  }
  - item: number
  - level: number
  - link: number
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:85

Accessors

currentLevel

get currentLevel(): undefined | OctraAnnotationAnyLevel<T>
Returns undefined | OctraAnnotationAnyLevel<T>
- Defined in annotation.ts:78

idCounters

get idCounters(): {
    item: number;
    level: number;
    link: number;
}
Returns {
    item: number;
    level: number;
    link: number;
}
- item: number
- level: number
- link: number
- Defined in annotation.ts:55

levels

get levels(): OctraAnnotationAnyLevel<T>[]
Returns OctraAnnotationAnyLevel<T>[]
- Defined in annotation.ts:51

selectedLevelIndex

get selectedLevelIndex(): undefined | number
Returns undefined | number
- Defined in annotation.ts:43

Methods

addItemToCurrentLevel

addItemToCurrentLevel(time?, labels?, context?): OctraAnnotation<S, T>
Parameters
- Optionaltime: SampleUnit
- Optionallabels: OLabel[]
- Optionalcontext: S
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:307

addLevel

addLevel(level): OctraAnnotation<S, T>
Parameters
- level: OctraAnnotationAnyLevel<T>
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:174

addLink

addLink(fromID, toID): void
Parameters
- fromID: number
- toID: number
Returns void
- Defined in annotation.ts:472

changeCurrentItemById

changeCurrentItemById(id, item): OctraAnnotation<S, T>
Parameters
- id: number
- item: OItem | OEvent | T
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:253

changeCurrentItemByIndex

changeCurrentItemByIndex(index, item): OctraAnnotation<S, T>
Parameters
- index: number
- item: OItem | OEvent | T
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:265

changeCurrentLevelIndex

changeCurrentLevelIndex(index): OctraAnnotation<S, T>
Parameters
- index: number
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:246

changeCurrentSegmentBySamplePosition

changeCurrentSegmentBySamplePosition(samples, item): OctraAnnotation<S, T>
Parameters
- samples: SampleUnit
- item: T
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:299

changeLevelById

changeLevelById(id, level): OctraAnnotation<S, T>
Parameters
- id: number
- level: OctraAnnotationAnyLevel<T>
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:218

changeLevelByIndex

changeLevelByIndex(index, level): OctraAnnotation<S, T>
Parameters
- index: number
- level: OctraAnnotationAnyLevel<T>
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:228

changeLevelIndex

changeLevelIndex(index): OctraAnnotation<S, T>
Parameters
- index: number
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:121

changeLevelNameByIndex

changeLevelNameByIndex(index, name): OctraAnnotation<S, T>
Parameters
- index: number
- name: string
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:237

changeLinkById

changeLinkById(id, oLink): void
Parameters
- id: number
- oLink: OLink
Returns void
- Defined in annotation.ts:478

changeLinkByIndex

changeLinkByIndex(index, oLink): void
Parameters
- index: number
- oLink: OLink
Returns void
- Defined in annotation.ts:487

changeSampleRate

changeSampleRate(sampleRate): OctraAnnotation<ASRContext, OctraAnnotationSegment<ASRContext>>
Parameters
- sampleRate: number
Returns OctraAnnotation<ASRContext, OctraAnnotationSegment<ASRContext>>
- Defined in annotation.ts:520

clearAllItemsFromCurrentLevel

clearAllItemsFromCurrentLevel(): OctraAnnotation<S, T>
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:147

clone

clone(): OctraAnnotation<ASRContext, OctraAnnotationSegment<ASRContext>>
Returns OctraAnnotation<ASRContext, OctraAnnotationSegment<ASRContext>>
- Defined in annotation.ts:646

createEventLevel

createEventLevel(name, items): OctraAnnotationEventLevel
Parameters
- name: string
- items: OctraAnnotationEvent[]
Returns OctraAnnotationEventLevel
- Defined in annotation.ts:154

createItemLevel

createItemLevel(name, items): OctraAnnotationItemLevel
Parameters
- name: string
- items: OItem[]
Returns OctraAnnotationItemLevel
- Defined in annotation.ts:161

createSegment

createSegment(time, labels?, context?): OctraAnnotationSegment<ASRContext>
Parameters
- time: SampleUnit
- Optionallabels: OLabel[]
- Optionalcontext: S
Returns OctraAnnotationSegment<ASRContext>
- Defined in annotation.ts:165

createSegmentLevel

createSegmentLevel(name, items?): OctraAnnotationSegmentLevel<T>
Parameters
- name: string
- Optionalitems: T[]
Returns OctraAnnotationSegmentLevel<T>
- Defined in annotation.ts:126

deserialize

deserialize(jsonObject): OctraAnnotation<S, T>
Parameters
- jsonObject: OAnnotJSON
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:516

duplicateLevel

duplicateLevel(index): OctraAnnotation<S, T>
Parameters
- index: number
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:179

getCurrentSegmentIndexBySamplePosition

getCurrentSegmentIndexBySamplePosition(samples): number
Parameters
- samples: SampleUnit
Returns number
- Defined in annotation.ts:276

getItemById

getItemById(id): undefined | AnnotationAnySegment
Parameters
- id: number
Returns undefined | AnnotationAnySegment
- Defined in annotation.ts:137

removeItemById

removeItemById(id, silenceCode?, mergeTranscripts?, changeTranscript?): OctraAnnotation<S, T>
Parameters
- id: number
- OptionalsilenceCode: string
- OptionalmergeTranscripts: boolean
- OptionalchangeTranscript: ((transcript: string) => string)
  - - (transcript): string
    - Parameters
      transcript: string
      Returns string
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:451

removeItemByIndex

removeItemByIndex(index, silenceValue?, mergeTranscripts?, changeTranscript?): OctraAnnotation<S, T>
Parameters
- index: number
- OptionalsilenceValue: string
- OptionalmergeTranscripts: boolean
- OptionalchangeTranscript: ((transcript: string) => string)
  - - (transcript): string
    - Parameters
      transcript: string
      Returns string
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:365

removeLevel

removeLevel(id): OctraAnnotation<S, T>
Parameters
- id: number
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:199

serialize

serialize(mediaFileName, sampleRate, lastSegmentTime): OAnnotJSON
Parameters
- mediaFileName: string
- sampleRate: number
- lastSegmentTime: SampleUnit
Returns OAnnotJSON
- Defined in annotation.ts:564

updateIDCounters

updateIDCounters(): void
Returns void
- Defined in annotation.ts:104

`Static`deserialize

deserialize<S, T>(jsonObject): OctraAnnotation<S, T>
Type Parameters
- S extends ASRContext
- T extends OctraAnnotationSegment<S>
Parameters
- jsonObject: OAnnotJSON
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:594

ClassOctraAnnotation<S, T>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

item: number

level: number

link: number

Returns OctraAnnotation<S, T>

Accessors

currentLevel

Returns undefined | OctraAnnotationAnyLevel<T>

idCounters

Returns { item: number; level: number; link: number; }

item: number

level: number

link: number

levels

Returns OctraAnnotationAnyLevel<T>[]

links

Returns OctraAnnotationLink[]

selectedLevelIndex

Returns undefined | number

Methods

addItemToCurrentLevel

Parameters

Returns OctraAnnotation<S, T>

addLevel

Parameters

Returns OctraAnnotation<S, T>

addLink

Parameters

Returns void

changeCurrentItemById

Parameters

Returns OctraAnnotation<S, T>

changeCurrentItemByIndex

Parameters

Returns OctraAnnotation<S, T>

changeCurrentLevelIndex

Parameters

Returns OctraAnnotation<S, T>

changeCurrentSegmentBySamplePosition

Parameters

Returns OctraAnnotation<S, T>

changeLevelById

Parameters

Returns OctraAnnotation<S, T>

changeLevelByIndex

Parameters

Returns OctraAnnotation<S, T>

changeLevelIndex

Parameters

Returns OctraAnnotation<S, T>

changeLevelNameByIndex

Parameters

Returns OctraAnnotation<S, T>

changeLinkById

Parameters

Returns void

changeLinkByIndex

Parameters

Returns void

changeSampleRate

Parameters

Returns OctraAnnotation<ASRContext, OctraAnnotationSegment<ASRContext>>

clearAllItemsFromCurrentLevel

Returns OctraAnnotation<S, T>

clone

Returns OctraAnnotation<ASRContext, OctraAnnotationSegment<ASRContext>>

createEventLevel

Parameters

Returns OctraAnnotationEventLevel

createItemLevel

Parameters

Returns {
item: number;
level: number;
link: number;
}

`Static`deserialize