Class OctraAnnotation<S, T>

Type Parameters

S extends ASRContext
T extends OctraAnnotationSegment<S>

Constructors

constructor

new OctraAnnotation<S extends ASRContext, T extends OctraAnnotationSegment<S>>(
    levels?: OctraAnnotationAnyLevel<T>[],
    links?: OctraAnnotationLink[],
    idCounters?: { item: number; level: number; link: number },
): 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 }
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:88

Accessors

currentLevel

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

idCounters

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

levels

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

selectedLevelIndex

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

Methods

addItemToCurrentLevel

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

addLevel

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

addLink

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

changeCurrentItemById

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

changeCurrentItemByIndex

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

changeCurrentLevelIndex

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

changeCurrentSegmentBySamplePosition

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

changeLevelById

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

changeLevelByIndex

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

changeLevelIndex

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

changeLevelNameByIndex

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

changeLinkById

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

changeLinkByIndex

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

changeSampleRate

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

clearAllItemsFromCurrentLevel

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

clone

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

createEventLevel

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

createItemLevel

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

createSegment

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

createSegmentLevel

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

deserialize

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

duplicateLevel

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

getCurrentSegmentIndexBySamplePosition

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

getItemById

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

removeItemById

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

removeItemByIndex

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

removeLevel

removeLevel(
id: number,
supportedLevelTypes?: AnnotationLevelType[],
): OctraAnnotation<S, T>
Parameters
- id: number
- supportedLevelTypes: AnnotationLevelType[] = ...
Returns OctraAnnotation<S, T>
- Defined in annotation.ts:202

serialize

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

updateIDCounters

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

`Static`deserialize

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

Class OctraAnnotation<S, T>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OctraAnnotation<S, T>

Accessors

currentLevel

Returns undefined | OctraAnnotationAnyLevel<T>

idCounters

Returns { 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 OctraAnnotationItemLevel

createSegment

Parameters

Returns OctraAnnotationSegment<ASRContext>

createSegmentLevel

Parameters

`Static`deserialize