From 619b3a5880acf276afd5e509b2cf3539d18208ca Mon Sep 17 00:00:00 2001 From: julianpoemp Date: Fri, 18 Oct 2024 14:11:49 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20IPS-LMU/?= =?UTF-8?q?octra@0449311377d6960e4cd23326acb7fbcefaded718=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_octra_annotation.AnnotJSONConverter.html | 10 ++--- ..._octra_annotation.BundleJSONConverter.html | 10 ++--- classes/_octra_annotation.CTMConverter.html | 10 ++--- classes/_octra_annotation.Converter.html | 10 ++--- classes/_octra_annotation.ELANConverter.html | 10 ++--- classes/_octra_annotation.Link.html | 4 +- classes/_octra_annotation.OAnnotJSON.html | 6 +-- classes/_octra_annotation.OEvent.html | 4 +- classes/_octra_annotation.OEventLevel.html | 4 +- classes/_octra_annotation.OItem.html | 4 +- classes/_octra_annotation.OItemLevel.html | 4 +- classes/_octra_annotation.OLabel.html | 4 +- classes/_octra_annotation.OLevel.html | 4 +- classes/_octra_annotation.OLink.html | 4 +- classes/_octra_annotation.OSegment.html | 4 +- classes/_octra_annotation.OSegmentLevel.html | 4 +- .../_octra_annotation.OctraAnnotation.html | 4 +- ...octra_annotation.OctraAnnotationEvent.html | 4 +- ..._annotation.OctraAnnotationEventLevel.html | 4 +- ...a_annotation.OctraAnnotationItemLevel.html | 4 +- ...octra_annotation.OctraAnnotationLevel.html | 4 +- ..._octra_annotation.OctraAnnotationLink.html | 4 +- ...tra_annotation.OctraAnnotationSegment.html | 4 +- ...nnotation.OctraAnnotationSegmentLevel.html | 4 +- .../_octra_annotation.PartiturConverter.html | 10 ++--- ..._octra_annotation.PraatTableConverter.html | 10 ++--- ...tra_annotation.PraatTextgridConverter.html | 10 ++--- classes/_octra_annotation.SRTConverter.html | 10 ++--- ..._annotation.SRTConverterImportOptions.html | 4 +- classes/_octra_annotation.TextConverter.html | 12 +++--- .../_octra_annotation.WebVTTConverter.html | 10 ++--- classes/_octra_annotation.WhisperJSON.html | 4 +- ...octra_annotation.WhisperJSONConverter.html | 10 ++--- .../_octra_annotation.WhisperJSONSegment.html | 4 +- ...tra_json_sets.DecisionTreeCombination.html | 4 +- ...ctra_json_sets.DecisionTreeExpression.html | 4 +- .../_octra_json_sets.DecisionTreeNode.html | 4 +- .../_octra_json_sets.FileSetValidator.html | 4 +- classes/_octra_json_sets.IFile.html | 4 +- classes/_octra_json_sets.JSONSet.html | 4 +- .../_octra_json_sets.JSONSetBlueprint.html | 4 +- .../_octra_json_sets.JSONSetCombination.html | 4 +- ..._octra_json_sets.JSONSetFileBlueprint.html | 4 +- ...octra_json_sets.JSONSetFileConditions.html | 4 +- classes/_octra_json_sets.JSONSetResult.html | 4 +- .../_octra_json_sets.JSONSetStatement.html | 4 +- ...ctra_json_sets.JSONSetValidationError.html | 4 +- .../_octra_json_sets.JsonSetValidator.html | 4 +- .../_octra_json_sets.PossibleSolution.html | 4 +- classes/_octra_media.AudioSelection.html | 4 +- classes/_octra_media.OAudiofile.html | 4 +- classes/_octra_media.SampleUnit.html | 4 +- ...a_ngx_components.AudioViewerComponent.html | 40 +++++++++---------- ...a_ngx_components.AudioplayerComponent.html | 12 +++--- ...ctra_ngx_components.AudioviewerConfig.html | 4 +- ..._components.ConfigurationArrayControl.html | 4 +- ...a_ngx_components.ConfigurationControl.html | 4 +- ..._components.ConfigurationControlGroup.html | 4 +- ...omponents.ConfigurationControlOptions.html | 4 +- ...ts.ConfigurationMultipleChoiceControl.html | 4 +- ...components.ConfigurationNumberControl.html | 4 +- ...components.ConfigurationSelectControl.html | 4 +- ...components.ConfigurationSwitchControl.html | 4 +- ...x_components.ConfigurationTextControl.html | 4 +- ...mponents.ConfigurationTextareaControl.html | 4 +- ...ents.FixedConfigurationControlOptions.html | 4 +- classes/_octra_ngx_components.Interval.html | 4 +- classes/_octra_ngx_components.Margin.html | 4 +- ..._ngx_components.MultiThreadingService.html | 4 +- ..._ngx_components.OctraComponentsModule.html | 2 +- ...x_components.OctraFormGeneratorModule.html | 2 +- classes/_octra_ngx_components.Position.html | 4 +- .../_octra_ngx_components.PreparedItem.html | 4 +- classes/_octra_ngx_components.Rectangle.html | 4 +- classes/_octra_ngx_components.Size.html | 4 +- ...ponents.ToolConfigArrayAdderComponent.html | 8 ++-- ..._components.ToolConfiguratorComponent.html | 10 ++--- ...x_components.ToolconfigGroupComponent.html | 8 ++-- ...octra_ngx_utilities.CapitalLetterPipe.html | 4 +- classes/_octra_ngx_utilities.JoinPipe.html | 4 +- .../_octra_ngx_utilities.LeadingNullPipe.html | 4 +- classes/_octra_ngx_utilities.MapPipe.html | 4 +- ...ra_ngx_utilities.OctraUtilitiesModule.html | 2 +- classes/_octra_ngx_utilities.ProcentPipe.html | 4 +- ...tra_ngx_utilities.SubscriberComponent.html | 8 ++-- .../_octra_ngx_utilities.TimespanPipe.html | 4 +- ..._octra_ngx_utilities.UnixDurationPipe.html | 4 +- .../_octra_utilities.SerializableClass.html | 4 +- .../_octra_utilities.SubscriptionManager.html | 12 +++--- classes/_octra_web_media.AudioChunk.html | 8 ++-- classes/_octra_web_media.AudioDecoder.html | 6 +-- classes/_octra_web_media.AudioFormat.html | 4 +- classes/_octra_web_media.AudioInfo.html | 10 ++--- classes/_octra_web_media.AudioManager.html | 26 ++++++------ classes/_octra_web_media.AudioResource.html | 4 +- .../_octra_web_media.AudioTimeCalculator.html | 4 +- classes/_octra_web_media.BrowserInfo.html | 10 ++--- classes/_octra_web_media.DataInfo.html | 4 +- classes/_octra_web_media.DirectoryInfo.html | 4 +- classes/_octra_web_media.FileInfo.html | 10 ++--- classes/_octra_web_media.OggFormat.html | 6 +-- classes/_octra_web_media.ShortcutManager.html | 4 +- classes/_octra_web_media.TsWorker.html | 20 +++++----- classes/_octra_web_media.TsWorkerJob.html | 18 ++++----- classes/_octra_web_media.WavFormat.html | 10 ++--- enums/_octra_annotation.ASRQueueItemType.html | 4 +- ..._octra_annotation.AnnotationLevelType.html | 4 +- enums/_octra_media.PlayBackStatus.html | 4 +- enums/_octra_web_media.TsWorkerStatus.html | 4 +- functions/_octra_annotation.addSegment.html | 2 +- ..._octra_annotation.betweenWhichSegment.html | 2 +- functions/_octra_annotation.cleanup.html | 2 +- .../_octra_annotation.combineSegments.html | 2 +- functions/_octra_annotation.contains.html | 2 +- ...tation.convertFromSupportedConverters.html | 2 +- ...annotation.convertOSegmentsToSegments.html | 2 +- ...annotation.convertSegmentsToOSegments.html | 2 +- ...annotation.getSegmentBySamplePosition.html | 2 +- .../_octra_annotation.getSegmentsOfRange.html | 2 +- ...ra_annotation.getStartTimeBySegmentID.html | 2 +- .../_octra_annotation.removeBySamples.html | 2 +- ...octra_annotation.removeSegmentByIndex.html | 2 +- functions/_octra_annotation.sort.html | 2 +- .../_octra_ngx_utilities.downloadFile.html | 2 +- .../_octra_ngx_utilities.navigateTo.html | 2 +- ...octra_ngx_utilities.uniqueHTTPRequest.html | 2 +- .../_octra_utilities.base64ToArrayBuffer.html | 2 +- functions/_octra_utilities.contains.html | 2 +- ...octra_utilities.convertDurationToUnix.html | 2 +- .../_octra_utilities.equalProperties.html | 2 +- functions/_octra_utilities.escapeHtml.html | 2 +- functions/_octra_utilities.escapeRegex.html | 2 +- ...ctra_utilities.extractFileNameFromURL.html | 2 +- functions/_octra_utilities.flatten.html | 2 +- .../_octra_utilities.getBaseHrefURL.html | 2 +- functions/_octra_utilities.getFileSize.html | 2 +- functions/_octra_utilities.getProperties.html | 2 +- .../_octra_utilities.getTranscriptFromIO.html | 2 +- functions/_octra_utilities.hasProperty.html | 2 +- .../_octra_utilities.hasPropertyTree.html | 2 +- functions/_octra_utilities.insertString.html | 2 +- functions/_octra_utilities.isEmpty.html | 2 +- functions/_octra_utilities.isFunction.html | 2 +- functions/_octra_utilities.isNumber.html | 2 +- functions/_octra_utilities.joinURL.html | 2 +- functions/_octra_utilities.last.html | 2 +- functions/_octra_utilities.mapFnOnObject.html | 2 +- functions/_octra_utilities.popupCenter.html | 2 +- functions/_octra_utilities.range.html | 2 +- ...octra_utilities.removeEmptyProperties.html | 2 +- functions/_octra_utilities.unEscapeHtml.html | 2 +- ...tra_utilities.waitTillResultRetrieved.html | 2 +- functions/_octra_web_media.downloadFile.html | 2 +- .../_octra_web_media.fileListToArray.html | 2 +- functions/_octra_web_media.findElements.html | 2 +- functions/_octra_web_media.getAttr.html | 2 +- functions/_octra_web_media.getAudioInfo.html | 2 +- .../_octra_web_media.getBaseHrefURL.html | 2 +- .../_octra_web_media.getFileContent.html | 2 +- functions/_octra_web_media.popupCenter.html | 2 +- functions/_octra_web_media.readFile.html | 2 +- .../_octra_web_media.readFileContents.html | 2 +- functions/_octra_web_media.renameFile.html | 2 +- functions/_octra_web_media.setStyle.html | 2 +- interfaces/_octra_annotation.ASRContext.html | 4 +- interfaces/_octra_annotation.Bundle.html | 4 +- .../_octra_annotation.ELAN30Object.html | 4 +- .../_octra_annotation.ExportResult.html | 4 +- interfaces/_octra_annotation.IAnnotJSON.html | 4 +- interfaces/_octra_annotation.IAudioFile.html | 4 +- interfaces/_octra_annotation.IEvent.html | 4 +- interfaces/_octra_annotation.IEventLevel.html | 4 +- interfaces/_octra_annotation.IFile.html | 4 +- interfaces/_octra_annotation.IItem.html | 4 +- interfaces/_octra_annotation.IItemLevel.html | 4 +- interfaces/_octra_annotation.ILabel.html | 4 +- interfaces/_octra_annotation.ILevel.html | 4 +- interfaces/_octra_annotation.ILink.html | 4 +- interfaces/_octra_annotation.ISegment.html | 4 +- .../_octra_annotation.ISegmentLevel.html | 4 +- .../_octra_annotation.ImportResult.html | 4 +- .../_octra_annotation.SegmentWithContext.html | 4 +- .../_octra_annotation.WhisperJSONWord.html | 4 +- interfaces/_octra_assets.OctraGuidelines.html | 4 +- .../_octra_json_sets.AudioFileMetaData.html | 4 +- interfaces/_octra_media.IAudioFile.html | 4 +- interfaces/_octra_media.NumeratedSegment.html | 4 +- interfaces/_octra_media.SampleTimeValues.html | 4 +- ...x_components.AudioViewerShortcutEvent.html | 4 +- ...gx_components.CurrentLevelChangeEvent.html | 4 +- interfaces/_octra_ngx_components.ICircle.html | 4 +- .../_octra_ngx_components.IInterval.html | 4 +- interfaces/_octra_ngx_components.IMargin.html | 4 +- .../_octra_ngx_components.IPosition.html | 4 +- .../_octra_ngx_components.IRectangle.html | 4 +- interfaces/_octra_ngx_components.ISize.html | 4 +- interfaces/_octra_utilities.FileSize.html | 4 +- interfaces/_octra_utilities.Serializable.html | 4 +- .../_octra_web_media.KeyMappingEntry.html | 4 +- .../_octra_web_media.ReadFileEvent.html | 4 +- .../_octra_web_media.SegmentToDecode.html | 4 +- interfaces/_octra_web_media.Shortcut.html | 4 +- .../_octra_web_media.ShortcutEvent.html | 4 +- .../_octra_web_media.ShortcutGroup.html | 4 +- ...octra_annotation.AnnotationAnySegment.html | 2 +- types/_octra_annotation.IAnyLevel.html | 2 +- types/_octra_annotation.OAnyLevel.html | 2 +- ...ra_annotation.OctraAnnotationAnyLevel.html | 2 +- ..._annotation.OctraAnnotationFormatType.html | 2 +- types/_octra_json_sets.JSONSetExpression.html | 2 +- types/_octra_web_media.IntArray.html | 2 +- variables/_octra_assets.IO_SETS.html | 2 +- ...ctra_assets.OctraGuidelinesJSONSchema.html | 2 +- .../_octra_assets.OctraLoggingJSONSchema.html | 2 +- ...a_assets.OctraProjectConfigJSONSchema.html | 2 +- 215 files changed, 476 insertions(+), 476 deletions(-) diff --git a/classes/_octra_annotation.AnnotJSONConverter.html b/classes/_octra_annotation.AnnotJSONConverter.html index d29a594ef..81fb44e74 100644 --- a/classes/_octra_annotation.AnnotJSONConverter.html +++ b/classes/_octra_annotation.AnnotJSONConverter.html @@ -1,4 +1,4 @@ -AnnotJSONConverter | Octra libraries - v2.0.0

ClassAnnotJSONConverter

Hierarchy (view full)

Constructors

constructor +AnnotJSONConverter | Octra libraries - v2.0.0

ClassAnnotJSONConverter

Hierarchy (view full)

Constructors

constructor

Properties

_application _conversion _encoding @@ -20,13 +20,13 @@

Methods

export import needsOptionsForImport -

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

_name

_name: OctraAnnotationFormatType = 'AnnotJSON'

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

export

  • export(annotation): ExportResult

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

    +

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

_name

_name: OctraAnnotationFormatType = 'AnnotJSON'

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

export

import

  • import(file, audiofile): ImportResult

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

    +

Returns ExportResult

import

needsOptionsForImport

  • needsOptionsForImport(file, audiofile): any

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

    +

Returns ImportResult

needsOptionsForImport

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/_octra_annotation.BundleJSONConverter.html b/classes/_octra_annotation.BundleJSONConverter.html index f7e731d5b..95401afe7 100644 --- a/classes/_octra_annotation.BundleJSONConverter.html +++ b/classes/_octra_annotation.BundleJSONConverter.html @@ -1,4 +1,4 @@ -BundleJSONConverter | Octra libraries - v2.0.0

ClassBundleJSONConverter

Hierarchy (view full)

Constructors

constructor +BundleJSONConverter | Octra libraries - v2.0.0

ClassBundleJSONConverter

Hierarchy (view full)

Constructors

constructor

Properties

_application _conversion _encoding @@ -20,14 +20,14 @@

Methods

export import needsOptionsForImport -

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

_name

_name: OctraAnnotationFormatType = 'BundleJSON'

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

export

  • export(annotation, audiofile): ExportResult

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

    +

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

_name

_name: OctraAnnotationFormatType = 'BundleJSON'

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

export

import

  • import(file, audiofile): ImportResult

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

    +

Returns ExportResult

import

needsOptionsForImport

  • needsOptionsForImport(file, audiofile): any

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

    +

Returns ImportResult

needsOptionsForImport

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/_octra_annotation.CTMConverter.html b/classes/_octra_annotation.CTMConverter.html index 9d56645db..bb75e7e93 100644 --- a/classes/_octra_annotation.CTMConverter.html +++ b/classes/_octra_annotation.CTMConverter.html @@ -1,4 +1,4 @@ -CTMConverter | Octra libraries - v2.0.0

ClassCTMConverter

Hierarchy (view full)

Constructors

constructor +CTMConverter | Octra libraries - v2.0.0

ClassCTMConverter

Hierarchy (view full)

Constructors

constructor

Properties

_application _conversion _encoding @@ -20,16 +20,16 @@

Methods

export import needsOptionsForImport -

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

_name

_name: OctraAnnotationFormatType = 'CTM'

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

export

  • export(annotation, audiofile, levelnum): ExportResult

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

    +

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

_name

_name: OctraAnnotationFormatType = 'CTM'

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

export

import

  • import(file, audiofile): ImportResult

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

    +

Returns ExportResult

import

needsOptionsForImport

  • needsOptionsForImport(file, audiofile): any

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

    +

Returns ImportResult

needsOptionsForImport

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/_octra_annotation.Converter.html b/classes/_octra_annotation.Converter.html index dc7439abb..551a864b2 100644 --- a/classes/_octra_annotation.Converter.html +++ b/classes/_octra_annotation.Converter.html @@ -1,4 +1,4 @@ -Converter | Octra libraries - v2.0.0

ClassConverterAbstract

Hierarchy (view full)

Constructors

constructor +Converter | Octra libraries - v2.0.0

ClassConverterAbstract

Hierarchy (view full)

Constructors

constructor

Properties

_application _conversion _encoding @@ -20,16 +20,16 @@

Methods

export import needsOptionsForImport -

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

Protected_name

_name: OctraAnnotationFormatType

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

Abstractexport

  • export(annotation, audiofile, levelnum?): ExportResult

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

    +

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

Protected_name

_name: OctraAnnotationFormatType

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

Abstractexport

  • export(annotation, audiofile, levelnum?): 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

    • Optionallevelnum: number

      the level number for export returns resulted file or error.

      -

    Returns ExportResult

Abstractimport

  • import(file, audiofile, options?): ImportResult

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

    +

Returns ExportResult

Abstractimport

  • import(file, audiofile, options?): 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: any

    Returns ImportResult

AbstractneedsOptionsForImport

  • needsOptionsForImport(file, audiofile): any

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

    +
  • Optionaloptions: any

Returns ImportResult

AbstractneedsOptionsForImport

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/_octra_annotation.ELANConverter.html b/classes/_octra_annotation.ELANConverter.html index c93bc1690..83ebcea8a 100644 --- a/classes/_octra_annotation.ELANConverter.html +++ b/classes/_octra_annotation.ELANConverter.html @@ -1,4 +1,4 @@ -ELANConverter | Octra libraries - v2.0.0

ClassELANConverter

Hierarchy (view full)

Constructors

constructor +ELANConverter | Octra libraries - v2.0.0

ClassELANConverter

Hierarchy (view full)

Constructors

constructor

Properties

_application _conversion _encoding @@ -20,14 +20,14 @@

Methods

export import needsOptionsForImport -

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

_name

_name: OctraAnnotationFormatType = 'ELAN'

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

export

  • export(annotation, audiofile): ExportResult

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

    +

Constructors

constructor

Properties

Protected_application

_application: string = ''

Protected_conversion

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

Protected_encoding

_encoding: string = ''

Protected_extension

_extension: string = ''

Protected_multitiers

_multitiers: boolean = true

_name

_name: OctraAnnotationFormatType = 'ELAN'

Protected_notice

_notice: string = ''

Protected_website

_website: {
    title: string;
    url: string;
} = ...

defaultImportOptions

defaultImportOptions: any

options

options: any

Accessors

application

conversion

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

  • Returns {
        export: boolean;
        import: boolean;
    }

    • export: boolean
    • import: boolean

encoding

extension

multitiers

name

notice

website

  • get website(): {
        title: string;
        url: string;
    }

  • Returns {
        title: string;
        url: string;
    }

    • title: string
    • url: string

Methods

export

import

  • import(file, audiofile): ImportResult

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

    +

Returns ExportResult

import

needsOptionsForImport

  • needsOptionsForImport(file, audiofile): any

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

    +

Returns ImportResult

needsOptionsForImport

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/_octra_annotation.Link.html b/classes/_octra_annotation.Link.html index f1b0c9928..1b19ba1d6 100644 --- a/classes/_octra_annotation.Link.html +++ b/classes/_octra_annotation.Link.html @@ -1,4 +1,4 @@ -Link | Octra libraries - v2.0.0

ClassLink

Implements

Constructors

constructor +Link | Octra libraries - v2.0.0

ClassLink

Implements

Constructors

constructor

Properties

fromID toID -

Constructors

constructor

  • new Link(fromID, toID): Link

  • Parameters

    • fromID: number
    • toID: number

    Returns Link

Properties

fromID

fromID: number

toID

toID: number

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

  • new Link(fromID, toID): Link

  • Parameters

    • fromID: number
    • toID: number

    Returns Link

Properties

fromID

fromID: number

toID

toID: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/classes/_octra_annotation.OAnnotJSON.html b/classes/_octra_annotation.OAnnotJSON.html index 36b632ce7..934b4a941 100644 --- a/classes/_octra_annotation.OAnnotJSON.html +++ b/classes/_octra_annotation.OAnnotJSON.html @@ -1,4 +1,4 @@ -OAnnotJSON | Octra libraries - v2.0.0

ClassOAnnotJSON

Implements

Constructors

constructor +OAnnotJSON | Octra libraries - v2.0.0

ClassOAnnotJSON

Implements

Constructors

constructor

Properties

annotates levels links @@ -11,5 +11,5 @@ deserialize

Constructors

constructor

  • new OAnnotJSON(annotates, name, sampleRate, levels?, links?): OAnnotJSON

  • initiates a new AnnotJSON object

    Parameters

    • annotates: string
    • name: string

      file name WITHOUT extension

      -
    • sampleRate: number
    • Optionallevels: ILevel[]
    • Optionallinks: ILink[]

    Returns OAnnotJSON

Properties

annotates

annotates: string = ''

levels

levels: OAnyLevel<OSegment>[] = []

links

links: OLink[] = []

name

name: string = ''

name of the annotation file WITHOUT extension

-

sampleRate

sampleRate: number

Accessors

maxItemID

maxLevelID

Methods

deserialize

serialize

Staticdeserialize

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+
  • sampleRate: number
  • Optionallevels: ILevel[]
  • Optionallinks: ILink[]

    • Returns OAnnotJSON

    Properties

    annotates

    annotates: string = ''

    levels

    levels: OAnyLevel<OSegment>[] = []

    links

    links: OLink[] = []

    name

    name: string = ''

    name of the annotation file WITHOUT extension

    +

    sampleRate

    sampleRate: number

    Accessors

    maxItemID

    maxLevelID

    Methods

    deserialize

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.OEvent.html b/classes/_octra_annotation.OEvent.html index 6af7d733f..21cf0a515 100644 --- a/classes/_octra_annotation.OEvent.html +++ b/classes/_octra_annotation.OEvent.html @@ -1,4 +1,4 @@ -OEvent | Octra libraries - v2.0.0

    ClassOEvent

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OEvent | Octra libraries - v2.0.0

    ClassOEvent

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    id labels samplePoint @@ -9,4 +9,4 @@ isEqualWith serialize deserialize -

    Constructors

    constructor

    Properties

    id

    id: number = 0

    labels

    labels: OLabel[]

    samplePoint

    samplePoint: number

    Readonlytype

    type: "segment" | "event" | "item" = 'event'

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    id

    id: number = 0

    labels

    labels: OLabel[]

    samplePoint

    samplePoint: number

    Readonlytype

    type: "segment" | "event" | "item" = 'event'

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OEventLevel.html b/classes/_octra_annotation.OEventLevel.html index a69efb6b3..7805ecc26 100644 --- a/classes/_octra_annotation.OEventLevel.html +++ b/classes/_octra_annotation.OEventLevel.html @@ -1,4 +1,4 @@ -OEventLevel | Octra libraries - v2.0.0

    ClassOEventLevel

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OEventLevel | Octra libraries - v2.0.0

    ClassOEventLevel

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    items name type @@ -8,4 +8,4 @@ getRightSibling serialize deserialize -

    Constructors

    constructor

    Properties

    items

    items: OEvent[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    deserialize

    getLeftSibling

    getRightSibling

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    items

    items: OEvent[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    deserialize

    getLeftSibling

    getRightSibling

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OItem.html b/classes/_octra_annotation.OItem.html index 3b669deaa..fe920e2f2 100644 --- a/classes/_octra_annotation.OItem.html +++ b/classes/_octra_annotation.OItem.html @@ -1,4 +1,4 @@ -OItem | Octra libraries - v2.0.0

    ClassOItem

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OItem | Octra libraries - v2.0.0

    ClassOItem

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    id labels type @@ -8,4 +8,4 @@ isEqualWith serialize deserialize -

    Constructors

    constructor

    Properties

    id

    id: number = 0

    labels

    labels: OLabel[]

    Readonlytype

    type: "segment" | "event" | "item" = 'item'

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    id

    id: number = 0

    labels

    labels: OLabel[]

    Readonlytype

    type: "segment" | "event" | "item" = 'item'

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OItemLevel.html b/classes/_octra_annotation.OItemLevel.html index 54da82e55..aba83d974 100644 --- a/classes/_octra_annotation.OItemLevel.html +++ b/classes/_octra_annotation.OItemLevel.html @@ -1,4 +1,4 @@ -OItemLevel | Octra libraries - v2.0.0

    ClassOItemLevel

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OItemLevel | Octra libraries - v2.0.0

    ClassOItemLevel

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    items name type @@ -8,4 +8,4 @@ getRightSibling serialize deserialize -

    Constructors

    constructor

    Properties

    items

    items: OItem[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    deserialize

    getLeftSibling

    getRightSibling

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    items

    items: OItem[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    deserialize

    getLeftSibling

    getRightSibling

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OLabel.html b/classes/_octra_annotation.OLabel.html index e4043ab75..18601a502 100644 --- a/classes/_octra_annotation.OLabel.html +++ b/classes/_octra_annotation.OLabel.html @@ -1,7 +1,7 @@ -OLabel | Octra libraries - v2.0.0

    ClassOLabel

    Implements

    Constructors

    constructor +OLabel | Octra libraries - v2.0.0

    ClassOLabel

    Implements

    Constructors

    constructor

    Properties

    name value

    Methods

    deserialize serialize deserialize -

    Constructors

    constructor

    Properties

    name

    name: string = ''

    value

    value: string = ''

    Methods

    deserialize

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    name

    name: string = ''

    value

    value: string = ''

    Methods

    deserialize

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OLevel.html b/classes/_octra_annotation.OLevel.html index 9bc3bb80d..d24e74b0c 100644 --- a/classes/_octra_annotation.OLevel.html +++ b/classes/_octra_annotation.OLevel.html @@ -1,8 +1,8 @@ -OLevel | Octra libraries - v2.0.0

    ClassOLevel<T>

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OLevel | Octra libraries - v2.0.0

    ClassOLevel<T>

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    items name type

    Methods

    clone getLeftSibling getRightSibling -

    Constructors

    constructor

    Properties

    items

    items: T[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    getLeftSibling

    • getLeftSibling(index): undefined | T

    • Parameters

      • index: number

      Returns undefined | T

    getRightSibling

    • getRightSibling(index): undefined | T

    • Parameters

      • index: number

      Returns undefined | T

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    items

    items: T[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    getLeftSibling

    • getLeftSibling(index): undefined | T

    • Parameters

      • index: number

      Returns undefined | T

    getRightSibling

    • getRightSibling(index): undefined | T

    • Parameters

      • index: number

      Returns undefined | T

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OLink.html b/classes/_octra_annotation.OLink.html index 07a9e0a6b..e9ebce4c5 100644 --- a/classes/_octra_annotation.OLink.html +++ b/classes/_octra_annotation.OLink.html @@ -1,8 +1,8 @@ -OLink | Octra libraries - v2.0.0

    ClassOLink

    Implements

    Constructors

    constructor +OLink | Octra libraries - v2.0.0

    ClassOLink

    Implements

    Constructors

    constructor

    Properties

    fromID toID

    Methods

    clone deserialize serialize deserialize -

    Constructors

    constructor

    Properties

    fromID

    fromID: number

    toID

    toID: number

    Methods

    clone

    deserialize

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    fromID

    fromID: number

    toID

    toID: number

    Methods

    clone

    deserialize

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OSegment.html b/classes/_octra_annotation.OSegment.html index d51d75c5c..d8981778f 100644 --- a/classes/_octra_annotation.OSegment.html +++ b/classes/_octra_annotation.OSegment.html @@ -1,4 +1,4 @@ -OSegment | Octra libraries - v2.0.0

    ClassOSegment

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OSegment | Octra libraries - v2.0.0

    ClassOSegment

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    id labels sampleDur @@ -10,4 +10,4 @@ isEqualWith serialize deserialize -

    Constructors

    constructor

    Properties

    id

    id: number = 0

    labels

    labels: OLabel[]

    sampleDur

    sampleDur: number = 0

    sampleStart

    sampleStart: number = 0

    Readonlytype

    type: "segment" | "event" | "item" = 'item'

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    id

    id: number = 0

    labels

    labels: OLabel[]

    sampleDur

    sampleDur: number = 0

    sampleStart

    sampleStart: number = 0

    Readonlytype

    type: "segment" | "event" | "item" = 'item'

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OSegmentLevel.html b/classes/_octra_annotation.OSegmentLevel.html index 8bc36e34f..e0bea1841 100644 --- a/classes/_octra_annotation.OSegmentLevel.html +++ b/classes/_octra_annotation.OSegmentLevel.html @@ -1,4 +1,4 @@ -OSegmentLevel | Octra libraries - v2.0.0

    ClassOSegmentLevel<T>

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OSegmentLevel | Octra libraries - v2.0.0

    ClassOSegmentLevel<T>

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    items name type @@ -8,4 +8,4 @@ getRightSibling serialize deserialize -

    Constructors

    constructor

    Properties

    items

    items: T[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    deserialize

    getLeftSibling

    getRightSibling

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    items

    items: T[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    deserialize

    getLeftSibling

    getRightSibling

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OctraAnnotation.html b/classes/_octra_annotation.OctraAnnotation.html index 873d76372..1d58efa6f 100644 --- a/classes/_octra_annotation.OctraAnnotation.html +++ b/classes/_octra_annotation.OctraAnnotation.html @@ -1,4 +1,4 @@ -OctraAnnotation | Octra libraries - v2.0.0

    ClassOctraAnnotation<S, T>

    Type Parameters

    Constructors

    constructor +OctraAnnotation | Octra libraries - v2.0.0

    ClassOctraAnnotation<S, T>

    Type Parameters

    Constructors

    constructor

    Accessors

    currentLevel idCounters levels @@ -35,4 +35,4 @@ serialize updateIDCounters deserialize -

    Constructors

    constructor

    Accessors

    currentLevel

    idCounters

    • get idCounters(): {
          item: number;
          level: number;
          link: number;
      }

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

      • item: number
      • level: number
      • link: number

    levels

    links

    selectedLevelIndex

    • get selectedLevelIndex(): undefined | number

    • Returns undefined | number

    Methods

    addItemToCurrentLevel

    addLevel

    addLink

    • addLink(fromID, toID): void

    • Parameters

      • fromID: number
      • toID: number

      Returns void

    changeCurrentItemById

    changeCurrentItemByIndex

    changeCurrentLevelIndex

    changeCurrentSegmentBySamplePosition

    changeLevelById

    changeLevelByIndex

    changeLevelIndex

    changeLevelNameByIndex

    changeLinkById

    changeLinkByIndex

    • changeLinkByIndex(index, oLink): void

    • Parameters

      • index: number
      • oLink: OLink

      Returns void

    changeSampleRate

    clearAllItemsFromCurrentLevel

    clone

    combineSegments

    • combineSegments(segmentIndexStart, segmentIndexEnd, breakMarker): void

    • Parameters

      • segmentIndexStart: number
      • segmentIndexEnd: number
      • breakMarker: string

      Returns void

    createEventLevel

    createItemLevel

    createSegment

    createSegmentLevel

    deserialize

    duplicateLevel

    getCurrentSegmentIndexBySamplePosition

    getItemById

    removeItemById

    removeItemByIndex

    removeLevel

    serialize

    updateIDCounters

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Constructors

    constructor

    Accessors

    currentLevel

    idCounters

    • get idCounters(): {
          item: number;
          level: number;
          link: number;
      }

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

      • item: number
      • level: number
      • link: number

    levels

    links

    selectedLevelIndex

    • get selectedLevelIndex(): undefined | number

    • Returns undefined | number

    Methods

    addItemToCurrentLevel

    addLevel

    addLink

    • addLink(fromID, toID): void

    • Parameters

      • fromID: number
      • toID: number

      Returns void

    changeCurrentItemById

    changeCurrentItemByIndex

    changeCurrentLevelIndex

    changeCurrentSegmentBySamplePosition

    changeLevelById

    changeLevelByIndex

    changeLevelIndex

    changeLevelNameByIndex

    changeLinkById

    changeLinkByIndex

    • changeLinkByIndex(index, oLink): void

    • Parameters

      • index: number
      • oLink: OLink

      Returns void

    changeSampleRate

    clearAllItemsFromCurrentLevel

    clone

    combineSegments

    • combineSegments(segmentIndexStart, segmentIndexEnd, breakMarker): void

    • Parameters

      • segmentIndexStart: number
      • segmentIndexEnd: number
      • breakMarker: string

      Returns void

    createEventLevel

    createItemLevel

    createSegment

    createSegmentLevel

    deserialize

    duplicateLevel

    getCurrentSegmentIndexBySamplePosition

    getItemById

    removeItemById

    removeItemByIndex

    removeLevel

    serialize

    updateIDCounters

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.OctraAnnotationEvent.html b/classes/_octra_annotation.OctraAnnotationEvent.html index d810e5888..298056b0f 100644 --- a/classes/_octra_annotation.OctraAnnotationEvent.html +++ b/classes/_octra_annotation.OctraAnnotationEvent.html @@ -1,4 +1,4 @@ -OctraAnnotationEvent | Octra libraries - v2.0.0

    ClassOctraAnnotationEvent

    Implements

    Constructors

    constructor +OctraAnnotationEvent | Octra libraries - v2.0.0

    ClassOctraAnnotationEvent

    Implements

    Constructors

    constructor

    Properties

    id labels samplePoint @@ -9,4 +9,4 @@ isEqualWith serialize deserialize -

    Constructors

    constructor

    Properties

    id

    id: number

    labels

    labels: OLabel[] = []

    samplePoint

    samplePoint: SampleUnit

    Readonlytype

    type: "segment" | "event" | "item" = 'event'

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    id

    id: number

    labels

    labels: OLabel[] = []

    samplePoint

    samplePoint: SampleUnit

    Readonlytype

    type: "segment" | "event" | "item" = 'event'

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Staticdeserialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OctraAnnotationEventLevel.html b/classes/_octra_annotation.OctraAnnotationEventLevel.html index b4182034f..f5a080219 100644 --- a/classes/_octra_annotation.OctraAnnotationEventLevel.html +++ b/classes/_octra_annotation.OctraAnnotationEventLevel.html @@ -1,4 +1,4 @@ -OctraAnnotationEventLevel | Octra libraries - v2.0.0

    ClassOctraAnnotationEventLevel

    Constructors

    constructor +OctraAnnotationEventLevel | Octra libraries - v2.0.0

    ClassOctraAnnotationEventLevel

    Constructors

    constructor

    Properties

    id items name @@ -11,4 +11,4 @@ getRightSibling overwriteItems serialize -

    Constructors

    constructor

    Properties

    id

    id: number

    items

    items: OctraAnnotationEvent[]

    name

    name: string

    type

    type: AnnotationLevelType = AnnotationLevelType.EVENT

    Methods

    changeItem

    clear

    clone

    duplicate

    getLeftSibling

    getRightSibling

    overwriteItems

    serialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    id

    id: number

    items

    items: OctraAnnotationEvent[]

    name

    name: string

    type

    type: AnnotationLevelType = AnnotationLevelType.EVENT

    Methods

    changeItem

    clear

    clone

    duplicate

    getLeftSibling

    getRightSibling

    overwriteItems

    serialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_annotation.OctraAnnotationItemLevel.html b/classes/_octra_annotation.OctraAnnotationItemLevel.html index cd69d6c6b..3b4dee3f8 100644 --- a/classes/_octra_annotation.OctraAnnotationItemLevel.html +++ b/classes/_octra_annotation.OctraAnnotationItemLevel.html @@ -1,4 +1,4 @@ -OctraAnnotationItemLevel | Octra libraries - v2.0.0

    ClassOctraAnnotationItemLevel

    Hierarchy (view full)

    Constructors

    constructor +OctraAnnotationItemLevel | Octra libraries - v2.0.0

    ClassOctraAnnotationItemLevel

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _id level

    Accessors

    id @@ -14,4 +14,4 @@ getRightSibling overwriteItems serialize -

    Constructors

    constructor

    Properties

    Protected_id

    _id: number

    level

    level: OItemLevel

    Accessors

    id

    • get id(): number

    • Returns number

    items

    • get items(): S[]

    • Returns S[]

    name

    • get name(): string

    • Returns string

    • set name(value): void

    • Parameters

      • value: string

      Returns void

    sortorder

    • get sortorder(): number

    • Returns number

    type

    Methods

    changeItem

    clear

    clone

    duplicate

    getLeftSibling

    getRightSibling

    overwriteItems

    serialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_id

    _id: number

    level

    level: OItemLevel

    Accessors

    id

    • get id(): number

    • Returns number

    items

    • get items(): S[]

    • Returns S[]

    name

    • get name(): string

    • Returns string

    • set name(value): void

    • Parameters

      • value: string

      Returns void

    sortorder

    • get sortorder(): number

    • Returns number

    type

    Methods

    changeItem

    clear

    clone

    duplicate

    getLeftSibling

    getRightSibling

    overwriteItems

    serialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.OctraAnnotationLevel.html b/classes/_octra_annotation.OctraAnnotationLevel.html index 1ef2913f1..f62615e2a 100644 --- a/classes/_octra_annotation.OctraAnnotationLevel.html +++ b/classes/_octra_annotation.OctraAnnotationLevel.html @@ -1,4 +1,4 @@ -OctraAnnotationLevel | Octra libraries - v2.0.0

    ClassOctraAnnotationLevel<T, S>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +OctraAnnotationLevel | Octra libraries - v2.0.0

    ClassOctraAnnotationLevel<T, S>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _id level

    Accessors

    id @@ -13,4 +13,4 @@ getRightSibling overwriteItems serialize -

    Constructors

    constructor

    Properties

    Protected_id

    _id: number

    level

    level: T

    Accessors

    id

    items

    name

    sortorder

    type

    Methods

    changeItem

    clear

    duplicate

    getLeftSibling

    • getLeftSibling(index): undefined | S

    • Parameters

      • index: number

      Returns undefined | S

    getRightSibling

    • getRightSibling(index): undefined | S

    • Parameters

      • index: number

      Returns undefined | S

    overwriteItems

    serialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_id

    _id: number

    level

    level: T

    Accessors

    id

    items

    name

    sortorder

    type

    Methods

    changeItem

    clear

    duplicate

    getLeftSibling

    • getLeftSibling(index): undefined | S

    • Parameters

      • index: number

      Returns undefined | S

    getRightSibling

    • getRightSibling(index): undefined | S

    • Parameters

      • index: number

      Returns undefined | S

    overwriteItems

    serialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.OctraAnnotationLink.html b/classes/_octra_annotation.OctraAnnotationLink.html index de1428517..183aa2637 100644 --- a/classes/_octra_annotation.OctraAnnotationLink.html +++ b/classes/_octra_annotation.OctraAnnotationLink.html @@ -1,5 +1,5 @@ -OctraAnnotationLink | Octra libraries - v2.0.0

    ClassOctraAnnotationLink

    Constructors

    constructor +OctraAnnotationLink | Octra libraries - v2.0.0

    ClassOctraAnnotationLink

    Constructors

    constructor

    Accessors

    id link

    Methods

    clone -

    Constructors

    constructor

    Accessors

    id

    link

    Methods

    clone

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Constructors

    constructor

    Accessors

    id

    link

    Methods

    clone

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.OctraAnnotationSegment.html b/classes/_octra_annotation.OctraAnnotationSegment.html index 08bc97b17..3295d1911 100644 --- a/classes/_octra_annotation.OctraAnnotationSegment.html +++ b/classes/_octra_annotation.OctraAnnotationSegment.html @@ -1,4 +1,4 @@ -OctraAnnotationSegment | Octra libraries - v2.0.0

    ClassOctraAnnotationSegment<T>

    Type Parameters

    Implements

    Constructors

    constructor +OctraAnnotationSegment | Octra libraries - v2.0.0

    ClassOctraAnnotationSegment<T>

    Type Parameters

    Implements

    Constructors

    constructor

    Properties

    context? labels time @@ -15,4 +15,4 @@ serializeToOSegment deserialize deserializeFromOSegment -

    Constructors

    constructor

    Properties

    Optionalcontext

    context?: T

    labels

    labels: OLabel[]

    time

    time: SampleUnit

    Readonlytype

    type: "segment" | "event" | "item" = 'segment'

    Accessors

    id

    Methods

    changeFirstLabelWithoutName

    • changeFirstLabelWithoutName(notName, value): boolean

    • Parameters

      • notName: string
      • value: string

      Returns boolean

    changeLabel

    clone

    deserialize

    getFirstLabelWithoutName

    getLabel

    isEqualWith

    serialize

    serializeToOSegment

    Staticdeserialize

    StaticdeserializeFromOSegment

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Optionalcontext

    context?: T

    labels

    labels: OLabel[]

    time

    time: SampleUnit

    Readonlytype

    type: "segment" | "event" | "item" = 'segment'

    Accessors

    id

    Methods

    changeFirstLabelWithoutName

    • changeFirstLabelWithoutName(notName, value): boolean

    • Parameters

      • notName: string
      • value: string

      Returns boolean

    changeLabel

    clone

    deserialize

    getFirstLabelWithoutName

    getLabel

    isEqualWith

    serialize

    serializeToOSegment

    Staticdeserialize

    StaticdeserializeFromOSegment

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.OctraAnnotationSegmentLevel.html b/classes/_octra_annotation.OctraAnnotationSegmentLevel.html index 0dcbae12d..4fb836792 100644 --- a/classes/_octra_annotation.OctraAnnotationSegmentLevel.html +++ b/classes/_octra_annotation.OctraAnnotationSegmentLevel.html @@ -1,4 +1,4 @@ -OctraAnnotationSegmentLevel | Octra libraries - v2.0.0

    ClassOctraAnnotationSegmentLevel<T>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +OctraAnnotationSegmentLevel | Octra libraries - v2.0.0

    ClassOctraAnnotationSegmentLevel<T>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _id level

    Accessors

    id @@ -14,4 +14,4 @@ getRightSibling overwriteItems serialize -

    Constructors

    constructor

    Properties

    Protected_id

    _id: number

    level

    level: OLevel<T>

    Accessors

    id

    • get id(): number

    • Returns number

    items

    • get items(): S[]

    • Returns S[]

    name

    • get name(): string

    • Returns string

    • set name(value): void

    • Parameters

      • value: string

      Returns void

    sortorder

    • get sortorder(): number

    • Returns number

    type

    Methods

    changeItem

    clear

    clone

    duplicate

    getLeftSibling

    getRightSibling

    overwriteItems

    serialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_id

    _id: number

    level

    level: OLevel<T>

    Accessors

    id

    • get id(): number

    • Returns number

    items

    • get items(): S[]

    • Returns S[]

    name

    • get name(): string

    • Returns string

    • set name(value): void

    • Parameters

      • value: string

      Returns void

    sortorder

    • get sortorder(): number

    • Returns number

    type

    Methods

    changeItem

    clear

    clone

    duplicate

    getLeftSibling

    getRightSibling

    overwriteItems

    serialize

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.PartiturConverter.html b/classes/_octra_annotation.PartiturConverter.html index cf0eddf67..076bc339f 100644 --- a/classes/_octra_annotation.PartiturConverter.html +++ b/classes/_octra_annotation.PartiturConverter.html @@ -1,4 +1,4 @@ -PartiturConverter | Octra libraries - v2.0.0

    ClassPartiturConverter

    Hierarchy (view full)

    Constructors

    constructor +PartiturConverter | Octra libraries - v2.0.0

    ClassPartiturConverter

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _application _conversion _encoding @@ -20,16 +20,16 @@

    Methods

    export import needsOptionsForImport -

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'BASPartitur'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    • export(annotation, audiofile, levelnum?): ExportResult

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

      +

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'BASPartitur'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    import

    • import(file, audiofile): ImportResult

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

      +

    Returns ExportResult

    import

    needsOptionsForImport

    • needsOptionsForImport(file, audiofile): any

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

      +

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.PraatTableConverter.html b/classes/_octra_annotation.PraatTableConverter.html index 2229de688..d59c05d4d 100644 --- a/classes/_octra_annotation.PraatTableConverter.html +++ b/classes/_octra_annotation.PraatTableConverter.html @@ -1,4 +1,4 @@ -PraatTableConverter | Octra libraries - v2.0.0

    ClassPraatTableConverter

    Hierarchy (view full)

    Constructors

    constructor +PraatTableConverter | Octra libraries - v2.0.0

    ClassPraatTableConverter

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _application _conversion _encoding @@ -20,13 +20,13 @@

    Methods

    export import needsOptionsForImport -

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'PraatTextTable'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    • export(annotation): ExportResult

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

      +

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'PraatTextTable'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    import

    • import(file, audiofile): ImportResult

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

      +

    Returns ExportResult

    import

    needsOptionsForImport

    • needsOptionsForImport(file, audiofile): any

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

      +

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.PraatTextgridConverter.html b/classes/_octra_annotation.PraatTextgridConverter.html index 554382824..331da0102 100644 --- a/classes/_octra_annotation.PraatTextgridConverter.html +++ b/classes/_octra_annotation.PraatTextgridConverter.html @@ -1,4 +1,4 @@ -PraatTextgridConverter | Octra libraries - v2.0.0

    ClassPraatTextgridConverter

    Hierarchy (view full)

    Constructors

    constructor +PraatTextgridConverter | Octra libraries - v2.0.0

    ClassPraatTextgridConverter

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _application _conversion _encoding @@ -20,14 +20,14 @@

    Methods

    export import needsOptionsForImport -

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'TextGrid'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    • export(annotation, audiofile): ExportResult

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

      +

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'TextGrid'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    import

    • import(file, audiofile): ImportResult

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

      +

    Returns ExportResult

    import

    needsOptionsForImport

    • needsOptionsForImport(file, audiofile): any

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

      +

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.SRTConverter.html b/classes/_octra_annotation.SRTConverter.html index d907e3593..37dbeef42 100644 --- a/classes/_octra_annotation.SRTConverter.html +++ b/classes/_octra_annotation.SRTConverter.html @@ -1,4 +1,4 @@ -SRTConverter | Octra libraries - v2.0.0

    ClassSRTConverter

    Hierarchy (view full)

    Constructors

    constructor +SRTConverter | Octra libraries - v2.0.0

    ClassSRTConverter

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _application _conversion _encoding @@ -23,16 +23,16 @@ import needsOptionsForImport getSamplesFromTimeString -

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'SRT'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: SRTConverterImportOptions = ...

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    • export(annotation, audiofile, levelnum): ExportResult

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

      +

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'SRT'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: SRTConverterImportOptions = ...

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    formatNumber

    getTimeStringFromSamples

    • getTimeStringFromSamples(samples, sampleRate): string

    • Parameters

      • samples: number
      • sampleRate: number

      Returns string

    import

    • import(file, audiofile, options?): ImportResult

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

      +

    Returns ExportResult

    formatNumber

    getTimeStringFromSamples

    • getTimeStringFromSamples(samples, sampleRate): string

    • Parameters

      • samples: number
      • sampleRate: number

      Returns string

    import

    needsOptionsForImport

    • needsOptionsForImport(file, audiofile): any

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

      +
    • options: SRTConverterImportOptions = ...

    Returns ImportResult

    needsOptionsForImport

    StaticgetSamplesFromTimeString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    StaticgetSamplesFromTimeString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.SRTConverterImportOptions.html b/classes/_octra_annotation.SRTConverterImportOptions.html index 84a4f5d54..d14112269 100644 --- a/classes/_octra_annotation.SRTConverterImportOptions.html +++ b/classes/_octra_annotation.SRTConverterImportOptions.html @@ -1,5 +1,5 @@ -SRTConverterImportOptions | Octra libraries - v2.0.0

    ClassSRTConverterImportOptions

    Constructors

    constructor +SRTConverterImportOptions | Octra libraries - v2.0.0

    ClassSRTConverterImportOptions

    Constructors

    constructor

    Properties

    combineSegmentsWithSameSpeakerThreshold? sortSpeakerSegments speakerIdentifierPattern? -

    Constructors

    constructor

    Properties

    OptionalcombineSegmentsWithSameSpeakerThreshold

    combineSegmentsWithSameSpeakerThreshold?: number

    sortSpeakerSegments

    sortSpeakerSegments: boolean = false

    OptionalspeakerIdentifierPattern

    speakerIdentifierPattern?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    OptionalcombineSegmentsWithSameSpeakerThreshold

    combineSegmentsWithSameSpeakerThreshold?: number

    sortSpeakerSegments

    sortSpeakerSegments: boolean = false

    OptionalspeakerIdentifierPattern

    speakerIdentifierPattern?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_annotation.TextConverter.html b/classes/_octra_annotation.TextConverter.html index 57259e61d..4fa9accf0 100644 --- a/classes/_octra_annotation.TextConverter.html +++ b/classes/_octra_annotation.TextConverter.html @@ -1,4 +1,4 @@ -TextConverter | Octra libraries - v2.0.0

    ClassTextConverter

    Hierarchy (view full)

    Constructors

    constructor +TextConverter | Octra libraries - v2.0.0

    ClassTextConverter

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _application _conversion _encoding @@ -21,18 +21,18 @@ export import needsOptionsForImport -

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'PlainText'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: {
        showTimestampSamples: boolean;
        showTimestampString: boolean;
    } = ...

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    convertToTimeString

    • convertToTimeString(value, args?): string

    • transforms milliseconds to time string

      +

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'PlainText'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: {
        showTimestampSamples: boolean;
        showTimestampString: boolean;
    } = ...

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    convertToTimeString

    • convertToTimeString(value, args?): string

    • transforms milliseconds to time string

      Parameters

      • value: number

        number or milliseconds

        -
      • Optionalargs: {
            maxDuration?: number;
            showHour?: boolean;
            showMilliSeconds?: boolean;
        }
        • OptionalmaxDuration?: number
        • OptionalshowHour?: boolean
        • OptionalshowMilliSeconds?: boolean

      Returns string

    export

    • export(annotation, audiofile, levelnum): ExportResult

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

      +
    • Optionalargs: {
          maxDuration?: number;
          showHour?: boolean;
          showMilliSeconds?: boolean;
      }
      • OptionalmaxDuration?: number
      • OptionalshowHour?: boolean
      • OptionalshowMilliSeconds?: boolean

    Returns string

    export

    import

    • import(file, audiofile): ImportResult

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

      +

    Returns ExportResult

    import

    needsOptionsForImport

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.WebVTTConverter.html b/classes/_octra_annotation.WebVTTConverter.html index 55ca321ee..3bc66b92d 100644 --- a/classes/_octra_annotation.WebVTTConverter.html +++ b/classes/_octra_annotation.WebVTTConverter.html @@ -1,4 +1,4 @@ -WebVTTConverter | Octra libraries - v2.0.0

    ClassWebVTTConverter

    Hierarchy (view full)

    Constructors

    constructor +WebVTTConverter | Octra libraries - v2.0.0

    ClassWebVTTConverter

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _application _conversion _encoding @@ -23,16 +23,16 @@ getTimeStringFromSamples import needsOptionsForImport -

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'WebVTT'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    • export(annotation, audiofile, levelnum): ExportResult

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

      +

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'WebVTT'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    formatNumber

    getSamplesFromTimeString

    getTimeStringFromSamples

    import

    • import(file, audiofile): ImportResult

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

      +

    Returns ExportResult

    formatNumber

    getSamplesFromTimeString

    getTimeStringFromSamples

    import

    needsOptionsForImport

    • needsOptionsForImport(file, audiofile): any

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

      +

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.WhisperJSON.html b/classes/_octra_annotation.WhisperJSON.html index cba00f6cd..a416457f3 100644 --- a/classes/_octra_annotation.WhisperJSON.html +++ b/classes/_octra_annotation.WhisperJSON.html @@ -1,6 +1,6 @@ -WhisperJSON | Octra libraries - v2.0.0

    ClassWhisperJSON

    Constructors

    constructor +WhisperJSON | Octra libraries - v2.0.0

    ClassWhisperJSON

    Constructors

    constructor

    Properties

    language segments text? word_segments? -

    Constructors

    constructor

    Properties

    language

    language: string

    segments

    segments: WhisperJSONSegment[]

    Optionaltext

    text?: string

    Optionalword_segments

    word_segments?: WhisperJSONWord[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    language

    language: string

    segments

    segments: WhisperJSONSegment[]

    Optionaltext

    text?: string

    Optionalword_segments

    word_segments?: WhisperJSONWord[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_annotation.WhisperJSONConverter.html b/classes/_octra_annotation.WhisperJSONConverter.html index 165568e3d..1439a6ca9 100644 --- a/classes/_octra_annotation.WhisperJSONConverter.html +++ b/classes/_octra_annotation.WhisperJSONConverter.html @@ -1,4 +1,4 @@ -WhisperJSONConverter | Octra libraries - v2.0.0

    ClassWhisperJSONConverter

    Hierarchy (view full)

    Constructors

    constructor +WhisperJSONConverter | Octra libraries - v2.0.0

    ClassWhisperJSONConverter

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _application _conversion _encoding @@ -20,14 +20,14 @@

    Methods

    export import needsOptionsForImport -

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'WhisperJSON'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    • export(annotation, audiofile): ExportResult

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

      +

    Constructors

    constructor

    Properties

    Protected_application

    _application: string = ''

    Protected_conversion

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

    Protected_encoding

    _encoding: string = ''

    Protected_extension

    _extension: string = ''

    Protected_multitiers

    _multitiers: boolean = true

    _name

    _name: OctraAnnotationFormatType = 'WhisperJSON'

    Protected_notice

    _notice: string = ''

    Protected_website

    _website: {
        title: string;
        url: string;
    } = ...

    defaultImportOptions

    defaultImportOptions: any

    options

    options: any

    Accessors

    application

    conversion

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

    • Returns {
          export: boolean;
          import: boolean;
      }

      • export: boolean
      • import: boolean

    encoding

    extension

    multitiers

    name

    notice

    website

    • get website(): {
          title: string;
          url: string;
      }

    • Returns {
          title: string;
          url: string;
      }

      • title: string
      • url: string

    Methods

    export

    import

    • import(file, audiofile): ImportResult

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

      +

    Returns ExportResult

    import

    needsOptionsForImport

    • needsOptionsForImport(file, audiofile): any

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

      +

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_annotation.WhisperJSONSegment.html b/classes/_octra_annotation.WhisperJSONSegment.html index 9e4b29ee4..4c4eaa31c 100644 --- a/classes/_octra_annotation.WhisperJSONSegment.html +++ b/classes/_octra_annotation.WhisperJSONSegment.html @@ -1,4 +1,4 @@ -WhisperJSONSegment | Octra libraries - v2.0.0

    ClassWhisperJSONSegment

    Constructors

    constructor +WhisperJSONSegment | Octra libraries - v2.0.0

    ClassWhisperJSONSegment

    Constructors

    constructor

    Properties

    avg_logprob? compression_ratio? end @@ -11,4 +11,4 @@ text tokens? words -

    Constructors

    constructor

    Properties

    Optionalavg_logprob

    avg_logprob?: number

    Optionalcompression_ratio

    compression_ratio?: number

    end

    end: number

    Optionalid

    id?: number

    Optionalno_speech_prob

    no_speech_prob?: number

    Optionalseek

    seek?: number

    Optionalspeaker

    speaker?: string

    start

    start: number

    Optionaltemperature

    temperature?: number

    text

    text: string

    Optionaltokens

    tokens?: number[]

    words

    words: WhisperJSONWord[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    Optionalavg_logprob

    avg_logprob?: number

    Optionalcompression_ratio

    compression_ratio?: number

    end

    end: number

    Optionalid

    id?: number

    Optionalno_speech_prob

    no_speech_prob?: number

    Optionalseek

    seek?: number

    Optionalspeaker

    speaker?: string

    start

    start: number

    Optionaltemperature

    temperature?: number

    text

    text: string

    Optionaltokens

    tokens?: number[]

    words

    words: WhisperJSONWord[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_json_sets.DecisionTreeCombination.html b/classes/_octra_json_sets.DecisionTreeCombination.html index ebd100cf6..de598d1a7 100644 --- a/classes/_octra_json_sets.DecisionTreeCombination.html +++ b/classes/_octra_json_sets.DecisionTreeCombination.html @@ -1,4 +1,4 @@ -DecisionTreeCombination | Octra libraries - v2.0.0

    ClassDecisionTreeCombination<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +DecisionTreeCombination | Octra libraries - v2.0.0

    ClassDecisionTreeCombination<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _errors _id _parent? @@ -21,4 +21,4 @@ validate json2tree json2treeCombination -

    Constructors

    constructor

    Properties

    _errors

    _errors: JSONSetValidationError<T>[] = []

    Protected Readonly_id

    _id: number

    Protected Optional Readonly_parent

    _parent?: DecisionTreeCombination<T, U>

    Protected_possibleSelections

    _possibleSelections: PossibleSolution<T, U>[][] = []

    Protected Readonlyblueprint

    blueprint: JSONSetBlueprint<T, U>

    children

    children: DecisionTreeNode<T, U>[] = []

    combination

    combination: "and" | "or"

    Accessors

    description

    • get description(): undefined | string

    • Returns undefined | string

    id

    name

    • get name(): undefined | string

    • Returns undefined | string

    path

    • get path(): string

    • Returns string

    possibleSelections

    Methods

    append

    clone

    insert

    outputSolutions

    ProtectedpowArray

    remove

    removeById

    validate

    Staticjson2tree

    Staticjson2treeCombination

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    _errors

    _errors: JSONSetValidationError<T>[] = []

    Protected Readonly_id

    _id: number

    Protected Optional Readonly_parent

    _parent?: DecisionTreeCombination<T, U>

    Protected_possibleSelections

    _possibleSelections: PossibleSolution<T, U>[][] = []

    Protected Readonlyblueprint

    blueprint: JSONSetBlueprint<T, U>

    children

    children: DecisionTreeNode<T, U>[] = []

    combination

    combination: "and" | "or"

    Accessors

    description

    • get description(): undefined | string

    • Returns undefined | string

    id

    name

    • get name(): undefined | string

    • Returns undefined | string

    path

    • get path(): string

    • Returns string

    possibleSelections

    Methods

    append

    clone

    insert

    outputSolutions

    ProtectedpowArray

    remove

    removeById

    validate

    Staticjson2tree

    Staticjson2treeCombination

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_json_sets.DecisionTreeExpression.html b/classes/_octra_json_sets.DecisionTreeExpression.html index 3d067f749..11982410b 100644 --- a/classes/_octra_json_sets.DecisionTreeExpression.html +++ b/classes/_octra_json_sets.DecisionTreeExpression.html @@ -1,4 +1,4 @@ -DecisionTreeExpression | Octra libraries - v2.0.0

    ClassDecisionTreeExpression<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +DecisionTreeExpression | Octra libraries - v2.0.0

    ClassDecisionTreeExpression<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _errors _id _parent? @@ -16,4 +16,4 @@ powArray validate json2tree -

    Constructors

    constructor

    Properties

    _errors

    _errors: JSONSetValidationError<T>[] = []

    Protected Readonly_id

    _id: number

    Protected Optional Readonly_parent

    _parent?: DecisionTreeCombination<T, U>

    Protected_possibleSelections

    _possibleSelections: PossibleSolution<T, U>[][] = []

    Protected Readonlyblueprint

    blueprint: JSONSetBlueprint<T, U>

    statement

    statement: JSONSetStatement<U>

    validItem

    validItem: boolean = false

    Accessors

    description

    • get description(): undefined | string

    • Returns undefined | string

    id

    name

    • get name(): undefined | string

    • Returns undefined | string

    path

    • get path(): string

    • Returns string

    possibleSelections

    Methods

    clone

    outputSolutions

    ProtectedpowArray

    validate

    Staticjson2tree

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    _errors

    _errors: JSONSetValidationError<T>[] = []

    Protected Readonly_id

    _id: number

    Protected Optional Readonly_parent

    _parent?: DecisionTreeCombination<T, U>

    Protected_possibleSelections

    _possibleSelections: PossibleSolution<T, U>[][] = []

    Protected Readonlyblueprint

    blueprint: JSONSetBlueprint<T, U>

    statement

    statement: JSONSetStatement<U>

    validItem

    validItem: boolean = false

    Accessors

    description

    • get description(): undefined | string

    • Returns undefined | string

    id

    name

    • get name(): undefined | string

    • Returns undefined | string

    path

    • get path(): string

    • Returns string

    possibleSelections

    Methods

    clone

    outputSolutions

    ProtectedpowArray

    validate

    Staticjson2tree

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_json_sets.DecisionTreeNode.html b/classes/_octra_json_sets.DecisionTreeNode.html index 441b8d7ed..b66d64161 100644 --- a/classes/_octra_json_sets.DecisionTreeNode.html +++ b/classes/_octra_json_sets.DecisionTreeNode.html @@ -1,4 +1,4 @@ -DecisionTreeNode | Octra libraries - v2.0.0

    ClassDecisionTreeNode<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +DecisionTreeNode | Octra libraries - v2.0.0

    ClassDecisionTreeNode<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _errors _id _parent? @@ -14,4 +14,4 @@ powArray validate json2tree -

    Constructors

    constructor

    Properties

    _errors

    _errors: JSONSetValidationError<T>[] = []

    Protected Readonly_id

    _id: number

    Protected Optional Readonly_parent

    _parent?: DecisionTreeCombination<T, U>

    Protected_possibleSelections

    _possibleSelections: PossibleSolution<T, U>[][] = []

    Protected Readonlyblueprint

    blueprint: JSONSetBlueprint<T, U>

    Accessors

    description

    id

    name

    path

    possibleSelections

    Methods

    clone

    outputSolutions

    ProtectedpowArray

    • powArray<T>(array, start, end): T[][]

    • Type Parameters

      • T

      Parameters

      • array: T[]
      • start: number
      • end: number

      Returns T[][]

    validate

    Staticjson2tree

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    _errors

    _errors: JSONSetValidationError<T>[] = []

    Protected Readonly_id

    _id: number

    Protected Optional Readonly_parent

    _parent?: DecisionTreeCombination<T, U>

    Protected_possibleSelections

    _possibleSelections: PossibleSolution<T, U>[][] = []

    Protected Readonlyblueprint

    blueprint: JSONSetBlueprint<T, U>

    Accessors

    description

    id

    name

    path

    possibleSelections

    Methods

    clone

    outputSolutions

    ProtectedpowArray

    • powArray<T>(array, start, end): T[][]

    • Type Parameters

      • T

      Parameters

      • array: T[]
      • start: number
      • end: number

      Returns T[][]

    validate

    Staticjson2tree

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_json_sets.FileSetValidator.html b/classes/_octra_json_sets.FileSetValidator.html index 6e939b1ca..89a54deb9 100644 --- a/classes/_octra_json_sets.FileSetValidator.html +++ b/classes/_octra_json_sets.FileSetValidator.html @@ -1,6 +1,6 @@ -FileSetValidator | Octra libraries - v2.0.0

    ClassFileSetValidator

    Hierarchy (view full)

    Constructors

    constructor +FileSetValidator | Octra libraries - v2.0.0

    ClassFileSetValidator

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    blueprint

    Accessors

    decisionTree

    Methods

    parse validate -

    Constructors

    constructor

    Properties

    blueprint

    blueprint: JSONSetFileBlueprint = ...

    Accessors

    decisionTree

    Methods

    Protectedparse

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    blueprint

    blueprint: JSONSetFileBlueprint = ...

    Accessors

    decisionTree

    Methods

    Protectedparse

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_json_sets.IFile.html b/classes/_octra_json_sets.IFile.html index 38155ae95..d24518066 100644 --- a/classes/_octra_json_sets.IFile.html +++ b/classes/_octra_json_sets.IFile.html @@ -1,6 +1,6 @@ -IFile | Octra libraries - v2.0.0

    ClassIFile

    Constructors

    constructor +IFile | Octra libraries - v2.0.0

    ClassIFile

    Constructors

    constructor

    Properties

    content? name size? type? -

    Constructors

    constructor

    Properties

    Optionalcontent

    content?: string

    name

    name: string

    Optionalsize

    size?: number

    Optionaltype

    type?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    Optionalcontent

    content?: string

    name

    name: string

    Optionalsize

    size?: number

    Optionaltype

    type?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_json_sets.JSONSet.html b/classes/_octra_json_sets.JSONSet.html index 94cc976b6..50e406e97 100644 --- a/classes/_octra_json_sets.JSONSet.html +++ b/classes/_octra_json_sets.JSONSet.html @@ -1,5 +1,5 @@ -JSONSet | Octra libraries - v2.0.0

    ClassJSONSet<U>

    Type Parameters

    • U

    Constructors

    constructor +JSONSet | Octra libraries - v2.0.0

    ClassJSONSet<U>

    Type Parameters

    • U

    Constructors

    constructor

    Properties

    combine description? name? -

    Constructors

    constructor

    Properties

    combine

    combine: JSONSetCombination<U>

    Optionaldescription

    description?: string

    Optionalname

    name?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    combine

    combine: JSONSetCombination<U>

    Optionaldescription

    description?: string

    Optionalname

    name?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_json_sets.JSONSetBlueprint.html b/classes/_octra_json_sets.JSONSetBlueprint.html index 3ccb5c655..d90f24c2b 100644 --- a/classes/_octra_json_sets.JSONSetBlueprint.html +++ b/classes/_octra_json_sets.JSONSetBlueprint.html @@ -1,7 +1,7 @@ -JSONSetBlueprint | Octra libraries - v2.0.0

    ClassJSONSetBlueprint<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +JSONSetBlueprint | Octra libraries - v2.0.0

    ClassJSONSetBlueprint<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _validationMethods

    Accessors

    validationMethods

    Methods

    areEqualArray cleanUpSolutions outputTreeWithSolutions -

    Constructors

    constructor

    Properties

    Protected_validationMethods

    _validationMethods: ((item: T, conditions: U, combinationType: "and" | "or", path: string) => JSONSetResult)[] = []

    Accessors

    validationMethods

    Methods

    areEqualArray

    cleanUpSolutions

    outputTreeWithSolutions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_validationMethods

    _validationMethods: ((item: T, conditions: U, combinationType: "and" | "or", path: string) => JSONSetResult)[] = []

    Accessors

    validationMethods

    Methods

    areEqualArray

    cleanUpSolutions

    outputTreeWithSolutions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_json_sets.JSONSetCombination.html b/classes/_octra_json_sets.JSONSetCombination.html index f163e7619..a8ee9076f 100644 --- a/classes/_octra_json_sets.JSONSetCombination.html +++ b/classes/_octra_json_sets.JSONSetCombination.html @@ -1,4 +1,4 @@ -JSONSetCombination | Octra libraries - v2.0.0

    ClassJSONSetCombination<U>

    Type Parameters

    • U

    Constructors

    constructor +JSONSetCombination | Octra libraries - v2.0.0

    ClassJSONSetCombination<U>

    Type Parameters

    • U

    Constructors

    constructor

    Properties

    expressions type -

    Constructors

    constructor

    Properties

    expressions

    expressions: JSONSetExpression<U>[]

    type

    type: "and" | "or"

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    expressions

    expressions: JSONSetExpression<U>[]

    type

    type: "and" | "or"

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_json_sets.JSONSetFileBlueprint.html b/classes/_octra_json_sets.JSONSetFileBlueprint.html index f02a31623..874900dcd 100644 --- a/classes/_octra_json_sets.JSONSetFileBlueprint.html +++ b/classes/_octra_json_sets.JSONSetFileBlueprint.html @@ -1,7 +1,7 @@ -JSONSetFileBlueprint | Octra libraries - v2.0.0

    ClassJSONSetFileBlueprint

    Hierarchy (view full)

    Constructors

    constructor +JSONSetFileBlueprint | Octra libraries - v2.0.0

    ClassJSONSetFileBlueprint

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _validationMethods

    Accessors

    validationMethods

    Methods

    areEqualArray cleanUpSolutions outputTreeWithSolutions -

    Constructors

    constructor

    Properties

    Protected_validationMethods

    _validationMethods: ((item: IFile, conditions: JSONSetFileConditions, combinationType: "and" | "or", path: string) => JSONSetResult)[] = []

    Accessors

    validationMethods

    • get validationMethods(): ((item: T, conditions: U, combinationType: "and" | "or", path: string) => JSONSetResult)[]

    • Returns ((item: T, conditions: U, combinationType: "and" | "or", path: string) => JSONSetResult)[]

    Methods

    areEqualArray

    cleanUpSolutions

    outputTreeWithSolutions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_validationMethods

    _validationMethods: ((item: IFile, conditions: JSONSetFileConditions, combinationType: "and" | "or", path: string) => JSONSetResult)[] = []

    Accessors

    validationMethods

    • get validationMethods(): ((item: T, conditions: U, combinationType: "and" | "or", path: string) => JSONSetResult)[]

    • Returns ((item: T, conditions: U, combinationType: "and" | "or", path: string) => JSONSetResult)[]

    Methods

    areEqualArray

    cleanUpSolutions

    outputTreeWithSolutions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_json_sets.JSONSetFileConditions.html b/classes/_octra_json_sets.JSONSetFileConditions.html index c789fe14e..cee73edbc 100644 --- a/classes/_octra_json_sets.JSONSetFileConditions.html +++ b/classes/_octra_json_sets.JSONSetFileConditions.html @@ -1,7 +1,7 @@ -JSONSetFileConditions | Octra libraries - v2.0.0

    ClassJSONSetFileConditions

    Constructors

    constructor +JSONSetFileConditions | Octra libraries - v2.0.0

    ClassJSONSetFileConditions

    Constructors

    constructor

    Properties

    content? extension? mimeType? namePattern? size? -

    Constructors

    constructor

    Properties

    Optionalcontent

    content?: string[]

    Optionalextension

    extension?: string[]

    OptionalmimeType

    mimeType?: string[]

    OptionalnamePattern

    namePattern?: string

    Optionalsize

    size?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    Optionalcontent

    content?: string[]

    Optionalextension

    extension?: string[]

    OptionalmimeType

    mimeType?: string[]

    OptionalnamePattern

    namePattern?: string

    Optionalsize

    size?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_json_sets.JSONSetResult.html b/classes/_octra_json_sets.JSONSetResult.html index cfa2c1ac2..8427a1d84 100644 --- a/classes/_octra_json_sets.JSONSetResult.html +++ b/classes/_octra_json_sets.JSONSetResult.html @@ -1,6 +1,6 @@ -JSONSetResult | Octra libraries - v2.0.0

    ClassJSONSetResult

    Constructors

    constructor +JSONSetResult | Octra libraries - v2.0.0

    ClassJSONSetResult

    Constructors

    constructor

    Properties

    combinationType? error? path? valid -

    Constructors

    constructor

    Properties

    OptionalcombinationType

    combinationType?: "and" | "or"

    Optionalerror

    error?: string

    Optionalpath

    path?: string

    valid

    valid: boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    OptionalcombinationType

    combinationType?: "and" | "or"

    Optionalerror

    error?: string

    Optionalpath

    path?: string

    valid

    valid: boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_json_sets.JSONSetStatement.html b/classes/_octra_json_sets.JSONSetStatement.html index 11cbbc1ae..24541204e 100644 --- a/classes/_octra_json_sets.JSONSetStatement.html +++ b/classes/_octra_json_sets.JSONSetStatement.html @@ -1,6 +1,6 @@ -JSONSetStatement | Octra libraries - v2.0.0

    ClassJSONSetStatement<U>

    Type Parameters

    • U

    Constructors

    constructor +JSONSetStatement | Octra libraries - v2.0.0

    ClassJSONSetStatement<U>

    Type Parameters

    • U

    Constructors

    constructor

    Properties

    description? name? select with -

    Constructors

    constructor

    Properties

    Optionaldescription

    description?: string

    Optionalname

    name?: string

    select

    select: string

    with

    with: U | U[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    Optionaldescription

    description?: string

    Optionalname

    name?: string

    select

    select: string

    with

    with: U | U[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_json_sets.JSONSetValidationError.html b/classes/_octra_json_sets.JSONSetValidationError.html index 3c4930d53..0dd04332b 100644 --- a/classes/_octra_json_sets.JSONSetValidationError.html +++ b/classes/_octra_json_sets.JSONSetValidationError.html @@ -1,6 +1,6 @@ -JSONSetValidationError | Octra libraries - v2.0.0

    ClassJSONSetValidationError<U>

    Type Parameters

    • U

    Constructors

    constructor +JSONSetValidationError | Octra libraries - v2.0.0

    ClassJSONSetValidationError<U>

    Type Parameters

    • U

    Constructors

    constructor

    Properties

    combinationType? message path? statement? -

    Constructors

    constructor

    Properties

    OptionalcombinationType

    combinationType?: "and" | "or"

    message

    message: string

    Optionalpath

    path?: string

    Optionalstatement

    statement?: JSONSetStatement<U>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    OptionalcombinationType

    combinationType?: "and" | "or"

    message

    message: string

    Optionalpath

    path?: string

    Optionalstatement

    statement?: JSONSetStatement<U>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_json_sets.JsonSetValidator.html b/classes/_octra_json_sets.JsonSetValidator.html index ac8ca30c1..71a9f5fd2 100644 --- a/classes/_octra_json_sets.JsonSetValidator.html +++ b/classes/_octra_json_sets.JsonSetValidator.html @@ -1,6 +1,6 @@ -JsonSetValidator | Octra libraries - v2.0.0

    ClassJsonSetValidator<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +JsonSetValidator | Octra libraries - v2.0.0

    ClassJsonSetValidator<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    blueprint

    Accessors

    decisionTree

    Methods

    parse validate -

    Constructors

    constructor

    Properties

    Protected Readonlyblueprint

    blueprint: JSONSetBlueprint<T, U>

    Accessors

    decisionTree

    Methods

    Protectedparse

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected Readonlyblueprint

    blueprint: JSONSetBlueprint<T, U>

    Accessors

    decisionTree

    Methods

    Protectedparse

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_json_sets.PossibleSolution.html b/classes/_octra_json_sets.PossibleSolution.html index 79cbd59e8..f2958d584 100644 --- a/classes/_octra_json_sets.PossibleSolution.html +++ b/classes/_octra_json_sets.PossibleSolution.html @@ -1,5 +1,5 @@ -PossibleSolution | Octra libraries - v2.0.0

    ClassPossibleSolution<T, U>

    Type Parameters

    • T
    • U

    Constructors

    constructor +PossibleSolution | Octra libraries - v2.0.0

    ClassPossibleSolution<T, U>

    Type Parameters

    • T
    • U

    Constructors

    constructor

    Properties

    path selection statement -

    Constructors

    constructor

    Properties

    path

    path: string

    selection

    selection: T

    statement

    statement: JSONSetExpression<U>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    path

    path: string

    selection

    selection: T

    statement

    statement: JSONSetExpression<U>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_media.AudioSelection.html b/classes/_octra_media.AudioSelection.html index 2e666761a..9826baf46 100644 --- a/classes/_octra_media.AudioSelection.html +++ b/classes/_octra_media.AudioSelection.html @@ -1,8 +1,8 @@ -AudioSelection | Octra libraries - v2.0.0

    ClassAudioSelection

    Constructors

    constructor +AudioSelection | Octra libraries - v2.0.0

    ClassAudioSelection

    Constructors

    constructor

    Accessors

    duration end length start

    Methods

    checkSelection clone -

    Constructors

    constructor

    Accessors

    duration

    end

    length

    start

    Methods

    checkSelection

    clone

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Constructors

    constructor

    Accessors

    duration

    end

    length

    start

    Methods

    checkSelection

    clone

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/classes/_octra_media.OAudiofile.html b/classes/_octra_media.OAudiofile.html index 345b1818c..c37be9ee1 100644 --- a/classes/_octra_media.OAudiofile.html +++ b/classes/_octra_media.OAudiofile.html @@ -1,4 +1,4 @@ -OAudiofile | Octra libraries - v2.0.0

    ClassOAudiofile

    Implements

    Constructors

    constructor +OAudiofile | Octra libraries - v2.0.0

    ClassOAudiofile

    Implements

    Constructors

    constructor

    Properties

    arraybuffer? duration name @@ -6,4 +6,4 @@ size type url? -

    Constructors

    constructor

    Properties

    Optionalarraybuffer

    arraybuffer?: ArrayBuffer

    duration

    duration: number

    name

    name: string

    sampleRate

    sampleRate: number

    size

    size: number

    type

    type: string

    Optionalurl

    url?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    Optionalarraybuffer

    arraybuffer?: ArrayBuffer

    duration

    duration: number

    name

    name: string

    sampleRate

    sampleRate: number

    size

    size: number

    type

    type: string

    Optionalurl

    url?: string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_media.SampleUnit.html b/classes/_octra_media.SampleUnit.html index 3886840bf..008c8ebfe 100644 --- a/classes/_octra_media.SampleUnit.html +++ b/classes/_octra_media.SampleUnit.html @@ -1,4 +1,4 @@ -SampleUnit | Octra libraries - v2.0.0

    ClassSampleUnit

    Constructors

    constructor +SampleUnit | Octra libraries - v2.0.0

    ClassSampleUnit

    Constructors

    constructor

    Accessors

    sampleRate samples seconds @@ -12,4 +12,4 @@ calculateSamples fromMiliSeconds fromSeconds -

    Constructors

    constructor

    Accessors

    sampleRate

    samples

    seconds

    unix

    Methods

    add

    clone

    equals

    hasEqualSampleRate

    sub

    toString

    StaticcalculateSamples

    • calculateSamples(seconds, sampleRate): number

    • Parameters

      • seconds: number
      • sampleRate: number

      Returns number

    StaticfromMiliSeconds

    StaticfromSeconds

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Constructors

    constructor

    Accessors

    sampleRate

    samples

    seconds

    unix

    Methods

    add

    clone

    equals

    hasEqualSampleRate

    sub

    toString

    StaticcalculateSamples

    • calculateSamples(seconds, sampleRate): number

    • Parameters

      • seconds: number
      • sampleRate: number

      Returns number

    StaticfromMiliSeconds

    StaticfromSeconds

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.AudioViewerComponent.html b/classes/_octra_ngx_components.AudioViewerComponent.html index 385fcc48d..9be75b3ab 100644 --- a/classes/_octra_ngx_components.AudioViewerComponent.html +++ b/classes/_octra_ngx_components.AudioViewerComponent.html @@ -1,4 +1,4 @@ -AudioViewerComponent | Octra libraries - v2.0.0

    ClassAudioViewerComponent

    Implements

    • OnInit
    • OnChanges
    • OnDestroy

    Constructors

    constructor +AudioViewerComponent | Octra libraries - v2.0.0

    ClassAudioViewerComponent

    Implements

    • OnInit
    • OnChanges
    • OnDestroy

    Constructors

    constructor

    Properties

    audioChunk av konvaContainer @@ -37,32 +37,32 @@ redraw scrollToAbsY selectSegment -

    Constructors

    constructor

    Properties

    audioChunk

    audioChunk: undefined | AudioChunk

    current audio chunk displayed by this signal display

    -

    av

    av: AudioViewerService

    konvaContainer

    konvaContainer: undefined | ElementRef<any>

    OptionalsilencePlaceholder

    silencePlaceholder?: string

    defines the placeholder for silenece. E.g. if it's

    and a segment +

    Constructors

    constructor

    Properties

    audioChunk

    audioChunk: undefined | AudioChunk

    current audio chunk displayed by this signal display

    +

    av

    av: AudioViewerService

    konvaContainer

    konvaContainer: undefined | ElementRef<any>

    OptionalsilencePlaceholder

    silencePlaceholder?: string

    defines the placeholder for silenece. E.g. if it's

    and a segment contains this value, the segment is marked as silence.

    -

    Accessors

    alert

    annotation

    annotationChange

    AudioPxWidth

    boundaryDragging

    currentLevelChange

    currentLevelID

    focused

    height

    isMultiLine

    mouseCursor

    • get mouseCursor(): {
          location: undefined | Vector2d;
          size: undefined | {
              height: number;
              width: number;
          };
      }

    • Returns {
          location: undefined | Vector2d;
          size: undefined | {
              height: number;
              width: number;
          };
      }

      • location: undefined | Vector2d
      • size: undefined | {
            height: number;
            width: number;
        }

    mousecursorchange

    name

    onInitialized

    playcursorchange

    refreshOnInternChanges

    secondsPerLine

    segmententer

    • get segmententer(): EventEmitter<{
          index: number;
          pos: {
              Y1: number;
              Y2: number;
          };
      }>

    • triggers when the user enters a selected segment

      -

      Returns EventEmitter<{
          index: number;
          pos: {
              Y1: number;
              Y2: number;
          };
      }>

    selchange

    settings

    shortcut

    width

    Methods

    afterChunkUpdated

    disableShortcuts

    enableShortcuts

    init

    ngOnChanges

    Accessors

    alert

    annotation

    annotationChange

    AudioPxWidth

    boundaryDragging

    currentLevelChange

    currentLevelID

    focused

    height

    isMultiLine

    mouseCursor

    • get mouseCursor(): {
          location: undefined | Vector2d;
          size: undefined | {
              height: number;
              width: number;
          };
      }

    • Returns {
          location: undefined | Vector2d;
          size: undefined | {
              height: number;
              width: number;
          };
      }

      • location: undefined | Vector2d
      • size: undefined | {
            height: number;
            width: number;
        }

    mousecursorchange

    name

    onInitialized

    playcursorchange

    refreshOnInternChanges

    secondsPerLine

    segmententer

    • get segmententer(): EventEmitter<{
          index: number;
          pos: {
              Y1: number;
              Y2: number;
          };
      }>

    • triggers when the user enters a selected segment

      +

      Returns EventEmitter<{
          index: number;
          pos: {
              Y1: number;
              Y2: number;
          };
      }>

    selchange

    settings

    shortcut

    width

    Methods

    afterChunkUpdated

    disableShortcuts

    enableShortcuts

    init

    ngOnChanges

    • ngOnChanges(changes): void

    • A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

      Parameters

      • changes: SimpleChanges

        The changed properties.

        -

      Returns void

    ngOnDestroy

    • ngOnDestroy(): void

    • A callback method that performs custom clean-up, invoked immediately +

    Returns void

    ngOnDestroy

    ngOnInit

    ngOnInit

    • ngOnInit(): void

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      -

      Returns void

    onSecondsPerLineChanged

    onWindowResize

    redraw

    scrollToAbsY

    selectSegment

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    onSecondsPerLineChanged

    onWindowResize

    redraw

    scrollToAbsY

    selectSegment

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.AudioplayerComponent.html b/classes/_octra_ngx_components.AudioplayerComponent.html index 6967796f3..9da7fb1b8 100644 --- a/classes/_octra_ngx_components.AudioplayerComponent.html +++ b/classes/_octra_ngx_components.AudioplayerComponent.html @@ -1,4 +1,4 @@ -AudioplayerComponent | Octra libraries - v2.0.0

    ClassAudioplayerComponent

    Implements

    • OnInit
    • AfterViewInit
    • OnChanges
    • OnDestroy

    Constructors

    constructor +AudioplayerComponent | Octra libraries - v2.0.0

    ClassAudioplayerComponent

    Implements

    • OnInit
    • AfterViewInit
    • OnChanges
    • OnDestroy

    Constructors

    constructor

    Properties

    audioChunk konvaContainer

    Accessors

    getPlayHeadX @@ -14,19 +14,19 @@ onResize pxToSample update -

    Constructors

    constructor

    Properties

    audioChunk

    audioChunk: undefined | AudioChunk

    konvaContainer

    konvaContainer: undefined | ElementRef<any>

    Accessors

    getPlayHeadX

    settings

    timeLeft

    width

    Methods

    afterChunkUpdated

    ngAfterViewInit

    • ngAfterViewInit(): void

    • A callback method that is invoked immediately after +

    Constructors

    constructor

    Properties

    audioChunk

    audioChunk: undefined | AudioChunk

    konvaContainer

    konvaContainer: undefined | ElementRef<any>

    Accessors

    getPlayHeadX

    settings

    timeLeft

    width

    Methods

    afterChunkUpdated

    ngAfterViewInit

    ngOnChanges

    ngOnChanges

    • ngOnChanges(changes): void

    • A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

      Parameters

      • changes: SimpleChanges

        The changed properties.

        -

      Returns void

    ngOnDestroy

    • ngOnDestroy(): void

    • A callback method that performs custom clean-up, invoked immediately +

    Returns void

    ngOnDestroy

    ngOnInit

    ngOnInit

    • ngOnInit(): void

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      -

      Returns void

    onPlayHeadDragging

    onResize

    pxToSample

    update

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    onPlayHeadDragging

    onResize

    pxToSample

    update

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.AudioviewerConfig.html b/classes/_octra_ngx_components.AudioviewerConfig.html index 44bb8908e..8160e9e35 100644 --- a/classes/_octra_ngx_components.AudioviewerConfig.html +++ b/classes/_octra_ngx_components.AudioviewerConfig.html @@ -1,4 +1,4 @@ -AudioviewerConfig | Octra libraries - v2.0.0

    ClassAudioviewerConfig

    Constructors

    constructor +AudioviewerConfig | Octra libraries - v2.0.0

    ClassAudioviewerConfig

    Constructors

    constructor

    Properties

    asr backgroundcolor boundaries @@ -25,4 +25,4 @@ stepWidthRatio timeline type -

    Constructors

    constructor

    Properties

    asr

    asr: {
        enabled: boolean;
    } = ...

    backgroundcolor

    backgroundcolor: string = 'rgb(255, 248, 248)'

    boundaries

    boundaries: {
        color: string;
        enabled: boolean;
        readonly: boolean;
        width: number;
    } = ...

    cropping

    cropping: string = 'none'

    cursor

    cursor: {
        color: string;
        fixed: boolean;
    } = ...

    data

    data: {
        color: string;
    } = ...

    disabledKeys

    disabledKeys: string[] = ...

    frame

    frame: {
        color: string;
    } = ...

    grid

    grid: {
        color: string;
        enabled: true;
    } = ...

    justifySignalHeight

    justifySignalHeight: boolean = true

    lineheight

    lineheight: number = 60

    margin

    margin: {
        bottom: number;
        left: number;
        right: number;
        top: number;
    } = ...

    multiLine

    multiLine: boolean = false

    pixelPerSec

    pixelPerSec: number = 50

    playcursor

    playcursor: {
        color: string;
        height: number;
        width: number;
    } = ...

    roundValues

    roundValues: boolean = true

    scrollbar

    scrollbar: {
        background: {
            color: string;
            stroke: string;
            strokeWidth: number;
        };
        enabled: boolean;
        selector: {
            color: string;
            stroke: string;
            strokeWidth: number;
            width: number;
        };
        width: number;
    } = ...

    selection

    selection: {
        color: string;
        enabled: boolean;
    } = ...

    shortcuts

    shortcuts: ShortcutGroup = ...

    shortcutsEnabled

    shortcutsEnabled: boolean = true

    showProgressBars

    showProgressBars: boolean = false

    showTimePerLine

    showTimePerLine: boolean = false

    showTranscripts

    showTranscripts: boolean = false

    stepWidthRatio

    stepWidthRatio: number = 0.0226

    timeline

    timeline: {
        enabled: boolean;
        font: string;
        fontSize: number;
        fontWeight: string;
        foreColor: string;
        height: number;
    } = ...

    type

    type: undefined | string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    asr

    asr: {
        enabled: boolean;
    } = ...

    backgroundcolor

    backgroundcolor: string = 'rgb(255, 248, 248)'

    boundaries

    boundaries: {
        color: string;
        enabled: boolean;
        readonly: boolean;
        width: number;
    } = ...

    cropping

    cropping: string = 'none'

    cursor

    cursor: {
        color: string;
        fixed: boolean;
    } = ...

    data

    data: {
        color: string;
    } = ...

    disabledKeys

    disabledKeys: string[] = ...

    frame

    frame: {
        color: string;
    } = ...

    grid

    grid: {
        color: string;
        enabled: true;
    } = ...

    justifySignalHeight

    justifySignalHeight: boolean = true

    lineheight

    lineheight: number = 60

    margin

    margin: {
        bottom: number;
        left: number;
        right: number;
        top: number;
    } = ...

    multiLine

    multiLine: boolean = false

    pixelPerSec

    pixelPerSec: number = 50

    playcursor

    playcursor: {
        color: string;
        height: number;
        width: number;
    } = ...

    roundValues

    roundValues: boolean = true

    scrollbar

    scrollbar: {
        background: {
            color: string;
            stroke: string;
            strokeWidth: number;
        };
        enabled: boolean;
        selector: {
            color: string;
            stroke: string;
            strokeWidth: number;
            width: number;
        };
        width: number;
    } = ...

    selection

    selection: {
        color: string;
        enabled: boolean;
    } = ...

    shortcuts

    shortcuts: ShortcutGroup = ...

    shortcutsEnabled

    shortcutsEnabled: boolean = true

    showProgressBars

    showProgressBars: boolean = false

    showTimePerLine

    showTimePerLine: boolean = false

    showTranscripts

    showTranscripts: boolean = false

    stepWidthRatio

    stepWidthRatio: number = 0.0226

    timeline

    timeline: {
        enabled: boolean;
        font: string;
        fontSize: number;
        fontWeight: string;
        foreColor: string;
        height: number;
    } = ...

    type

    type: undefined | string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_ngx_components.ConfigurationArrayControl.html b/classes/_octra_ngx_components.ConfigurationArrayControl.html index 4c9312ff1..d0b9cb055 100644 --- a/classes/_octra_ngx_components.ConfigurationArrayControl.html +++ b/classes/_octra_ngx_components.ConfigurationArrayControl.html @@ -1,4 +1,4 @@ -ConfigurationArrayControl | Octra libraries - v2.0.0

    ClassConfigurationArrayControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationArrayControl | Octra libraries - v2.0.0

    ClassConfigurationArrayControl

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _name _options _root? @@ -17,4 +17,4 @@ value

    Methods

    checkToggleStateOfControl toObj -

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<any[], any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<any[], any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.ConfigurationControl.html b/classes/_octra_ngx_components.ConfigurationControl.html index b75e996eb..333ee188d 100644 --- a/classes/_octra_ngx_components.ConfigurationControl.html +++ b/classes/_octra_ngx_components.ConfigurationControl.html @@ -1,4 +1,4 @@ -ConfigurationControl | Octra libraries - v2.0.0

    ClassConfigurationControl<R, S>

    Type Parameters

    • R = any
    • S = any

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationControl | Octra libraries - v2.0.0

    ClassConfigurationControl<R, S>

    Type Parameters

    • R = any
    • S = any

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _name _options _root? @@ -17,4 +17,4 @@ value

    Methods

    checkToggleStateOfControl toObj -

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<R, S>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<R, S>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.ConfigurationControlGroup.html b/classes/_octra_ngx_components.ConfigurationControlGroup.html index 9ef202ee4..65a50d58f 100644 --- a/classes/_octra_ngx_components.ConfigurationControlGroup.html +++ b/classes/_octra_ngx_components.ConfigurationControlGroup.html @@ -1,4 +1,4 @@ -ConfigurationControlGroup | Octra libraries - v2.0.0

    ClassConfigurationControlGroup

    Constructors

    constructor +ConfigurationControlGroup | Octra libraries - v2.0.0

    ClassConfigurationControlGroup

    Constructors

    constructor

    Properties

    _dependsOn _name _title @@ -20,4 +20,4 @@ type

    Methods

    checkToggleStateOfControl toObj -

    Constructors

    constructor

    Properties

    Protected_dependsOn

    _dependsOn: string[] = []

    Protected_name

    _name: string

    Protected_title

    _title: string

    Protected_toggleable

    _toggleable: boolean = false

    context

    context: any

    controls

    controls: (ConfigurationControlGroup | ConfigurationControl<any, any>)[] = []

    description

    description: string = ''

    focused

    focused: boolean = false

    id

    id: number = 1

    ignore

    ignore: boolean = false

    itemsType

    itemsType: any = undefined

    Optional Readonlyroot

    root?: ConfigurationControlGroup

    toggled

    toggled: boolean = false

    value

    value: undefined = undefined

    Accessors

    dependsOn

    name

    title

    toggleable

    type

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_dependsOn

    _dependsOn: string[] = []

    Protected_name

    _name: string

    Protected_title

    _title: string

    Protected_toggleable

    _toggleable: boolean = false

    context

    context: any

    controls

    controls: (ConfigurationControlGroup | ConfigurationControl<any, any>)[] = []

    description

    description: string = ''

    focused

    focused: boolean = false

    id

    id: number = 1

    ignore

    ignore: boolean = false

    itemsType

    itemsType: any = undefined

    Optional Readonlyroot

    root?: ConfigurationControlGroup

    toggled

    toggled: boolean = false

    value

    value: undefined = undefined

    Accessors

    dependsOn

    name

    title

    toggleable

    type

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.ConfigurationControlOptions.html b/classes/_octra_ngx_components.ConfigurationControlOptions.html index dcd810000..c3c4544a2 100644 --- a/classes/_octra_ngx_components.ConfigurationControlOptions.html +++ b/classes/_octra_ngx_components.ConfigurationControlOptions.html @@ -1,4 +1,4 @@ -ConfigurationControlOptions | Octra libraries - v2.0.0

    ClassConfigurationControlOptions<R, S>

    Type Parameters

    • R
    • S = any

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationControlOptions | Octra libraries - v2.0.0

    ClassConfigurationControlOptions<R, S>

    Type Parameters

    • R
    • S = any

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    context? defaultValue? dependsOn @@ -8,4 +8,4 @@ toggleable type? value? -

    Constructors

    constructor

    Properties

    Optionalcontext

    context?: S

    OptionaldefaultValue

    defaultValue?: R

    dependsOn

    dependsOn: string[] = []

    Optionaldescription

    description?: string

    ignore

    ignore: boolean = false

    Optionaltitle

    title?: string

    toggleable

    toggleable: boolean = false

    Optionaltype

    type?:
        | "number"
        | "select"
        | "textarea"
        | "switch"
        | "text"
        | "integer"
        | "multiple-choice"
        | "array"

    Optionalvalue

    value?: R

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    Optionalcontext

    context?: S

    OptionaldefaultValue

    defaultValue?: R

    dependsOn

    dependsOn: string[] = []

    Optionaldescription

    description?: string

    ignore

    ignore: boolean = false

    Optionaltitle

    title?: string

    toggleable

    toggleable: boolean = false

    Optionaltype

    type?:
        | "number"
        | "select"
        | "textarea"
        | "switch"
        | "text"
        | "integer"
        | "multiple-choice"
        | "array"

    Optionalvalue

    value?: R

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_ngx_components.ConfigurationMultipleChoiceControl.html b/classes/_octra_ngx_components.ConfigurationMultipleChoiceControl.html index 23c28bbf4..67428adb4 100644 --- a/classes/_octra_ngx_components.ConfigurationMultipleChoiceControl.html +++ b/classes/_octra_ngx_components.ConfigurationMultipleChoiceControl.html @@ -1,4 +1,4 @@ -ConfigurationMultipleChoiceControl | Octra libraries - v2.0.0

    ClassConfigurationMultipleChoiceControl

    Hierarchy (view full)

    • ConfigurationControl<string[], {
          label: string;
          value: string;
      }>
      • ConfigurationMultipleChoiceControl

    Constructors

    constructor +ConfigurationMultipleChoiceControl | Octra libraries - v2.0.0

    ClassConfigurationMultipleChoiceControl

    Hierarchy (view full)

    • ConfigurationControl<string[], {
          label: string;
          value: string;
      }>
      • ConfigurationMultipleChoiceControl

    Constructors

    constructor

    Properties

    _name _options _root? @@ -17,4 +17,4 @@ value

    Methods

    checkToggleStateOfControl toObj -

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<string[], {
        label: string;
        value: string;
    }>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<string[], {
        label: string;
        value: string;
    }>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.ConfigurationNumberControl.html b/classes/_octra_ngx_components.ConfigurationNumberControl.html index 01184e95a..ab932b736 100644 --- a/classes/_octra_ngx_components.ConfigurationNumberControl.html +++ b/classes/_octra_ngx_components.ConfigurationNumberControl.html @@ -1,4 +1,4 @@ -ConfigurationNumberControl | Octra libraries - v2.0.0

    ClassConfigurationNumberControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationNumberControl | Octra libraries - v2.0.0

    ClassConfigurationNumberControl

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _name _options _root? @@ -17,4 +17,4 @@ value

    Methods

    checkToggleStateOfControl toObj -

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<number, any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<number, any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.ConfigurationSelectControl.html b/classes/_octra_ngx_components.ConfigurationSelectControl.html index 2014c4117..600b32b2a 100644 --- a/classes/_octra_ngx_components.ConfigurationSelectControl.html +++ b/classes/_octra_ngx_components.ConfigurationSelectControl.html @@ -1,4 +1,4 @@ -ConfigurationSelectControl | Octra libraries - v2.0.0

    ClassConfigurationSelectControl

    Hierarchy (view full)

    • ConfigurationControl<string, {
          label: string;
          value: string;
      }>
      • ConfigurationSelectControl

    Constructors

    constructor +ConfigurationSelectControl | Octra libraries - v2.0.0

    ClassConfigurationSelectControl

    Hierarchy (view full)

    • ConfigurationControl<string, {
          label: string;
          value: string;
      }>
      • ConfigurationSelectControl

    Constructors

    constructor

    Properties

    _name _options _root? @@ -17,4 +17,4 @@ value

    Methods

    checkToggleStateOfControl toObj -

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<string, {
        label: string;
        value: string;
    }>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<string, {
        label: string;
        value: string;
    }>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.ConfigurationSwitchControl.html b/classes/_octra_ngx_components.ConfigurationSwitchControl.html index a4d2bd070..bf67e3ae3 100644 --- a/classes/_octra_ngx_components.ConfigurationSwitchControl.html +++ b/classes/_octra_ngx_components.ConfigurationSwitchControl.html @@ -1,4 +1,4 @@ -ConfigurationSwitchControl | Octra libraries - v2.0.0

    ClassConfigurationSwitchControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationSwitchControl | Octra libraries - v2.0.0

    ClassConfigurationSwitchControl

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _name _options _root? @@ -17,4 +17,4 @@ value

    Methods

    checkToggleStateOfControl toObj -

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<boolean, any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<boolean, any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.ConfigurationTextControl.html b/classes/_octra_ngx_components.ConfigurationTextControl.html index 3d0a07a36..299ad8943 100644 --- a/classes/_octra_ngx_components.ConfigurationTextControl.html +++ b/classes/_octra_ngx_components.ConfigurationTextControl.html @@ -1,4 +1,4 @@ -ConfigurationTextControl | Octra libraries - v2.0.0

    ClassConfigurationTextControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationTextControl | Octra libraries - v2.0.0

    ClassConfigurationTextControl

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _name _options _root? @@ -17,4 +17,4 @@ value

    Methods

    checkToggleStateOfControl toObj -

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<string, any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<string, any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.ConfigurationTextareaControl.html b/classes/_octra_ngx_components.ConfigurationTextareaControl.html index dc35349c8..e47f49093 100644 --- a/classes/_octra_ngx_components.ConfigurationTextareaControl.html +++ b/classes/_octra_ngx_components.ConfigurationTextareaControl.html @@ -1,4 +1,4 @@ -ConfigurationTextareaControl | Octra libraries - v2.0.0

    ClassConfigurationTextareaControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationTextareaControl | Octra libraries - v2.0.0

    ClassConfigurationTextareaControl

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _name _options _root? @@ -17,4 +17,4 @@ value

    Methods

    checkToggleStateOfControl toObj -

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<string, any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Protected_name

    _name: string

    Protected_options

    _options: FixedConfigurationControlOptions<string, any>

    Protected Optional_root

    _root?: ConfigurationControlGroup

    focused

    focused: boolean = false

    itemsType

    itemsType: any = undefined

    toggled

    toggled: boolean = false

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    • get type():
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    • Returns
          | "number"
          | "select"
          | "textarea"
          | "switch"
          | "text"
          | "integer"
          | "multiple-choice"
          | "array"

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.FixedConfigurationControlOptions.html b/classes/_octra_ngx_components.FixedConfigurationControlOptions.html index 75eaf1255..b6bdb9c77 100644 --- a/classes/_octra_ngx_components.FixedConfigurationControlOptions.html +++ b/classes/_octra_ngx_components.FixedConfigurationControlOptions.html @@ -1,4 +1,4 @@ -FixedConfigurationControlOptions | Octra libraries - v2.0.0

    ClassFixedConfigurationControlOptions<R, S>

    Type Parameters

    • R
    • S = any

    Hierarchy (view full)

    Constructors

    constructor +FixedConfigurationControlOptions | Octra libraries - v2.0.0

    ClassFixedConfigurationControlOptions<R, S>

    Type Parameters

    • R
    • S = any

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    context? defaultValue? dependsOn @@ -8,4 +8,4 @@ toggleable type value? -

    Constructors

    constructor

    Properties

    Optionalcontext

    context?: S

    OptionaldefaultValue

    defaultValue?: R

    dependsOn

    dependsOn: string[] = []

    Optionaldescription

    description?: string

    ignore

    ignore: boolean = false

    Optionaltitle

    title?: string

    toggleable

    toggleable: boolean = false

    type

    type:
        | "number"
        | "select"
        | "textarea"
        | "switch"
        | "text"
        | "integer"
        | "multiple-choice"
        | "array"

    Optionalvalue

    value?: R

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    Optionalcontext

    context?: S

    OptionaldefaultValue

    defaultValue?: R

    dependsOn

    dependsOn: string[] = []

    Optionaldescription

    description?: string

    ignore

    ignore: boolean = false

    Optionaltitle

    title?: string

    toggleable

    toggleable: boolean = false

    type

    type:
        | "number"
        | "select"
        | "textarea"
        | "switch"
        | "text"
        | "integer"
        | "multiple-choice"
        | "array"

    Optionalvalue

    value?: R

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_ngx_components.Interval.html b/classes/_octra_ngx_components.Interval.html index 32e1e09b4..e7838fc51 100644 --- a/classes/_octra_ngx_components.Interval.html +++ b/classes/_octra_ngx_components.Interval.html @@ -1,5 +1,5 @@ Interval | Octra libraries - v2.0.0

    ClassInterval

    collections

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    end start -

    Constructors

    constructor

    Properties

    end

    end: number

    start

    start: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    end

    end: number

    start

    start: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_ngx_components.Margin.html b/classes/_octra_ngx_components.Margin.html index d384be8b1..1b9de2a8d 100644 --- a/classes/_octra_ngx_components.Margin.html +++ b/classes/_octra_ngx_components.Margin.html @@ -1,6 +1,6 @@ -Margin | Octra libraries - v2.0.0

    ClassMargin

    Implements

    Constructors

    constructor +Margin | Octra libraries - v2.0.0

    ClassMargin

    Implements

    Constructors

    constructor

    Properties

    bottom left right top -

    Constructors

    constructor

    Properties

    bottom

    bottom: number

    left

    left: number

    right

    right: number

    top

    top: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    bottom

    bottom: number

    left

    left: number

    right

    right: number

    top

    top: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_ngx_components.MultiThreadingService.html b/classes/_octra_ngx_components.MultiThreadingService.html index 04642a8f4..b4a77473a 100644 --- a/classes/_octra_ngx_components.MultiThreadingService.html +++ b/classes/_octra_ngx_components.MultiThreadingService.html @@ -1,6 +1,6 @@ -MultiThreadingService | Octra libraries - v2.0.0

    ClassMultiThreadingService

    Constructors

    constructor +MultiThreadingService | Octra libraries - v2.0.0

    ClassMultiThreadingService

    Constructors

    constructor

    Accessors

    workers

    Methods

    destroy getStatistics run -

    Constructors

    constructor

    Accessors

    workers

    Methods

    destroy

    getStatistics

    run

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Constructors

    constructor

    Accessors

    workers

    Methods

    destroy

    getStatistics

    run

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/classes/_octra_ngx_components.OctraComponentsModule.html b/classes/_octra_ngx_components.OctraComponentsModule.html index f0ce108a0..f6059ae04 100644 --- a/classes/_octra_ngx_components.OctraComponentsModule.html +++ b/classes/_octra_ngx_components.OctraComponentsModule.html @@ -1,2 +1,2 @@ -OctraComponentsModule | Octra libraries - v2.0.0

    ClassOctraComponentsModule

    Constructors

    constructor +OctraComponentsModule | Octra libraries - v2.0.0

    ClassOctraComponentsModule

    Constructors

    constructor

    Constructors

    constructor

    Settings

    Member Visibility

    On This Page

    Constructors
    diff --git a/classes/_octra_ngx_components.OctraFormGeneratorModule.html b/classes/_octra_ngx_components.OctraFormGeneratorModule.html index 54432b2ab..3e6d26f7b 100644 --- a/classes/_octra_ngx_components.OctraFormGeneratorModule.html +++ b/classes/_octra_ngx_components.OctraFormGeneratorModule.html @@ -1,2 +1,2 @@ -OctraFormGeneratorModule | Octra libraries - v2.0.0

    ClassOctraFormGeneratorModule

    Constructors

    constructor +OctraFormGeneratorModule | Octra libraries - v2.0.0

    ClassOctraFormGeneratorModule

    Constructors

    constructor

    Constructors

    constructor

    Settings

    Member Visibility

    On This Page

    Constructors
    diff --git a/classes/_octra_ngx_components.Position.html b/classes/_octra_ngx_components.Position.html index 93e2983f4..760707dc5 100644 --- a/classes/_octra_ngx_components.Position.html +++ b/classes/_octra_ngx_components.Position.html @@ -1,4 +1,4 @@ -Position | Octra libraries - v2.0.0

    ClassPosition

    Implements

    Implemented by

    Constructors

    constructor +Position | Octra libraries - v2.0.0

    ClassPosition

    Implements

    Implemented by

    Constructors

    constructor

    Properties

    x y -

    Constructors

    constructor

    Properties

    x

    x: number

    y

    y: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    x

    x: number

    y

    y: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_ngx_components.PreparedItem.html b/classes/_octra_ngx_components.PreparedItem.html index a4433cc34..a622f2193 100644 --- a/classes/_octra_ngx_components.PreparedItem.html +++ b/classes/_octra_ngx_components.PreparedItem.html @@ -1,4 +1,4 @@ -PreparedItem | Octra libraries - v2.0.0

    ClassPreparedItem

    Constructors

    constructor +PreparedItem | Octra libraries - v2.0.0

    ClassPreparedItem

    Constructors

    constructor

    Properties

    selected value -

    Constructors

    constructor

    Properties

    selected

    selected: boolean = false

    value

    value: any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    selected

    selected: boolean = false

    value

    value: any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_ngx_components.Rectangle.html b/classes/_octra_ngx_components.Rectangle.html index 9bdc21507..b61aa9ff5 100644 --- a/classes/_octra_ngx_components.Rectangle.html +++ b/classes/_octra_ngx_components.Rectangle.html @@ -1,5 +1,5 @@ Rectangle | Octra libraries - v2.0.0

    ClassRectangle

    SHAPES

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    position size -

    Constructors

    constructor

    Properties

    position

    position: Position

    size

    size: Size

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    position

    position: Position

    size

    size: Size

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_ngx_components.Size.html b/classes/_octra_ngx_components.Size.html index 5e59f7080..8a9539e74 100644 --- a/classes/_octra_ngx_components.Size.html +++ b/classes/_octra_ngx_components.Size.html @@ -1,4 +1,4 @@ -Size | Octra libraries - v2.0.0

    ClassSize

    Implements

    Constructors

    constructor +Size | Octra libraries - v2.0.0

    ClassSize

    Implements

    Constructors

    constructor

    Properties

    height width -

    Constructors

    constructor

    Properties

    height

    height: number

    width

    width: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    height

    height: number

    width

    width: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/_octra_ngx_components.ToolConfigArrayAdderComponent.html b/classes/_octra_ngx_components.ToolConfigArrayAdderComponent.html index 86c23b226..9c05f3050 100644 --- a/classes/_octra_ngx_components.ToolConfigArrayAdderComponent.html +++ b/classes/_octra_ngx_components.ToolConfigArrayAdderComponent.html @@ -1,4 +1,4 @@ -ToolConfigArrayAdderComponent | Octra libraries - v2.0.0

    ClassToolConfigArrayAdderComponent

    Hierarchy (view full)

    Constructors

    constructor +ToolConfigArrayAdderComponent | Octra libraries - v2.0.0

    ClassToolConfigArrayAdderComponent

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _items disabled inputValue @@ -13,7 +13,7 @@ ngOnDestroy open subscribe -

    Constructors

    constructor

    Properties

    Protected_items

    _items: PreparedItem[] = []

    disabled

    disabled: boolean = false

    inputValue

    inputValue: any

    items

    items: any[] = []

    itemsAdd

    itemsAdd: EventEmitter<any[]> = ...

    popover

    popover: NgbPopover

    ProtectedsubscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Optionaltype

    type?: "number" | "text" | "integer"

    uniqueItems

    uniqueItems: boolean = false

    values

    values: any[] = []

    Methods

    add

    ngOnDestroy

    • ngOnDestroy(): void

    • A callback method that performs custom clean-up, invoked immediately +

    Constructors

    constructor

    Properties

    Protected_items

    _items: PreparedItem[] = []

    disabled

    disabled: boolean = false

    inputValue

    inputValue: any

    items

    items: any[] = []

    itemsAdd

    itemsAdd: EventEmitter<any[]> = ...

    popover

    popover: NgbPopover

    ProtectedsubscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Optionaltype

    type?: "number" | "text" | "integer"

    uniqueItems

    uniqueItems: boolean = false

    values

    values: any[] = []

    Methods

    add

    ngOnDestroy

    open

    Protectedsubscribe

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    open

    Protectedsubscribe

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_ngx_components.ToolConfiguratorComponent.html b/classes/_octra_ngx_components.ToolConfiguratorComponent.html index 390d71001..ffbc65503 100644 --- a/classes/_octra_ngx_components.ToolConfiguratorComponent.html +++ b/classes/_octra_ngx_components.ToolConfiguratorComponent.html @@ -1,4 +1,4 @@ -ToolConfiguratorComponent | Octra libraries - v2.0.0

    ClassToolConfiguratorComponent

    Hierarchy (view full)

    Implements

    • OnChanges

    Constructors

    constructor +ToolConfiguratorComponent | Octra libraries - v2.0.0

    ClassToolConfiguratorComponent

    Hierarchy (view full)

    Implements

    • OnChanges

    Constructors

    constructor

    Properties

    form? json? jsonSchema? @@ -9,12 +9,12 @@ ngOnDestroy onSomethingChanged subscribe -

    Constructors

    constructor

    Properties

    Optionalform

    form?: ConfigurationControlGroup

    Optionaljson

    json?: any

    OptionaljsonSchema

    jsonSchema?: any

    OptionaljsonText

    jsonText?: string

    jsonTextChange

    jsonTextChange: EventEmitter<string> = ...

    ProtectedsubscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Methods

    ngOnChanges

    • ngOnChanges(changes): void

    • A callback method that is invoked immediately after the +

    Constructors

    constructor

    Properties

    Optionalform

    form?: ConfigurationControlGroup

    Optionaljson

    json?: any

    OptionaljsonSchema

    jsonSchema?: any

    OptionaljsonText

    jsonText?: string

    jsonTextChange

    jsonTextChange: EventEmitter<string> = ...

    ProtectedsubscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Methods

    ngOnChanges

    • ngOnChanges(changes): void

    • A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

      Parameters

      • changes: SimpleChanges

        The changed properties.

        -

      Returns void

    ngOnDestroy

    • ngOnDestroy(): void

    • A callback method that performs custom clean-up, invoked immediately +

    Returns void

    ngOnDestroy

    onSomethingChanged

    Protectedsubscribe

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    onSomethingChanged

    Protectedsubscribe

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_ngx_components.ToolconfigGroupComponent.html b/classes/_octra_ngx_components.ToolconfigGroupComponent.html index c980726db..f51852363 100644 --- a/classes/_octra_ngx_components.ToolconfigGroupComponent.html +++ b/classes/_octra_ngx_components.ToolconfigGroupComponent.html @@ -1,4 +1,4 @@ -ToolconfigGroupComponent | Octra libraries - v2.0.0

    ClassToolconfigGroupComponent

    Hierarchy (view full)

    Constructors

    constructor +ToolconfigGroupComponent | Octra libraries - v2.0.0

    ClassToolconfigGroupComponent

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    group? somethingChanged subscriptionManager @@ -6,7 +6,7 @@ onArrayItemAdd onArrayItemDelete subscribe -

    Constructors

    constructor

    Properties

    Optionalgroup

    group?: ConfigurationControlGroup

    somethingChanged

    somethingChanged: EventEmitter<void> = ...

    ProtectedsubscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Methods

    ngOnDestroy

    • ngOnDestroy(): void

    • A callback method that performs custom clean-up, invoked immediately +

    Constructors

    constructor

    Properties

    Optionalgroup

    group?: ConfigurationControlGroup

    somethingChanged

    somethingChanged: EventEmitter<void> = ...

    ProtectedsubscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Methods

    ngOnDestroy

    onArrayItemAdd

    onArrayItemDelete

    Protectedsubscribe

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    onArrayItemAdd

    onArrayItemDelete

    Protectedsubscribe

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/_octra_ngx_utilities.CapitalLetterPipe.html b/classes/_octra_ngx_utilities.CapitalLetterPipe.html index bab396cc4..396ad9b78 100644 --- a/classes/_octra_ngx_utilities.CapitalLetterPipe.html +++ b/classes/_octra_ngx_utilities.CapitalLetterPipe.html @@ -1,3 +1,3 @@ -CapitalLetterPipe | Octra libraries - v2.0.0

    ClassCapitalLetterPipe

    Implements

    • PipeTransform

    Constructors

    constructor +CapitalLetterPipe | Octra libraries - v2.0.0

    ClassCapitalLetterPipe

    Implements

    • PipeTransform

    Constructors

    constructor

    Methods

    transform -

    Constructors

    constructor

    Methods

    transform

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    transform

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/_octra_ngx_utilities.JoinPipe.html b/classes/_octra_ngx_utilities.JoinPipe.html index 7554c03c7..f12931a3f 100644 --- a/classes/_octra_ngx_utilities.JoinPipe.html +++ b/classes/_octra_ngx_utilities.JoinPipe.html @@ -1,3 +1,3 @@ -JoinPipe | Octra libraries - v2.0.0

    ClassJoinPipe

    Implements

    • PipeTransform

    Constructors

    constructor +JoinPipe | Octra libraries - v2.0.0

    ClassJoinPipe

    Implements

    • PipeTransform

    Constructors

    constructor

    Methods

    transform -

    Constructors

    constructor

    Methods

    transform

    • transform(value, options): string

    • Parameters

      • value: string[]
      • options: {
            separator: string;
        }
        • separator: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    transform

    • transform(value, options): string

    • Parameters

      • value: string[]
      • options: {
            separator: string;
        }
        • separator: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/_octra_ngx_utilities.LeadingNullPipe.html b/classes/_octra_ngx_utilities.LeadingNullPipe.html index 128237aa7..bd78fefb7 100644 --- a/classes/_octra_ngx_utilities.LeadingNullPipe.html +++ b/classes/_octra_ngx_utilities.LeadingNullPipe.html @@ -1,3 +1,3 @@ -LeadingNullPipe | Octra libraries - v2.0.0

    ClassLeadingNullPipe

    Implements

    • PipeTransform

    Constructors

    constructor +LeadingNullPipe | Octra libraries - v2.0.0

    ClassLeadingNullPipe

    Implements

    • PipeTransform

    Constructors

    constructor

    Methods

    transform -

    Constructors

    constructor

    Methods

    transform

    • transform(value, maxnum): any

    • Parameters

      • value: any
      • maxnum: number

      Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    transform

    • transform(value, maxnum): any

    • Parameters

      • value: any
      • maxnum: number

      Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/_octra_ngx_utilities.MapPipe.html b/classes/_octra_ngx_utilities.MapPipe.html index 1e167fa75..88b8d7a8d 100644 --- a/classes/_octra_ngx_utilities.MapPipe.html +++ b/classes/_octra_ngx_utilities.MapPipe.html @@ -1,3 +1,3 @@ -MapPipe | Octra libraries - v2.0.0

    ClassMapPipe

    Implements

    • PipeTransform

    Constructors

    constructor +MapPipe | Octra libraries - v2.0.0

    ClassMapPipe

    Implements

    • PipeTransform

    Constructors

    constructor

    Methods

    transform -

    Constructors

    constructor

    Methods

    transform

    • transform(value, options): any[]

    • Parameters

      • value: any[]
      • options: {
            func: ((a: any) => any);
        }
        • func: ((a: any) => any)
            • (a): any

            • Parameters

              • a: any

              Returns any

      Returns any[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    transform

    • transform(value, options): any[]

    • Parameters

      • value: any[]
      • options: {
            func: ((a: any) => any);
        }
        • func: ((a: any) => any)
            • (a): any

            • Parameters

              • a: any

              Returns any

      Returns any[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/_octra_ngx_utilities.OctraUtilitiesModule.html b/classes/_octra_ngx_utilities.OctraUtilitiesModule.html index 34867f41c..9905c8a63 100644 --- a/classes/_octra_ngx_utilities.OctraUtilitiesModule.html +++ b/classes/_octra_ngx_utilities.OctraUtilitiesModule.html @@ -1,2 +1,2 @@ -OctraUtilitiesModule | Octra libraries - v2.0.0

    ClassOctraUtilitiesModule

    Constructors

    constructor +OctraUtilitiesModule | Octra libraries - v2.0.0

    ClassOctraUtilitiesModule

    Constructors

    constructor

    Constructors

    constructor

    Settings

    Member Visibility

    On This Page

    Constructors
    diff --git a/classes/_octra_ngx_utilities.ProcentPipe.html b/classes/_octra_ngx_utilities.ProcentPipe.html index ab6eb711c..0ff46edca 100644 --- a/classes/_octra_ngx_utilities.ProcentPipe.html +++ b/classes/_octra_ngx_utilities.ProcentPipe.html @@ -1,3 +1,3 @@ -ProcentPipe | Octra libraries - v2.0.0

    ClassProcentPipe

    Implements

    • PipeTransform

    Constructors

    constructor +ProcentPipe | Octra libraries - v2.0.0

    ClassProcentPipe

    Implements

    • PipeTransform

    Constructors

    constructor

    Methods

    transform -

    Constructors

    constructor

    Methods

    transform

    • transform(value): any

    • Parameters

      • value: any

      Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    transform

    • transform(value): any

    • Parameters

      • value: any

      Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/_octra_ngx_utilities.SubscriberComponent.html b/classes/_octra_ngx_utilities.SubscriberComponent.html index 8f86a4c7c..3bc4a3ed7 100644 --- a/classes/_octra_ngx_utilities.SubscriberComponent.html +++ b/classes/_octra_ngx_utilities.SubscriberComponent.html @@ -1,8 +1,8 @@ -SubscriberComponent | Octra libraries - v2.0.0

    ClassSubscriberComponent

    Hierarchy

    • SubscriberComponent

      Implements

      • OnDestroy

      Constructors

      constructor +SubscriberComponent | Octra libraries - v2.0.0

      ClassSubscriberComponent

      Hierarchy

      • SubscriberComponent

        Implements

        • OnDestroy

        Constructors

        constructor

        Properties

        subscriptionManager

        Methods

        ngOnDestroy subscribe -

        Constructors

        constructor

        Properties

        ProtectedsubscriptionManager

        subscriptionManager: SubscriptionManager<Subscription> = ...

        Methods

        ngOnDestroy

        • ngOnDestroy(): void

        • A callback method that performs custom clean-up, invoked immediately +

        Constructors

        constructor

        Properties

        ProtectedsubscriptionManager

        subscriptionManager: SubscriptionManager<Subscription> = ...

        Methods

        ngOnDestroy

        • ngOnDestroy(): void

        • A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

          -

          Returns void

        Protectedsubscribe

        • subscribe<R, E>(observable, observerOrNext?, tag?): number
        • Protected

          subscribes an observable that is internally added to the subscription manager and destroyed automatically on ngDestroy

          -

          Type Parameters

          • R
          • E

          Parameters

          • observable: Observable<R>
          • OptionalobserverOrNext: Partial<Observer<R>> | ((value: R) => void)
          • Optionaltag: string

          Returns number

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Methods
        +

        Returns void

        Protectedsubscribe

        • subscribe<R, E>(observable, observerOrNext?, tag?): number
        • Protected

          subscribes an observable that is internally added to the subscription manager and destroyed automatically on ngDestroy

          +

          Type Parameters

          • R
          • E

          Parameters

          • observable: Observable<R>
          • OptionalobserverOrNext: Partial<Observer<R>> | ((value: R) => void)
          • Optionaltag: string

          Returns number

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Methods
        diff --git a/classes/_octra_ngx_utilities.TimespanPipe.html b/classes/_octra_ngx_utilities.TimespanPipe.html index f6f8054dc..899825bac 100644 --- a/classes/_octra_ngx_utilities.TimespanPipe.html +++ b/classes/_octra_ngx_utilities.TimespanPipe.html @@ -1,6 +1,6 @@ -TimespanPipe | Octra libraries - v2.0.0

        ClassTimespanPipe

        Implements

        • PipeTransform

        Constructors

        constructor +TimespanPipe | Octra libraries - v2.0.0

        ClassTimespanPipe

        Implements

        • PipeTransform

        Constructors

        constructor

        Methods

        transform

        Constructors

        constructor

        Methods

        transform

        • transform(value, args?): any

        • transforms milliseconds to time string

          Parameters

          • value: undefined | number

            number or milliseconds

          • Optionalargs: {
                maxDuration?: number;
                showHour?: boolean;
                showMilliSeconds?: boolean;
            }

            [showHour, showMilliSeconds]

            -
            • OptionalmaxDuration?: number
            • OptionalshowHour?: boolean
            • OptionalshowMilliSeconds?: boolean

          Returns any

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        +
        • OptionalmaxDuration?: number
        • OptionalshowHour?: boolean
        • OptionalshowMilliSeconds?: boolean

        Returns any

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        diff --git a/classes/_octra_ngx_utilities.UnixDurationPipe.html b/classes/_octra_ngx_utilities.UnixDurationPipe.html index a50a3924b..49fe82343 100644 --- a/classes/_octra_ngx_utilities.UnixDurationPipe.html +++ b/classes/_octra_ngx_utilities.UnixDurationPipe.html @@ -1,3 +1,3 @@ -UnixDurationPipe | Octra libraries - v2.0.0

        ClassUnixDurationPipe

        Implements

        • PipeTransform

        Constructors

        constructor +UnixDurationPipe | Octra libraries - v2.0.0

        ClassUnixDurationPipe

        Implements

        • PipeTransform

        Constructors

        constructor

        Methods

        transform -

        Constructors

        constructor

        Methods

        transform

        • transform(value?): unknown

        • Parameters

          • Optionalvalue: number

          Returns unknown

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        +

        Constructors

        constructor

        Methods

        transform

        • transform(value?): unknown

        • Parameters

          • Optionalvalue: number

          Returns unknown

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        diff --git a/classes/_octra_utilities.SerializableClass.html b/classes/_octra_utilities.SerializableClass.html index 21bb8bae9..0b66db5fb 100644 --- a/classes/_octra_utilities.SerializableClass.html +++ b/classes/_octra_utilities.SerializableClass.html @@ -1,3 +1,3 @@ -SerializableClass | Octra libraries - v2.0.0

        ClassSerializableClass<S, T>Abstract

        Type Parameters

        • S
        • T

        Constructors

        constructor +SerializableClass | Octra libraries - v2.0.0

        ClassSerializableClass<S, T>Abstract

        Type Parameters

        • S
        • T

        Constructors

        constructor

        Methods

        deserializable -

        Constructors

        constructor

        Methods

        Staticdeserializable

        • deserializable<S, T>(jsonObject, sampleRate): undefined | T

        • Type Parameters

          • S
          • T

          Parameters

          • jsonObject: S
          • sampleRate: number

          Returns undefined | T

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        +

        Constructors

        constructor

        Methods

        Staticdeserializable

        • deserializable<S, T>(jsonObject, sampleRate): undefined | T

        • Type Parameters

          • S
          • T

          Parameters

          • jsonObject: S
          • sampleRate: number

          Returns undefined | T

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        diff --git a/classes/_octra_utilities.SubscriptionManager.html b/classes/_octra_utilities.SubscriptionManager.html index 0f1d0ca19..5131ddc85 100644 --- a/classes/_octra_utilities.SubscriptionManager.html +++ b/classes/_octra_utilities.SubscriptionManager.html @@ -1,15 +1,15 @@ -SubscriptionManager | Octra libraries - v2.0.0

        ClassSubscriptionManager<T>

        Type Parameters

        • T

        Constructors

        constructor +SubscriptionManager | Octra libraries - v2.0.0

        ClassSubscriptionManager<T>

        Type Parameters

        • T

        Constructors

        constructor

        Methods

        add destroy removeById removeByTag -

        Constructors

        constructor

        Methods

        add

        • add(subscription, tag?): number

        • add subscription to the manager. Returns the id of the subscriptions

          +

        Constructors

        constructor

        Methods

        add

        • add(subscription, tag?): number

        • add subscription to the manager. Returns the id of the subscriptions

          Parameters

          • subscription: undefined | T

            subscription that shall be added

          • Optionaltag: string

            optional tag

          Returns number

          number

          -

        destroy

        removeById

        destroy

        removeById

        • removeById(id): boolean

        • unsubscribes specific Subscription with specific id.

          Parameters

          • id: number

            id that is looked for

            -

          Returns boolean

        removeByTag

        • removeByTag(tag): boolean

        • unsubscribes all subscriptions with a specific tag

          +

        Returns boolean

        removeByTag

        • removeByTag(tag): boolean

        • unsubscribes all subscriptions with a specific tag

          Parameters

          • tag: string

            name that is tagged to the subscription

            -

          Returns boolean

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        +

        Returns boolean

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        diff --git a/classes/_octra_web_media.AudioChunk.html b/classes/_octra_web_media.AudioChunk.html index de779fab1..f3f77dd10 100644 --- a/classes/_octra_web_media.AudioChunk.html +++ b/classes/_octra_web_media.AudioChunk.html @@ -1,5 +1,5 @@ AudioChunk | Octra libraries - v2.0.0

        ClassAudioChunk

        AUDIOCHUNK begins here

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        statuschange stopPlayback

        Accessors

        absolutePlayposition @@ -26,7 +26,7 @@ stepBackward stepBackwardTime toggleReplay -

        Constructors

        constructor

        Properties

        statuschange

        statuschange: Subject<PlayBackStatus> = ...

        stopPlayback

        stopPlayback: (() => Promise<void>) = ...

        stops the playback

        -

        Accessors

        absolutePlayposition

        audioManager

        id

        isPlaybackEnded

        isPlaybackStarted

        isPlayBackStopped

        isPlaying

        lastplayedpos

        playbackRate

        relativePlayposition

        replay

        sampleRate

        selection

        startpos

        Constructors

        constructor

        Properties

        statuschange

        statuschange: Subject<PlayBackStatus> = ...

        stopPlayback

        stopPlayback: (() => Promise<void>) = ...

        stops the playback

        +

        Accessors

        absolutePlayposition

        audioManager

        id

        isPlaybackEnded

        isPlaybackStarted

        isPlayBackStopped

        isPlaying

        lastplayedpos

        playbackRate

        relativePlayposition

        replay

        sampleRate

        selection

        startpos

        status

        time

        volume

        Methods

        clone

        destroy

        pausePlayback

        startPlayback

        • startPlayback(playOnHover?): Promise<void>

        • Parameters

          • playOnHover: boolean = false

          Returns Promise<void>

        stepBackward

        stepBackwardTime

        toggleReplay

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Parameters

        Returns void

        status

        time

        volume

        Methods

        clone

        destroy

        pausePlayback

        startPlayback

        • startPlayback(playOnHover?): Promise<void>

        • Parameters

          • playOnHover: boolean = false

          Returns Promise<void>

        stepBackward

        stepBackwardTime

        toggleReplay

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.AudioDecoder.html b/classes/_octra_web_media.AudioDecoder.html index 5c6272d9a..55685264b 100644 --- a/classes/_octra_web_media.AudioDecoder.html +++ b/classes/_octra_web_media.AudioDecoder.html @@ -1,5 +1,5 @@ AudioDecoder | Octra libraries - v2.0.0

        ClassAudioDecoder

        The AudioDecoder is used as a replacement for the Web Audio API decoding and makes use of web workers.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        onChannelDataCalculate started

        Accessors

        channelDataFactor @@ -8,5 +8,5 @@ getChunkedChannelData minimizeChannelData requeststopDecoding -

        Constructors

        constructor

        Properties

        onChannelDataCalculate

        onChannelDataCalculate: Subject<{
            progress: number;
            result?: Float32Array;
        }> = ...

        triggers as soon as new channel data was read. Last event has progress 1.

        -

        started

        started: number = 0

        Accessors

        channelDataFactor

        Methods

        createOriginalSample

        destroy

        getChunkedChannelData

        minimizeChannelData

        • minimizeChannelData(channelData, factor): Promise<Float32Array>

        • Parameters

          • channelData: Float32Array
          • factor: number

          Returns Promise<Float32Array>

        requeststopDecoding

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Constructors

        constructor

        Properties

        onChannelDataCalculate

        onChannelDataCalculate: Subject<{
            progress: number;
            result?: Float32Array;
        }> = ...

        triggers as soon as new channel data was read. Last event has progress 1.

        +

        started

        started: number = 0

        Accessors

        channelDataFactor

        Methods

        createOriginalSample

        destroy

        getChunkedChannelData

        minimizeChannelData

        • minimizeChannelData(channelData, factor): Promise<Float32Array>

        • Parameters

          • channelData: Float32Array
          • factor: number

          Returns Promise<Float32Array>

        requeststopDecoding

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.AudioFormat.html b/classes/_octra_web_media.AudioFormat.html index 222782a02..094d262c9 100644 --- a/classes/_octra_web_media.AudioFormat.html +++ b/classes/_octra_web_media.AudioFormat.html @@ -1,4 +1,4 @@ -AudioFormat | Octra libraries - v2.0.0

        ClassAudioFormatAbstract

        Hierarchy (view full)

        Constructors

        constructor +AudioFormat | Octra libraries - v2.0.0

        ClassAudioFormatAbstract

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        _bitsPerSample _byteRate _channels @@ -21,4 +21,4 @@ setChannels setDuration setSampleRate -

        Constructors

        constructor

        Properties

        Protected_bitsPerSample

        _bitsPerSample: number

        Protected_byteRate

        _byteRate: number

        Protected_channels

        _channels: number

        Protected_duration

        _duration: number

        Protected_extension

        _extension: string

        Protected_filename

        _filename: string

        Protected_sampleRate

        _sampleRate: number

        formatConstructor

        formatConstructor: Uint8ArrayConstructor | Int16ArrayConstructor | Int32ArrayConstructor

        Accessors

        bitsPerSample

        byteRate

        channels

        duration

        extension

        filename

        sampleRate

        Methods

        init

        AbstractisValid

        Protected AbstractsetBitsPerSample

        Protected AbstractsetByteRate

        Protected AbstractsetChannels

        Protected AbstractsetDuration

        Protected AbstractsetSampleRate

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Constructors

        constructor

        Properties

        Protected_bitsPerSample

        _bitsPerSample: number

        Protected_byteRate

        _byteRate: number

        Protected_channels

        _channels: number

        Protected_duration

        _duration: number

        Protected_extension

        _extension: string

        Protected_filename

        _filename: string

        Protected_sampleRate

        _sampleRate: number

        formatConstructor

        formatConstructor: Uint8ArrayConstructor | Int16ArrayConstructor | Int32ArrayConstructor

        Accessors

        bitsPerSample

        byteRate

        channels

        duration

        extension

        filename

        sampleRate

        Methods

        init

        AbstractisValid

        Protected AbstractsetBitsPerSample

        Protected AbstractsetByteRate

        Protected AbstractsetChannels

        Protected AbstractsetDuration

        Protected AbstractsetSampleRate

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.AudioInfo.html b/classes/_octra_web_media.AudioInfo.html index 529ed1f80..812a11cc7 100644 --- a/classes/_octra_web_media.AudioInfo.html +++ b/classes/_octra_web_media.AudioInfo.html @@ -1,4 +1,4 @@ -AudioInfo | Octra libraries - v2.0.0

        ClassAudioInfo

        Hierarchy (view full)

        Constructors

        constructor +AudioInfo | Octra libraries - v2.0.0

        ClassAudioInfo

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        _extension _file _hash? @@ -35,7 +35,7 @@ getFileFromContent getMimeTypeByExtension renameFile -

        Constructors

        constructor

        • new AudioInfo(filename, type, size, sampleRate, durationSamples, channels, bitrate): AudioInfo

        • Parameters

          • filename: string
          • type: string
          • size: number
          • sampleRate: number
          • durationSamples: number
          • channels: number
          • bitrate: number

          Returns AudioInfo

        Properties

        Protected_extension

        _extension: string

        Protected_file

        _file: undefined | File

        Protected Optional_hash

        _hash?: string

        Protected_name

        _name: string

        Protected_size

        _size: number

        Protected_type

        _type: string

        Protected Optional_url

        _url?: string

        Accessors

        attributes

        available

        • get available(): boolean

        • returns if the file is ready for processing

          -

          Returns boolean

        bitrate

        channels

        createdAt

        duration

        extension

        • get extension(): string

        • extension including the dot. (this must contain a dot!)

          -

          Returns string

        file

        fullname

        hash

        • get hash(): undefined | string

        • Returns undefined | string

        • set hash(value): void

        • Parameters

          • value: undefined | string

          Returns void

        name

        online

        sampleRate

        size

        type

        url

        Methods

        getBase64

        isMediaFile

        toAny

        updateContentFromURL

        StaticescapeFileName

        StaticextractFileName

        • extractFileName(fullname): {
              extension: string;
              name: string;
          }

        • Parameters

          • fullname: string

          Returns {
              extension: string;
              name: string;
          }

          • extension: string
          • name: string

        StaticfromAny

        StaticfromFileObject

        StaticfromURL

        • fromURL(url, type?, name?, createdAt?, size?): FileInfo

        • creates a FileInfo instance form a URL. It doesn't contain the file itself.

          -

          Parameters

          • url: string
          • Optionaltype: string
          • Optionalname: string
          • createdAt: number = 0
          • Optionalsize: number

          Returns FileInfo

        StaticgetFileContent

        StaticgetFileFromContent

        StaticgetMimeTypeByExtension

        • getMimeTypeByExtension(extension):
              | "audio/wav"
              | "audio/mpeg"
              | "audio/ogg"
              | "audio/opus"
              | "video/mp4"
              | "image/png"
              | "image/jpg"
              | "application/pdf"
              | "application/json"
              | "text/plain"

        • Parameters

          • extension: string

          Returns
              | "audio/wav"
              | "audio/mpeg"
              | "audio/ogg"
              | "audio/opus"
              | "video/mp4"
              | "image/png"
              | "image/jpg"
              | "application/pdf"
              | "application/json"
              | "text/plain"

        StaticrenameFile

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Constructors

        constructor

        • new AudioInfo(filename, type, size, sampleRate, durationSamples, channels, bitrate): AudioInfo

        • Parameters

          • filename: string
          • type: string
          • size: number
          • sampleRate: number
          • durationSamples: number
          • channels: number
          • bitrate: number

          Returns AudioInfo

        Properties

        Protected_extension

        _extension: string

        Protected_file

        _file: undefined | File

        Protected Optional_hash

        _hash?: string

        Protected_name

        _name: string

        Protected_size

        _size: number

        Protected_type

        _type: string

        Protected Optional_url

        _url?: string

        Accessors

        attributes

        available

        • get available(): boolean

        • returns if the file is ready for processing

          +

          Returns boolean

        bitrate

        channels

        createdAt

        duration

        extension

        • get extension(): string

        • extension including the dot. (this must contain a dot!)

          +

          Returns string

        file

        fullname

        hash

        • get hash(): undefined | string

        • Returns undefined | string

        • set hash(value): void

        • Parameters

          • value: undefined | string

          Returns void

        name

        online

        sampleRate

        size

        type

        url

        Methods

        getBase64

        isMediaFile

        toAny

        updateContentFromURL

        StaticescapeFileName

        StaticextractFileName

        • extractFileName(fullname): {
              extension: string;
              name: string;
          }

        • Parameters

          • fullname: string

          Returns {
              extension: string;
              name: string;
          }

          • extension: string
          • name: string

        StaticfromAny

        StaticfromFileObject

        StaticfromURL

        • fromURL(url, type?, name?, createdAt?, size?): FileInfo

        • creates a FileInfo instance form a URL. It doesn't contain the file itself.

          +

          Parameters

          • url: string
          • Optionaltype: string
          • Optionalname: string
          • createdAt: number = 0
          • Optionalsize: number

          Returns FileInfo

        StaticgetFileContent

        StaticgetFileFromContent

        StaticgetMimeTypeByExtension

        • getMimeTypeByExtension(extension):
              | "audio/wav"
              | "audio/mpeg"
              | "audio/ogg"
              | "audio/opus"
              | "video/mp4"
              | "image/png"
              | "image/jpg"
              | "application/pdf"
              | "application/json"
              | "text/plain"

        • Parameters

          • extension: string

          Returns
              | "audio/wav"
              | "audio/mpeg"
              | "audio/ogg"
              | "audio/opus"
              | "video/mp4"
              | "image/png"
              | "image/jpg"
              | "application/pdf"
              | "application/json"
              | "text/plain"

        StaticrenameFile

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.AudioManager.html b/classes/_octra_web_media.AudioManager.html index 5f0893c85..d12b059a8 100644 --- a/classes/_octra_web_media.AudioManager.html +++ b/classes/_octra_web_media.AudioManager.html @@ -1,5 +1,5 @@ AudioManager | Octra libraries - v2.0.0

        ClassAudioManager

        AudioManager controls the audio file and all of its chunk. Each audio file should have exactly one manager. The AudioManager uses HTML Audio for playback.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        time

        Accessors

        audioMechanism channel @@ -28,17 +28,17 @@ getNumberOfDataParts isValidAudioFileName

        Constructors

        constructor

        Properties

        time

        time: {
            end: number;
            start: number;
        } = ...

        Accessors

        audioMechanism

        channel

        channelDataFactor

        gainNode

        isPlaying

        mainchunk

        onChannelDataChange

        playOnHover

        playPosition

        resource

        sampleRate

        state

        statechange

        Methods

        addChunk

        createNewAudioChunk

        createSampleUnit

        destroy

        • destroy(disconnect?): Promise<void>

        • destroys the audio manager

          -

          Parameters

          • disconnect: boolean = true

          Returns Promise<void>

        pausePlayback

        removeChunk

        startPlayback

        • startPlayback(audioSelection, volume, playbackRate, playOnHover?): Promise<void>

        • starts audio playback using a given selection.

          -

          Parameters

          • audioSelection: AudioSelection
          • volume: number
          • playbackRate: number
          • playOnHover: boolean = false

          Returns Promise<void>

        stopDecoding

        stopPlayback

        Staticcreate

        • create(filename, type, buffer, url?, audioMechanism?): Observable<{
              audioManager: AudioManager;
              progress: number;
          }>

        • creates a new audio manager and reports the progress using an observable. The initialization includes audio decoding.

          -

          Parameters

          • filename: string
          • type: string
          • buffer: ArrayBuffer
          • Optionalurl: string
          • audioMechanism: AudioMechanism = ...

          Returns Observable<{
              audioManager: AudioManager;
              progress: number;
          }>

        StaticgetFileFormat

        • getFileFormat(extension, audioformats): undefined | AudioFormat

        • returns the FileFormat instance relative of the file extension or undefined if not found.

          +

          Parameters

          • audioMechanism: AudioMechanism

          Returns AudioManager

        Properties

        time

        time: {
            end: number;
            start: number;
        } = ...

        Accessors

        audioMechanism

        channel

        channelDataFactor

        gainNode

        isPlaying

        mainchunk

        onChannelDataChange

        playOnHover

        playPosition

        resource

        sampleRate

        state

        statechange

        Methods

        addChunk

        createNewAudioChunk

        createSampleUnit

        destroy

        • destroy(disconnect?): Promise<void>

        • destroys the audio manager

          +

          Parameters

          • disconnect: boolean = true

          Returns Promise<void>

        pausePlayback

        removeChunk

        startPlayback

        • startPlayback(audioSelection, volume, playbackRate, playOnHover?): Promise<void>

        • starts audio playback using a given selection.

          +

          Parameters

          • audioSelection: AudioSelection
          • volume: number
          • playbackRate: number
          • playOnHover: boolean = false

          Returns Promise<void>

        stopDecoding

        stopPlayback

        Staticcreate

        • create(filename, type, buffer, url?, audioMechanism?): Observable<{
              audioManager: AudioManager;
              progress: number;
          }>

        • creates a new audio manager and reports the progress using an observable. The initialization includes audio decoding.

          +

          Parameters

          • filename: string
          • type: string
          • buffer: ArrayBuffer
          • Optionalurl: string
          • audioMechanism: AudioMechanism = ...

          Returns Observable<{
              audioManager: AudioManager;
              progress: number;
          }>

        StaticgetFileFormat

        • getFileFormat(extension, audioformats): undefined | AudioFormat

        • returns the FileFormat instance relative of the file extension or undefined if not found.

          Parameters

          • extension: string

            file extension

          • audioformats: AudioFormat[]

            list of supported audio formats

            -

          Returns undefined | AudioFormat

        StaticgetNumberOfDataParts

        • getNumberOfDataParts(fileSize): number

        • returns the number of data parts

          -

          Parameters

          • fileSize: number

          Returns number

        StaticisValidAudioFileName

        • isValidAudioFileName(filename, audioFormats): boolean

        • checks if there is an audio format that matches with the extension of the audio file.

          -

          Parameters

          Returns boolean

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Returns undefined | AudioFormat

        StaticgetNumberOfDataParts

        StaticisValidAudioFileName

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.AudioResource.html b/classes/_octra_web_media.AudioResource.html index d55e044d9..168acf990 100644 --- a/classes/_octra_web_media.AudioResource.html +++ b/classes/_octra_web_media.AudioResource.html @@ -1,4 +1,4 @@ -AudioResource | Octra libraries - v2.0.0

        ClassAudioResource

        Hierarchy

        • MediaResource
          • AudioResource

        Constructors

        constructor +AudioResource | Octra libraries - v2.0.0

        ClassAudioResource

        Hierarchy

        • MediaResource
          • AudioResource

        Constructors

        constructor

        Accessors

        arraybuffer extension info @@ -6,4 +6,4 @@ size url

        Methods

        getOAudioFile -

        Constructors

        constructor

        Accessors

        arraybuffer

        • get arraybuffer(): undefined | ArrayBuffer

        • Returns undefined | ArrayBuffer

        • set arraybuffer(value): void

        • Parameters

          • value: undefined | ArrayBuffer

          Returns void

        extension

        • get extension(): string

        • Returns string

        info

        name

        size

        • get size(): undefined | number

        • Returns undefined | number

        url

        • get url(): undefined | string

        • Returns undefined | string

        Methods

        getOAudioFile

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        +

        Constructors

        constructor

        Accessors

        arraybuffer

        • get arraybuffer(): undefined | ArrayBuffer

        • Returns undefined | ArrayBuffer

        • set arraybuffer(value): void

        • Parameters

          • value: undefined | ArrayBuffer

          Returns void

        extension

        • get extension(): string

        • Returns string

        info

        name

        size

        • get size(): undefined | number

        • Returns undefined | number

        url

        • get url(): undefined | string

        • Returns undefined | string

        Methods

        getOAudioFile

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.AudioTimeCalculator.html b/classes/_octra_web_media.AudioTimeCalculator.html index 0ac603824..09513c375 100644 --- a/classes/_octra_web_media.AudioTimeCalculator.html +++ b/classes/_octra_web_media.AudioTimeCalculator.html @@ -1,4 +1,4 @@ -AudioTimeCalculator | Octra libraries - v2.0.0

        ClassAudioTimeCalculator

        Constructors

        constructor +AudioTimeCalculator | Octra libraries - v2.0.0

        ClassAudioTimeCalculator

        Constructors

        constructor

        Properties

        _duration audioPxWidth

        Accessors

        duration @@ -8,4 +8,4 @@ samplesToSeconds secondsToSamples roundSamples -

        Constructors

        constructor

        Properties

        _duration

        _duration: SampleUnit

        audioPxWidth

        audioPxWidth: number

        Accessors

        duration

        Methods

        absXChunktoSampleUnit

        absXtoSamples2

        samplestoAbsX

        samplesToSeconds

        secondsToSamples

        StaticroundSamples

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Constructors

        constructor

        Properties

        _duration

        _duration: SampleUnit

        audioPxWidth

        audioPxWidth: number

        Accessors

        duration

        Methods

        absXChunktoSampleUnit

        absXtoSamples2

        samplestoAbsX

        samplesToSeconds

        secondsToSamples

        StaticroundSamples

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.BrowserInfo.html b/classes/_octra_web_media.BrowserInfo.html index bbb3eb5ab..0229b1458 100644 --- a/classes/_octra_web_media.BrowserInfo.html +++ b/classes/_octra_web_media.BrowserInfo.html @@ -1,10 +1,10 @@ -BrowserInfo | Octra libraries - v2.0.0

        ClassBrowserInfo

        Constructors

        constructor +BrowserInfo | Octra libraries - v2.0.0

        ClassBrowserInfo

        Constructors

        constructor

        Accessors

        browser os platform version

        Constructors

        constructor

        Accessors

        Staticbrowser

        • get browser(): undefined | string

        • returns the browser name

          -

          Returns undefined | string

        Staticos

        Staticplatform

        • get platform(): "mac" | "pc"

        • returns if current system is mac or pc.

          -

          Returns "mac" | "pc"

        Staticversion

        • get version(): undefined | string

        • returns version

          -

          Returns undefined | string

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        +

        Returns undefined | string

        Staticos

        Staticplatform

        • get platform(): "mac" | "pc"

        • returns if current system is mac or pc.

          +

          Returns "mac" | "pc"

        Staticversion

        • get version(): undefined | string

        • returns version

          +

          Returns undefined | string

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        diff --git a/classes/_octra_web_media.DataInfo.html b/classes/_octra_web_media.DataInfo.html index d90af541a..91c4067bc 100644 --- a/classes/_octra_web_media.DataInfo.html +++ b/classes/_octra_web_media.DataInfo.html @@ -1,4 +1,4 @@ -DataInfo | Octra libraries - v2.0.0

        ClassDataInfo

        Hierarchy (view full)

        Constructors

        constructor +DataInfo | Octra libraries - v2.0.0

        ClassDataInfo

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        _hash? _name _size @@ -8,4 +8,4 @@ name size type -

        Constructors

        constructor

        Properties

        Protected Optional_hash

        _hash?: string

        Protected_name

        _name: string

        Protected_size

        _size: number

        Protected_type

        _type: string

        Accessors

        attributes

        hash

        name

        size

        type

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        +

        Constructors

        constructor

        Properties

        Protected Optional_hash

        _hash?: string

        Protected_name

        _name: string

        Protected_size

        _size: number

        Protected_type

        _type: string

        Accessors

        attributes

        hash

        name

        size

        type

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        diff --git a/classes/_octra_web_media.DirectoryInfo.html b/classes/_octra_web_media.DirectoryInfo.html index 4042c4f4e..9fd5cd602 100644 --- a/classes/_octra_web_media.DirectoryInfo.html +++ b/classes/_octra_web_media.DirectoryInfo.html @@ -1,4 +1,4 @@ -DirectoryInfo | Octra libraries - v2.0.0

        ClassDirectoryInfo

        Hierarchy (view full)

        Constructors

        constructor +DirectoryInfo | Octra libraries - v2.0.0

        ClassDirectoryInfo

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        _hash? _name _size @@ -14,4 +14,4 @@ clone extractFolderName fromFolderObject -

        Constructors

        constructor

        Properties

        Protected Optional_hash

        _hash?: string

        Protected_name

        _name: string

        Protected_size

        _size: number

        Protected_type

        _type: string

        Accessors

        attributes

        entries

        hash

        • get hash(): undefined | string

        • Returns undefined | string

        • set hash(value): void

        • Parameters

          • value: undefined | string

          Returns void

        name

        path

        size

        type

        Methods

        addEntries

        clone

        StaticextractFolderName

        StaticfromFolderObject

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Constructors

        constructor

        Properties

        Protected Optional_hash

        _hash?: string

        Protected_name

        _name: string

        Protected_size

        _size: number

        Protected_type

        _type: string

        Accessors

        attributes

        entries

        hash

        • get hash(): undefined | string

        • Returns undefined | string

        • set hash(value): void

        • Parameters

          • value: undefined | string

          Returns void

        name

        path

        size

        type

        Methods

        addEntries

        clone

        StaticextractFolderName

        StaticfromFolderObject

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.FileInfo.html b/classes/_octra_web_media.FileInfo.html index e28ca4af7..122b692e6 100644 --- a/classes/_octra_web_media.FileInfo.html +++ b/classes/_octra_web_media.FileInfo.html @@ -1,4 +1,4 @@ -FileInfo | Octra libraries - v2.0.0

        ClassFileInfo

        Hierarchy (view full)

        Constructors

        constructor +FileInfo | Octra libraries - v2.0.0

        ClassFileInfo

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        _extension _file _hash? @@ -31,7 +31,7 @@ getFileFromContent getMimeTypeByExtension renameFile -

        Constructors

        constructor

        Properties

        Protected_extension

        _extension: string

        Protected_file

        _file: undefined | File

        Protected Optional_hash

        _hash?: string

        Protected_name

        _name: string

        Protected_size

        _size: number

        Protected_type

        _type: string

        Protected Optional_url

        _url?: string

        Accessors

        attributes

        available

        createdAt

        extension

        • get extension(): string

        • extension including the dot. (this must contain a dot!)

          -

          Returns string

        file

        fullname

        hash

        • get hash(): undefined | string

        • Returns undefined | string

        • set hash(value): void

        • Parameters

          • value: undefined | string

          Returns void

        name

        online

        size

        type

        url

        Methods

        getBase64

        isMediaFile

        toAny

        updateContentFromURL

        • updateContentFromURL(httpClient): Promise<string>

        • Parameters

          • httpClient: any

          Returns Promise<string>

        StaticescapeFileName

        StaticextractFileName

        • extractFileName(fullname): {
              extension: string;
              name: string;
          }

        • Parameters

          • fullname: string

          Returns {
              extension: string;
              name: string;
          }

          • extension: string
          • name: string

        StaticfromAny

        StaticfromFileObject

        StaticfromURL

        • fromURL(url, type?, name?, createdAt?, size?): FileInfo

        • creates a FileInfo instance form a URL. It doesn't contain the file itself.

          -

          Parameters

          • url: string
          • Optionaltype: string
          • Optionalname: string
          • createdAt: number = 0
          • Optionalsize: number

          Returns FileInfo

        StaticgetFileContent

        • getFileContent(file, encoding?): Promise<string>

        • Parameters

          • file: File
          • Optionalencoding: string

          Returns Promise<string>

        StaticgetFileFromContent

        • getFileFromContent(content, filename, type?): File

        • Parameters

          • content: string
          • filename: string
          • Optionaltype: string

          Returns File

        StaticgetMimeTypeByExtension

        • getMimeTypeByExtension(extension):
              | "audio/wav"
              | "audio/mpeg"
              | "audio/ogg"
              | "audio/opus"
              | "video/mp4"
              | "image/png"
              | "image/jpg"
              | "application/pdf"
              | "application/json"
              | "text/plain"

        • Parameters

          • extension: string

          Returns
              | "audio/wav"
              | "audio/mpeg"
              | "audio/ogg"
              | "audio/opus"
              | "video/mp4"
              | "image/png"
              | "image/jpg"
              | "application/pdf"
              | "application/json"
              | "text/plain"

        StaticrenameFile

        • renameFile(file, newName, attributes): Promise<File>

        • Parameters

          • file: File
          • newName: string
          • attributes: any

          Returns Promise<File>

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Constructors

        constructor

        Properties

        Protected_extension

        _extension: string

        Protected_file

        _file: undefined | File

        Protected Optional_hash

        _hash?: string

        Protected_name

        _name: string

        Protected_size

        _size: number

        Protected_type

        _type: string

        Protected Optional_url

        _url?: string

        Accessors

        attributes

        available

        createdAt

        extension

        • get extension(): string

        • extension including the dot. (this must contain a dot!)

          +

          Returns string

        file

        fullname

        hash

        • get hash(): undefined | string

        • Returns undefined | string

        • set hash(value): void

        • Parameters

          • value: undefined | string

          Returns void

        name

        online

        size

        type

        url

        Methods

        getBase64

        isMediaFile

        toAny

        updateContentFromURL

        • updateContentFromURL(httpClient): Promise<string>

        • Parameters

          • httpClient: any

          Returns Promise<string>

        StaticescapeFileName

        StaticextractFileName

        • extractFileName(fullname): {
              extension: string;
              name: string;
          }

        • Parameters

          • fullname: string

          Returns {
              extension: string;
              name: string;
          }

          • extension: string
          • name: string

        StaticfromAny

        StaticfromFileObject

        StaticfromURL

        • fromURL(url, type?, name?, createdAt?, size?): FileInfo

        • creates a FileInfo instance form a URL. It doesn't contain the file itself.

          +

          Parameters

          • url: string
          • Optionaltype: string
          • Optionalname: string
          • createdAt: number = 0
          • Optionalsize: number

          Returns FileInfo

        StaticgetFileContent

        • getFileContent(file, encoding?): Promise<string>

        • Parameters

          • file: File
          • Optionalencoding: string

          Returns Promise<string>

        StaticgetFileFromContent

        • getFileFromContent(content, filename, type?): File

        • Parameters

          • content: string
          • filename: string
          • Optionaltype: string

          Returns File

        StaticgetMimeTypeByExtension

        • getMimeTypeByExtension(extension):
              | "audio/wav"
              | "audio/mpeg"
              | "audio/ogg"
              | "audio/opus"
              | "video/mp4"
              | "image/png"
              | "image/jpg"
              | "application/pdf"
              | "application/json"
              | "text/plain"

        • Parameters

          • extension: string

          Returns
              | "audio/wav"
              | "audio/mpeg"
              | "audio/ogg"
              | "audio/opus"
              | "video/mp4"
              | "image/png"
              | "image/jpg"
              | "application/pdf"
              | "application/json"
              | "text/plain"

        StaticrenameFile

        • renameFile(file, newName, attributes): Promise<File>

        • Parameters

          • file: File
          • newName: string
          • attributes: any

          Returns Promise<File>

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.OggFormat.html b/classes/_octra_web_media.OggFormat.html index 054786f41..6b0d8ae93 100644 --- a/classes/_octra_web_media.OggFormat.html +++ b/classes/_octra_web_media.OggFormat.html @@ -1,4 +1,4 @@ -OggFormat | Octra libraries - v2.0.0

        ClassOggFormat

        Hierarchy (view full)

        Constructors

        constructor +OggFormat | Octra libraries - v2.0.0

        ClassOggFormat

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        _bitsPerSample _byteRate _channels @@ -25,6 +25,6 @@ setChannels setDuration setSampleRate -

        Constructors

        constructor

        Properties

        Protected_bitsPerSample

        _bitsPerSample: number

        Protected_byteRate

        _byteRate: number

        Protected_channels

        _channels: number

        Protected_duration

        _duration: number

        Protected_extension

        _extension: string

        Protected_filename

        _filename: string

        Protected_sampleRate

        _sampleRate: number

        bitStreamLength

        bitStreamLength: number

        formatConstructor

        formatConstructor: Uint8ArrayConstructor | Int16ArrayConstructor | Int32ArrayConstructor

        granulePosition

        granulePosition: number

        A granule position is the time marker in Ogg files. It is an abstract value, whose meaning is determined by the codec. +

        Constructors

        constructor

        Properties

        Protected_bitsPerSample

        _bitsPerSample: number

        Protected_byteRate

        _byteRate: number

        Protected_channels

        _channels: number

        Protected_duration

        _duration: number

        Protected_extension

        _extension: string

        Protected_filename

        _filename: string

        Protected_sampleRate

        _sampleRate: number

        bitStreamLength

        bitStreamLength: number

        formatConstructor

        formatConstructor: Uint8ArrayConstructor | Int16ArrayConstructor | Int32ArrayConstructor

        granulePosition

        granulePosition: number

        A granule position is the time marker in Ogg files. It is an abstract value, whose meaning is determined by the codec. It may, for example, be a count of the number of samples, the number of frames or a more complex scheme.

        -

        headerType

        headerType: number

        version

        version: number

        Accessors

        bitsPerSample

        byteRate

        channels

        duration

        extension

        filename

        sampleRate

        Methods

        init

        isValid

        ProtectedsetBitsPerSample

        ProtectedsetByteRate

        ProtectedsetChannels

        ProtectedsetDuration

        ProtectedsetSampleRate

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        headerType

        headerType: number

        version

        version: number

        Accessors

        bitsPerSample

        byteRate

        channels

        duration

        extension

        filename

        sampleRate

        Methods

        init

        isValid

        ProtectedsetBitsPerSample

        ProtectedsetByteRate

        ProtectedsetChannels

        ProtectedsetDuration

        ProtectedsetSampleRate

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.ShortcutManager.html b/classes/_octra_web_media.ShortcutManager.html index 994666f07..3f4d49117 100644 --- a/classes/_octra_web_media.ShortcutManager.html +++ b/classes/_octra_web_media.ShortcutManager.html @@ -1,5 +1,5 @@ ShortcutManager | Octra libraries - v2.0.0

        ClassShortcutManager

        manages all supported shortcuts

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        generalShortcuts shortcutsEnabled

        Accessors

        pressedKeys @@ -15,4 +15,4 @@ resetPressedKeys unregisterItemFromGroup unregisterShortcutGroup -

        Constructors

        constructor

        Properties

        generalShortcuts

        generalShortcuts: ShortcutGroup = ...

        shortcutsEnabled

        shortcutsEnabled: boolean = true

        Accessors

        pressedKeys

        • get pressedKeys(): {
              alt: boolean;
              cmd: boolean;
              ctrl: boolean;
              other: number;
              shift: boolean;
          }

        • Returns {
              alt: boolean;
              cmd: boolean;
              ctrl: boolean;
              other: number;
              shift: boolean;
          }

          • alt: boolean
          • cmd: boolean
          • ctrl: boolean
          • other: number
          • shift: boolean

        shortcuts

        Methods

        checkKeyEvent

        clearShortcuts

        disableShortcutGroup

        enableShortcutGroup

        getCommandByEvent

        • getCommandByEvent(event): undefined | {
              groupName: string;
              shortcut: Shortcut;
          }

        • Parameters

          • event: KeyboardEvent

          Returns undefined | {
              groupName: string;
              shortcut: Shortcut;
          }

        getShorcutCombination

        getShortcutGroup

        registerShortcutGroup

        resetPressedKeys

        unregisterItemFromGroup

        • unregisterItemFromGroup(groupName, itemName): void

        • Parameters

          • groupName: string
          • itemName: string

          Returns void

        unregisterShortcutGroup

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Constructors

        constructor

        Properties

        generalShortcuts

        generalShortcuts: ShortcutGroup = ...

        shortcutsEnabled

        shortcutsEnabled: boolean = true

        Accessors

        pressedKeys

        • get pressedKeys(): {
              alt: boolean;
              cmd: boolean;
              ctrl: boolean;
              other: number;
              shift: boolean;
          }

        • Returns {
              alt: boolean;
              cmd: boolean;
              ctrl: boolean;
              other: number;
              shift: boolean;
          }

          • alt: boolean
          • cmd: boolean
          • ctrl: boolean
          • other: number
          • shift: boolean

        shortcuts

        Methods

        checkKeyEvent

        clearShortcuts

        disableShortcutGroup

        enableShortcutGroup

        getCommandByEvent

        • getCommandByEvent(event): undefined | {
              groupName: string;
              shortcut: Shortcut;
          }

        • Parameters

          • event: KeyboardEvent

          Returns undefined | {
              groupName: string;
              shortcut: Shortcut;
          }

        getShorcutCombination

        getShortcutGroup

        registerShortcutGroup

        resetPressedKeys

        unregisterItemFromGroup

        • unregisterItemFromGroup(groupName, itemName): void

        • Parameters

          • groupName: string
          • itemName: string

          Returns void

        unregisterShortcutGroup

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.TsWorker.html b/classes/_octra_web_media.TsWorker.html index 898034131..8e90957c3 100644 --- a/classes/_octra_web_media.TsWorker.html +++ b/classes/_octra_web_media.TsWorker.html @@ -1,5 +1,5 @@ TsWorker | Octra libraries - v2.0.0

        ClassTsWorker

        Inline web worker that runs jobs asynchronously.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        id jobstatuschange queue @@ -10,15 +10,15 @@ getRunningJobID hasJob removeJobByID -

        Constructors

        constructor

        Accessors

        id

        jobstatuschange

        queue

        Methods

        addJob

        • addJob(job): void

        • adds a job to the worker's queue and starts it automatically

          +

        Constructors

        constructor

        Accessors

        id

        jobstatuschange

        queue

        Methods

        addJob

        checkBeforeStart

        • checkBeforeStart(): void

        • starts the next free job if no other is running.

          -

          Returns void

        destroy

        getFirstFreeJob

        getRunningJobID

        hasJob

        • hasJob(job): boolean

        • checks if job is already in the queue

          +

        Returns void

        checkBeforeStart

        • checkBeforeStart(): void

        • starts the next free job if no other is running.

          +

          Returns void

        destroy

        getFirstFreeJob

        getRunningJobID

        hasJob

        removeJobByID

        • removeJobByID(id): void

        • removes a job from the queue and tries to start another

          +

        Returns boolean

        removeJobByID

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        +

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.TsWorkerJob.html b/classes/_octra_web_media.TsWorkerJob.html index 923b94450..41f0242cd 100644 --- a/classes/_octra_web_media.TsWorkerJob.html +++ b/classes/_octra_web_media.TsWorkerJob.html @@ -1,5 +1,5 @@ TsWorkerJob | Octra libraries - v2.0.0

        ClassTsWorkerJob

        This class defines a task with given function and parameters.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        args doFunction

        Accessors

        id @@ -7,13 +7,13 @@ statistics status

        Methods

        changeStatus -

        Constructors

        constructor

        Properties

        args

        args: any[] = []

        doFunction

        doFunction: string | ((args: any[]) => Promise<any>) = ...

        this function will be run in the web worker

        -

        Accessors

        id

        result

        statistics

        • get statistics(): {
              ended: number;
              started: number;
          }

        • returns timing statistics

          -

          Returns {
              ended: number;
              started: number;
          }

          • ended: number
          • started: number
        • set statistics(value): void

        • sets timing statistics

          +

        Constructors

        constructor

        Properties

        args

        args: any[] = []

        doFunction

        doFunction: string | ((args: any[]) => Promise<any>) = ...

        this function will be run in the web worker

        +

        Accessors

        id

        result

        statistics

        • get statistics(): {
              ended: number;
              started: number;
          }

        • returns timing statistics

          +

          Returns {
              ended: number;
              started: number;
          }

          • ended: number
          • started: number
        • set statistics(value): void

        • sets timing statistics

          Parameters

          • value: {
                ended: number;
                started: number;
            }

            start and end time

            -
            • ended: number
            • started: number

          Returns void

        status

        Methods

        changeStatus

        • changeStatus(status): void

        • changes this job's status

          +
          • ended: number
          • started: number

        Returns void

        status

        Methods

        changeStatus

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/classes/_octra_web_media.WavFormat.html b/classes/_octra_web_media.WavFormat.html index f3878289e..88c5d9ae1 100644 --- a/classes/_octra_web_media.WavFormat.html +++ b/classes/_octra_web_media.WavFormat.html @@ -1,4 +1,4 @@ -WavFormat | Octra libraries - v2.0.0

        ClassWavFormat

        Hierarchy (view full)

        Constructors

        constructor +WavFormat | Octra libraries - v2.0.0

        ClassWavFormat

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        _bitsPerSample _blockAlign _byteRate @@ -35,16 +35,16 @@ setSampleRate splitChannelsToFiles stopAudioSplitting -

        Constructors

        constructor

        Properties

        Protected_bitsPerSample

        _bitsPerSample: number

        Protected_blockAlign

        _blockAlign: number

        Protected_byteRate

        _byteRate: number

        Protected_channels

        _channels: number

        Protected_duration

        _duration: number

        Protected_extension

        _extension: string

        Protected_filename

        _filename: string

        Protected_sampleRate

        _sampleRate: number

        ProtecteddataStart

        dataStart: number = -1

        formatConstructor

        formatConstructor: Uint8ArrayConstructor | Int16ArrayConstructor | Int32ArrayConstructor

        onaudiocut

        onaudiocut: Subject<{
            fileName: string;
            finishedSegments: number;
            intArray: IntArray;
        }> = ...

        Accessors

        bitsPerSample

        blockAlign

        byteRate

        channels

        duration

        extension

        filename

        sampleRate

        Methods

        cutAudioFile

        • cutAudioFile(namingConvention, buffer, segment): Promise<{
              fileName: string;
              uint8Array: Uint8Array;
          }>

        • Parameters

          Returns Promise<{
              fileName: string;
              uint8Array: Uint8Array;
          }>

        cutAudioFileSequentially

        • cutAudioFileSequentially(namingConvention, buffer, segments, pointer?): void

        • cut the audio file sequentially

          +

        Constructors

        constructor

        Properties

        Protected_bitsPerSample

        _bitsPerSample: number

        Protected_blockAlign

        _blockAlign: number

        Protected_byteRate

        _byteRate: number

        Protected_channels

        _channels: number

        Protected_duration

        _duration: number

        Protected_extension

        _extension: string

        Protected_filename

        _filename: string

        Protected_sampleRate

        _sampleRate: number

        ProtecteddataStart

        dataStart: number = -1

        formatConstructor

        formatConstructor: Uint8ArrayConstructor | Int16ArrayConstructor | Int32ArrayConstructor

        onaudiocut

        onaudiocut: Subject<{
            fileName: string;
            finishedSegments: number;
            intArray: IntArray;
        }> = ...

        Accessors

        bitsPerSample

        blockAlign

        byteRate

        channels

        duration

        extension

        filename

        sampleRate

        Methods

        cutAudioFile

        • cutAudioFile(namingConvention, buffer, segment): Promise<{
              fileName: string;
              uint8Array: Uint8Array;
          }>

        • Parameters

          Returns Promise<{
              fileName: string;
              uint8Array: Uint8Array;
          }>

        cutAudioFileSequentially

        • cutAudioFileSequentially(namingConvention, buffer, segments, pointer?): void

        • cut the audio file sequentially

          Parameters

          • namingConvention: string

            the naming convention for file renaming

          • buffer: ArrayBuffer

            the array buffer of the audio file

          • segments: NumeratedSegment[]

            the list of segments for cut

          • pointer: number = 0

            the current segment to be cut

            -

          Returns void

        extractDataFromArray

        • extractDataFromArray(sampleStart, sampleDur, uint8Array, selectedChannel?): Promise<IntArray>

        • cuts the data part of selected samples from an Uint8Array

          +

        Returns void

        extractDataFromArray

        • extractDataFromArray(sampleStart, sampleDur, uint8Array, selectedChannel?): Promise<IntArray>

        • cuts the data part of selected samples from an Uint8Array

          Parameters

          • sampleStart: number

            the start of the extraction

          • sampleDur: number

            the duration of the extraction

          • uint8Array: Uint8Array

            the array to be read

          • OptionalselectedChannel: number

            the selected channel

            -

          Returns Promise<IntArray>

        ProtectedgetDataChunk

        ProtectedgetDataChunkSize

        getFileDataView

        • getFileDataView(data, channels): ArrayBuffer

        • Parameters

          • data:
                | Uint8Array
                | Int16Array
                | Int32Array
                | Uint16Array
                | Uint32Array
                | Int8Array
          • channels: number

          Returns ArrayBuffer

        getNewFileName

        init

        isValid

        • isValid(buffer): boolean

        • checks if it is a valid wave file

          +

        Returns Promise<IntArray>

        ProtectedgetDataChunk

        ProtectedgetDataChunkSize

        getFileDataView

        getNewFileName

        init

        isValid

        ProtectedsetBitsPerSample

        ProtectedsetBlockAlign

        ProtectedsetByteRate

        ProtectedsetChannels

        ProtectedsetDuration

        ProtectedsetSampleRate

        splitChannelsToFiles

        stopAudioSplitting

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Returns boolean

        ProtectedsetBitsPerSample

        ProtectedsetBlockAlign

        ProtectedsetByteRate

        ProtectedsetChannels

        ProtectedsetDuration

        ProtectedsetSampleRate

        splitChannelsToFiles

        stopAudioSplitting

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/enums/_octra_annotation.ASRQueueItemType.html b/enums/_octra_annotation.ASRQueueItemType.html index 1a23cea55..164ffcb2a 100644 --- a/enums/_octra_annotation.ASRQueueItemType.html +++ b/enums/_octra_annotation.ASRQueueItemType.html @@ -1,4 +1,4 @@ -ASRQueueItemType | Octra libraries - v2.0.0

        EnumerationASRQueueItemType

        Enumeration Members

        ASR +ASRQueueItemType | Octra libraries - v2.0.0

        EnumerationASRQueueItemType

        Enumeration Members

        ASR ASRMAUS MAUS -

        Enumeration Members

        ASR

        ASR

        ASRMAUS

        ASRMAUS

        MAUS

        MAUS

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        +

        Enumeration Members

        ASR

        ASR

        ASRMAUS

        ASRMAUS

        MAUS

        MAUS

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        diff --git a/enums/_octra_annotation.AnnotationLevelType.html b/enums/_octra_annotation.AnnotationLevelType.html index f13f7bcc0..0cfb6f45b 100644 --- a/enums/_octra_annotation.AnnotationLevelType.html +++ b/enums/_octra_annotation.AnnotationLevelType.html @@ -1,4 +1,4 @@ -AnnotationLevelType | Octra libraries - v2.0.0

        EnumerationAnnotationLevelType

        Enumeration Members

        EVENT +AnnotationLevelType | Octra libraries - v2.0.0

        EnumerationAnnotationLevelType

        Enumeration Members

        EVENT ITEM SEGMENT -

        Enumeration Members

        EVENT

        EVENT

        ITEM

        ITEM

        SEGMENT

        SEGMENT

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        +

        Enumeration Members

        EVENT

        EVENT

        ITEM

        ITEM

        SEGMENT

        SEGMENT

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        diff --git a/enums/_octra_media.PlayBackStatus.html b/enums/_octra_media.PlayBackStatus.html index f0ac1671d..8ff5ac773 100644 --- a/enums/_octra_media.PlayBackStatus.html +++ b/enums/_octra_media.PlayBackStatus.html @@ -1,8 +1,8 @@ -PlayBackStatus | Octra libraries - v2.0.0

        EnumerationPlayBackStatusConst

        Enumeration Members

        ENDED +PlayBackStatus | Octra libraries - v2.0.0

        EnumerationPlayBackStatusConst

        Enumeration Members

        ENDED INITIALIZED PAUSED PLAYING PREPARE STARTED STOPPED -

        Enumeration Members

        ENDED

        ENDED

        INITIALIZED

        INITIALIZED

        PAUSED

        PAUSED

        PLAYING

        PLAYING

        PREPARE

        PREPARE

        STARTED

        STARTED

        STOPPED

        STOPPED

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        +

        Enumeration Members

        ENDED

        ENDED

        INITIALIZED

        INITIALIZED

        PAUSED

        PAUSED

        PLAYING

        PLAYING

        PREPARE

        PREPARE

        STARTED

        STARTED

        STOPPED

        STOPPED

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        diff --git a/enums/_octra_web_media.TsWorkerStatus.html b/enums/_octra_web_media.TsWorkerStatus.html index b9707d206..707463cb6 100644 --- a/enums/_octra_web_media.TsWorkerStatus.html +++ b/enums/_octra_web_media.TsWorkerStatus.html @@ -1,6 +1,6 @@ -TsWorkerStatus | Octra libraries - v2.0.0

        EnumerationTsWorkerStatus

        Enumeration Members

        FAILED +TsWorkerStatus | Octra libraries - v2.0.0

        EnumerationTsWorkerStatus

        Enumeration Members

        FAILED FINISHED INITIALIZED RUNNING STOPPED -

        Enumeration Members

        FAILED

        FAILED

        FINISHED

        FINISHED

        INITIALIZED

        INITIALIZED

        RUNNING

        RUNNING

        STOPPED

        STOPPED

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        +

        Enumeration Members

        FAILED

        FAILED

        FINISHED

        FINISHED

        INITIALIZED

        INITIALIZED

        RUNNING

        RUNNING

        STOPPED

        STOPPED

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        diff --git a/functions/_octra_annotation.addSegment.html b/functions/_octra_annotation.addSegment.html index 31d7b8016..e7205b86b 100644 --- a/functions/_octra_annotation.addSegment.html +++ b/functions/_octra_annotation.addSegment.html @@ -1,2 +1,2 @@ addSegment | Octra libraries - v2.0.0

        FunctionaddSegment

        Settings

        Member Visibility
        +

        Parameters

        Returns {
            entries: OctraAnnotationSegment[];
            itemIDCounter: number;
        }

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.betweenWhichSegment.html b/functions/_octra_annotation.betweenWhichSegment.html index d0fa6cafa..dfe6983de 100644 --- a/functions/_octra_annotation.betweenWhichSegment.html +++ b/functions/_octra_annotation.betweenWhichSegment.html @@ -1 +1 @@ -betweenWhichSegment | Octra libraries - v2.0.0

        FunctionbetweenWhichSegment

        Settings

        Member Visibility
        +betweenWhichSegment | Octra libraries - v2.0.0

        FunctionbetweenWhichSegment

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.cleanup.html b/functions/_octra_annotation.cleanup.html index 396d8ac57..4f58a1fef 100644 --- a/functions/_octra_annotation.cleanup.html +++ b/functions/_octra_annotation.cleanup.html @@ -1 +1 @@ -cleanup | Octra libraries - v2.0.0

        Functioncleanup

        Settings

        Member Visibility
        +cleanup | Octra libraries - v2.0.0

        Functioncleanup

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.combineSegments.html b/functions/_octra_annotation.combineSegments.html index 8fe22de30..1b9316501 100644 --- a/functions/_octra_annotation.combineSegments.html +++ b/functions/_octra_annotation.combineSegments.html @@ -1 +1 @@ -combineSegments | Octra libraries - v2.0.0

        FunctioncombineSegments

        • combineSegments(entries, segmentIndexStart, segmentIndexEnd, breakMarker): void

        • Parameters

          Returns void

        Settings

        Member Visibility
        +combineSegments | Octra libraries - v2.0.0

        FunctioncombineSegments

        • combineSegments(entries, segmentIndexStart, segmentIndexEnd, breakMarker): void

        • Parameters

          Returns void

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.contains.html b/functions/_octra_annotation.contains.html index dcdc457a9..9b0b52078 100644 --- a/functions/_octra_annotation.contains.html +++ b/functions/_octra_annotation.contains.html @@ -1,4 +1,4 @@ contains | Octra libraries - v2.0.0

        Functioncontains

        • contains(haystack, needle): boolean

        • checks if a given string contains a given substring

          Parameters

          • haystack: string

            string that should be searched

          • needle: string

            substring that is searched for

            -

          Returns boolean

        Settings

        Member Visibility
        +

        Returns boolean

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.convertFromSupportedConverters.html b/functions/_octra_annotation.convertFromSupportedConverters.html index 5573582c5..361bf1479 100644 --- a/functions/_octra_annotation.convertFromSupportedConverters.html +++ b/functions/_octra_annotation.convertFromSupportedConverters.html @@ -1 +1 @@ -convertFromSupportedConverters | Octra libraries - v2.0.0

        FunctionconvertFromSupportedConverters

        Settings

        Member Visibility
        +convertFromSupportedConverters | Octra libraries - v2.0.0

        FunctionconvertFromSupportedConverters

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.convertOSegmentsToSegments.html b/functions/_octra_annotation.convertOSegmentsToSegments.html index bde563be4..ad714b795 100644 --- a/functions/_octra_annotation.convertOSegmentsToSegments.html +++ b/functions/_octra_annotation.convertOSegmentsToSegments.html @@ -1 +1 @@ -convertOSegmentsToSegments | Octra libraries - v2.0.0

        FunctionconvertOSegmentsToSegments

        Settings

        Member Visibility
        +convertOSegmentsToSegments | Octra libraries - v2.0.0

        FunctionconvertOSegmentsToSegments

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.convertSegmentsToOSegments.html b/functions/_octra_annotation.convertSegmentsToOSegments.html index 92329f6a4..763e17991 100644 --- a/functions/_octra_annotation.convertSegmentsToOSegments.html +++ b/functions/_octra_annotation.convertSegmentsToOSegments.html @@ -1,2 +1,2 @@ convertSegmentsToOSegments | Octra libraries - v2.0.0

        FunctionconvertSegmentsToOSegments

        Settings

        Member Visibility
        +

        Parameters

        Returns OSegment[]

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.getSegmentBySamplePosition.html b/functions/_octra_annotation.getSegmentBySamplePosition.html index bdf295336..120920cc7 100644 --- a/functions/_octra_annotation.getSegmentBySamplePosition.html +++ b/functions/_octra_annotation.getSegmentBySamplePosition.html @@ -1,2 +1,2 @@ getSegmentBySamplePosition | Octra libraries - v2.0.0

        FunctiongetSegmentBySamplePosition

        Settings

        Member Visibility
        +

        Parameters

        Returns number

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.getSegmentsOfRange.html b/functions/_octra_annotation.getSegmentsOfRange.html index becf02aea..dd0d22cea 100644 --- a/functions/_octra_annotation.getSegmentsOfRange.html +++ b/functions/_octra_annotation.getSegmentsOfRange.html @@ -1 +1 @@ -getSegmentsOfRange | Octra libraries - v2.0.0

        FunctiongetSegmentsOfRange

        • getSegmentsOfRange(entries, startSamples, endSamples): {
              endIndex: number;
              startIndex: number;
          }

        • Parameters

          Returns {
              endIndex: number;
              startIndex: number;
          }

          • endIndex: number
          • startIndex: number

        Settings

        Member Visibility
        +getSegmentsOfRange | Octra libraries - v2.0.0

        FunctiongetSegmentsOfRange

        • getSegmentsOfRange(entries, startSamples, endSamples): {
              endIndex: number;
              startIndex: number;
          }

        • Parameters

          Returns {
              endIndex: number;
              startIndex: number;
          }

          • endIndex: number
          • startIndex: number

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.getStartTimeBySegmentID.html b/functions/_octra_annotation.getStartTimeBySegmentID.html index b1761ab7a..a59f69785 100644 --- a/functions/_octra_annotation.getStartTimeBySegmentID.html +++ b/functions/_octra_annotation.getStartTimeBySegmentID.html @@ -1 +1 @@ -getStartTimeBySegmentID | Octra libraries - v2.0.0

        FunctiongetStartTimeBySegmentID

        Settings

        Member Visibility
        +getStartTimeBySegmentID | Octra libraries - v2.0.0

        FunctiongetStartTimeBySegmentID

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.removeBySamples.html b/functions/_octra_annotation.removeBySamples.html index 51c5b1f54..d231e2d1c 100644 --- a/functions/_octra_annotation.removeBySamples.html +++ b/functions/_octra_annotation.removeBySamples.html @@ -1,2 +1,2 @@ removeBySamples | Octra libraries - v2.0.0

        FunctionremoveBySamples

        Settings

        Member Visibility
        +

        Parameters

        Returns OctraAnnotationSegment<ASRContext>[]

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.removeSegmentByIndex.html b/functions/_octra_annotation.removeSegmentByIndex.html index 484486aca..505ef1b90 100644 --- a/functions/_octra_annotation.removeSegmentByIndex.html +++ b/functions/_octra_annotation.removeSegmentByIndex.html @@ -1,4 +1,4 @@ removeSegmentByIndex | Octra libraries - v2.0.0

        FunctionremoveSegmentByIndex

        Settings

        Member Visibility
        +
      • mergeTranscripts: boolean = true

        • Returns OctraAnnotationSegment<ASRContext>[]

        Settings

        Member Visibility
        diff --git a/functions/_octra_annotation.sort.html b/functions/_octra_annotation.sort.html index 813872544..179b72500 100644 --- a/functions/_octra_annotation.sort.html +++ b/functions/_octra_annotation.sort.html @@ -1,2 +1,2 @@ sort | Octra libraries - v2.0.0

        Functionsort

        Settings

        Member Visibility
        +

        Parameters

        Returns OctraAnnotationSegment<ASRContext>[]

        Settings

        Member Visibility
        diff --git a/functions/_octra_ngx_utilities.downloadFile.html b/functions/_octra_ngx_utilities.downloadFile.html index 12fc73915..c1e9fb54e 100644 --- a/functions/_octra_ngx_utilities.downloadFile.html +++ b/functions/_octra_ngx_utilities.downloadFile.html @@ -2,4 +2,4 @@

        Type Parameters

        Parameters

        Returns Subject<{
            progress: number;
            result?: T;
        }>

        Settings

        Member Visibility
        +

        Returns Subject<{
            progress: number;
            result?: T;
        }>

        Settings

        Member Visibility
        diff --git a/functions/_octra_ngx_utilities.navigateTo.html b/functions/_octra_ngx_utilities.navigateTo.html index d7e1545f9..59031ba42 100644 --- a/functions/_octra_ngx_utilities.navigateTo.html +++ b/functions/_octra_ngx_utilities.navigateTo.html @@ -1 +1 @@ -navigateTo | Octra libraries - v2.0.0

        FunctionnavigateTo

        • navigateTo(router, commands, navigationExtras?): Promise<boolean>

        • Parameters

          • router: Router
          • commands: any[]
          • OptionalnavigationExtras: NavigationExtras

          Returns Promise<boolean>

        Settings

        Member Visibility
        +navigateTo | Octra libraries - v2.0.0

        FunctionnavigateTo

        • navigateTo(router, commands, navigationExtras?): Promise<boolean>

        • Parameters

          • router: Router
          • commands: any[]
          • OptionalnavigationExtras: NavigationExtras

          Returns Promise<boolean>

        Settings

        Member Visibility
        diff --git a/functions/_octra_ngx_utilities.uniqueHTTPRequest.html b/functions/_octra_ngx_utilities.uniqueHTTPRequest.html index 182dca9d8..a43a915fa 100644 --- a/functions/_octra_ngx_utilities.uniqueHTTPRequest.html +++ b/functions/_octra_ngx_utilities.uniqueHTTPRequest.html @@ -1 +1 @@ -uniqueHTTPRequest | Octra libraries - v2.0.0

        FunctionuniqueHTTPRequest

        • uniqueHTTPRequest(http, post?, requestOptions, url, body): Observable<any>

        • Parameters

          • http: HttpClient
          • post: boolean = false
          • requestOptions: any
          • url: string
          • body: any

          Returns Observable<any>

        Settings

        Member Visibility
        +uniqueHTTPRequest | Octra libraries - v2.0.0

        FunctionuniqueHTTPRequest

        • uniqueHTTPRequest(http, post?, requestOptions, url, body): Observable<any>

        • Parameters

          • http: HttpClient
          • post: boolean = false
          • requestOptions: any
          • url: string
          • body: any

          Returns Observable<any>

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.base64ToArrayBuffer.html b/functions/_octra_utilities.base64ToArrayBuffer.html index cd9c09ed8..bfc18b9b9 100644 --- a/functions/_octra_utilities.base64ToArrayBuffer.html +++ b/functions/_octra_utilities.base64ToArrayBuffer.html @@ -1,2 +1,2 @@ base64ToArrayBuffer | Octra libraries - v2.0.0

        Functionbase64ToArrayBuffer

        • base64ToArrayBuffer(base64String): any

        • converts base64 to ArrayBuffer

          -

          Parameters

          • base64String: string

          Returns any

        Settings

        Member Visibility
        +

        Parameters

        Returns any

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.contains.html b/functions/_octra_utilities.contains.html index a6f39210a..390903b0f 100644 --- a/functions/_octra_utilities.contains.html +++ b/functions/_octra_utilities.contains.html @@ -1,4 +1,4 @@ contains | Octra libraries - v2.0.0

        Functioncontains

        • contains(haystack, needle): boolean

        • checks if a given string contains a given substring

          Parameters

          • haystack: string

            string that should be searched

          • needle: string

            substring that is searched for

            -

          Returns boolean

        Settings

        Member Visibility
        +

        Returns boolean

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.convertDurationToUnix.html b/functions/_octra_utilities.convertDurationToUnix.html index 792a1302d..deafc6b8b 100644 --- a/functions/_octra_utilities.convertDurationToUnix.html +++ b/functions/_octra_utilities.convertDurationToUnix.html @@ -1,3 +1,3 @@ convertDurationToUnix | Octra libraries - v2.0.0

        FunctionconvertDurationToUnix

        • convertDurationToUnix(duration): undefined | number

        • converts time declaration from string to unix time (miliseconds).

          Parameters

          • duration: string

            e.g. 2d, 1h, 5m

            -

          Returns undefined | number

        Settings

        Member Visibility
        +

        Returns undefined | number

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.equalProperties.html b/functions/_octra_utilities.equalProperties.html index add995d32..cf302c480 100644 --- a/functions/_octra_utilities.equalProperties.html +++ b/functions/_octra_utilities.equalProperties.html @@ -1 +1 @@ -equalProperties | Octra libraries - v2.0.0

        FunctionequalProperties

        • equalProperties(elem, elem2): boolean

        • Parameters

          • elem: any
          • elem2: any

          Returns boolean

        Settings

        Member Visibility
        +equalProperties | Octra libraries - v2.0.0

        FunctionequalProperties

        • equalProperties(elem, elem2): boolean

        • Parameters

          • elem: any
          • elem2: any

          Returns boolean

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.escapeHtml.html b/functions/_octra_utilities.escapeHtml.html index 6b79b25e2..4fb1bf88b 100644 --- a/functions/_octra_utilities.escapeHtml.html +++ b/functions/_octra_utilities.escapeHtml.html @@ -1 +1 @@ -escapeHtml | Octra libraries - v2.0.0

        FunctionescapeHtml

        • escapeHtml(text): string

        • Parameters

          • text: string

          Returns string

        Settings

        Member Visibility
        +escapeHtml | Octra libraries - v2.0.0

        FunctionescapeHtml

        • escapeHtml(text): string

        • Parameters

          • text: string

          Returns string

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.escapeRegex.html b/functions/_octra_utilities.escapeRegex.html index c49a78510..9d164b07b 100644 --- a/functions/_octra_utilities.escapeRegex.html +++ b/functions/_octra_utilities.escapeRegex.html @@ -1 +1 @@ -escapeRegex | Octra libraries - v2.0.0

        FunctionescapeRegex

        • escapeRegex(regexStr): string

        • Parameters

          • regexStr: string

          Returns string

        Settings

        Member Visibility
        +escapeRegex | Octra libraries - v2.0.0

        FunctionescapeRegex

        • escapeRegex(regexStr): string

        • Parameters

          • regexStr: string

          Returns string

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.extractFileNameFromURL.html b/functions/_octra_utilities.extractFileNameFromURL.html index b0989b7ab..ee323eb9e 100644 --- a/functions/_octra_utilities.extractFileNameFromURL.html +++ b/functions/_octra_utilities.extractFileNameFromURL.html @@ -1,2 +1,2 @@ extractFileNameFromURL | Octra libraries - v2.0.0

        FunctionextractFileNameFromURL

        • extractFileNameFromURL(url): {
              extension: string;
              name: string;
          }

        • returns the file name and extension part of an URL. Extension contains the dot.

          -

          Parameters

          • url: string

          Returns {
              extension: string;
              name: string;
          }

          • extension: string
          • name: string

        Settings

        Member Visibility
        +

        Parameters

        Returns {
            extension: string;
            name: string;
        }

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.flatten.html b/functions/_octra_utilities.flatten.html index be4fcd377..c364e8d12 100644 --- a/functions/_octra_utilities.flatten.html +++ b/functions/_octra_utilities.flatten.html @@ -1 +1 @@ -flatten | Octra libraries - v2.0.0

        Functionflatten

        • flatten(values): never[]

        • Parameters

          • values: never[]

          Returns never[]

        Settings

        Member Visibility
        +flatten | Octra libraries - v2.0.0

        Functionflatten

        • flatten(values): never[]

        • Parameters

          • values: never[]

          Returns never[]

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.getBaseHrefURL.html b/functions/_octra_utilities.getBaseHrefURL.html index da4a3cd23..e86b5f0b4 100644 --- a/functions/_octra_utilities.getBaseHrefURL.html +++ b/functions/_octra_utilities.getBaseHrefURL.html @@ -1,2 +1,2 @@ getBaseHrefURL | Octra libraries - v2.0.0

        FunctiongetBaseHrefURL

        • getBaseHrefURL(): string

        • returns the base URL path to the application

          -

          Returns string

        Settings

        Member Visibility
        +

        Returns string

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.getFileSize.html b/functions/_octra_utilities.getFileSize.html index e8a30c40e..9f1cfb07c 100644 --- a/functions/_octra_utilities.getFileSize.html +++ b/functions/_octra_utilities.getFileSize.html @@ -1 +1 @@ -getFileSize | Octra libraries - v2.0.0

        FunctiongetFileSize

        Settings

        Member Visibility
        +getFileSize | Octra libraries - v2.0.0

        FunctiongetFileSize

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.getProperties.html b/functions/_octra_utilities.getProperties.html index bba12ad37..46b602196 100644 --- a/functions/_octra_utilities.getProperties.html +++ b/functions/_octra_utilities.getProperties.html @@ -1 +1 @@ -getProperties | Octra libraries - v2.0.0

        FunctiongetProperties

        • getProperties(obj): [string, any][]

        • Parameters

          • obj: any

          Returns [string, any][]

        Settings

        Member Visibility
        +getProperties | Octra libraries - v2.0.0

        FunctiongetProperties

        • getProperties(obj): [string, any][]

        • Parameters

          • obj: any

          Returns [string, any][]

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.getTranscriptFromIO.html b/functions/_octra_utilities.getTranscriptFromIO.html index 71b690a3c..c4d092988 100644 --- a/functions/_octra_utilities.getTranscriptFromIO.html +++ b/functions/_octra_utilities.getTranscriptFromIO.html @@ -1 +1 @@ -getTranscriptFromIO | Octra libraries - v2.0.0

        FunctiongetTranscriptFromIO

        • getTranscriptFromIO(io): any | undefined

        • Parameters

          • io: any[]

          Returns any | undefined

        Settings

        Member Visibility
        +getTranscriptFromIO | Octra libraries - v2.0.0

        FunctiongetTranscriptFromIO

        • getTranscriptFromIO(io): any | undefined

        • Parameters

          • io: any[]

          Returns any | undefined

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.hasProperty.html b/functions/_octra_utilities.hasProperty.html index 592c1f82c..f564ccc4d 100644 --- a/functions/_octra_utilities.hasProperty.html +++ b/functions/_octra_utilities.hasProperty.html @@ -1 +1 @@ -hasProperty | Octra libraries - v2.0.0

        FunctionhasProperty

        • hasProperty(obj, attribute): boolean

        • Parameters

          • obj: unknown
          • attribute: string

          Returns boolean

        Settings

        Member Visibility
        +hasProperty | Octra libraries - v2.0.0

        FunctionhasProperty

        • hasProperty(obj, attribute): boolean

        • Parameters

          • obj: unknown
          • attribute: string

          Returns boolean

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.hasPropertyTree.html b/functions/_octra_utilities.hasPropertyTree.html index 6bfd20bb8..602a77a94 100644 --- a/functions/_octra_utilities.hasPropertyTree.html +++ b/functions/_octra_utilities.hasPropertyTree.html @@ -1,2 +1,2 @@ hasPropertyTree | Octra libraries - v2.0.0

        FunctionhasPropertyTree

        • hasPropertyTree(obj, treeString): boolean

        • checks if a object has a value at given property path

          -

          Parameters

          • obj: any
          • treeString: string

          Returns boolean

        Settings

        Member Visibility
        +

        Parameters

        Returns boolean

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.insertString.html b/functions/_octra_utilities.insertString.html index 72e27bbfd..0e0051e02 100644 --- a/functions/_octra_utilities.insertString.html +++ b/functions/_octra_utilities.insertString.html @@ -1 +1 @@ -insertString | Octra libraries - v2.0.0

        FunctioninsertString

        • insertString(input, pos, insertion): string

        • Parameters

          • input: string
          • pos: number
          • insertion: string

          Returns string

        Settings

        Member Visibility
        +insertString | Octra libraries - v2.0.0

        FunctioninsertString

        • insertString(input, pos, insertion): string

        • Parameters

          • input: string
          • pos: number
          • insertion: string

          Returns string

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.isEmpty.html b/functions/_octra_utilities.isEmpty.html index 9c5041973..1036bbbdb 100644 --- a/functions/_octra_utilities.isEmpty.html +++ b/functions/_octra_utilities.isEmpty.html @@ -1 +1 @@ -isEmpty | Octra libraries - v2.0.0

        FunctionisEmpty

        • isEmpty(obj): boolean

        • Parameters

          • obj: unknown

          Returns boolean

        Settings

        Member Visibility
        +isEmpty | Octra libraries - v2.0.0

        FunctionisEmpty

        • isEmpty(obj): boolean

        • Parameters

          • obj: unknown

          Returns boolean

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.isFunction.html b/functions/_octra_utilities.isFunction.html index f321c06bd..b70e6337b 100644 --- a/functions/_octra_utilities.isFunction.html +++ b/functions/_octra_utilities.isFunction.html @@ -1,2 +1,2 @@ isFunction | Octra libraries - v2.0.0

        FunctionisFunction

        • isFunction(value): boolean

        • checks if value is a function

          -

          Parameters

          • value: any

          Returns boolean

        Settings

        Member Visibility
        +

        Parameters

        Returns boolean

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.isNumber.html b/functions/_octra_utilities.isNumber.html index e06439d99..8e668f499 100644 --- a/functions/_octra_utilities.isNumber.html +++ b/functions/_octra_utilities.isNumber.html @@ -1 +1 @@ -isNumber | Octra libraries - v2.0.0

        FunctionisNumber

        • isNumber(str): boolean

        • Parameters

          • str: string

          Returns boolean

        Settings

        Member Visibility
        +isNumber | Octra libraries - v2.0.0

        FunctionisNumber

        • isNumber(str): boolean

        • Parameters

          • str: string

          Returns boolean

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.joinURL.html b/functions/_octra_utilities.joinURL.html index e4feadbed..67f6ac41f 100644 --- a/functions/_octra_utilities.joinURL.html +++ b/functions/_octra_utilities.joinURL.html @@ -1,2 +1,2 @@ joinURL | Octra libraries - v2.0.0

        FunctionjoinURL

        • joinURL(...args): string

        • this method is like path.join() just for URL

          -

          Parameters

          • Rest...args: string[]

          Returns string

        Settings

        Member Visibility
        +

        Parameters

        Returns string

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.last.html b/functions/_octra_utilities.last.html index e48ddc749..4b4eb0e5b 100644 --- a/functions/_octra_utilities.last.html +++ b/functions/_octra_utilities.last.html @@ -1,3 +1,3 @@ last | Octra libraries - v2.0.0

        Functionlast

        • last<T>(array): undefined | T

        • returns the last element of an array.

          Type Parameters

          • T

          Parameters

          • array: undefined | T[]

          Returns undefined | T

          undefined if not found

          -

        Settings

        Member Visibility
        +

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.mapFnOnObject.html b/functions/_octra_utilities.mapFnOnObject.html index 8b6045f30..a44b0b2bd 100644 --- a/functions/_octra_utilities.mapFnOnObject.html +++ b/functions/_octra_utilities.mapFnOnObject.html @@ -1,2 +1,2 @@ mapFnOnObject | Octra libraries - v2.0.0

        FunctionmapFnOnObject

        • mapFnOnObject(obj, fn): Record<string, any>

        • maps a function fn on all property values.

          -

          Parameters

          • obj: Record<string, any>
          • fn: ((key: string, value: any) => any)
              • (key, value): any

              • Parameters

                • key: string
                • value: any

                Returns any

          Returns Record<string, any>

        Settings

        Member Visibility
        +

        Parameters

        Returns Record<string, any>

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.popupCenter.html b/functions/_octra_utilities.popupCenter.html index 9ad136778..d8385be45 100644 --- a/functions/_octra_utilities.popupCenter.html +++ b/functions/_octra_utilities.popupCenter.html @@ -1 +1 @@ -popupCenter | Octra libraries - v2.0.0

        FunctionpopupCenter

        • popupCenter(url, title, w, h): void

        • Parameters

          • url: string
          • title: string
          • w: number
          • h: number

          Returns void

        Settings

        Member Visibility
        +popupCenter | Octra libraries - v2.0.0

        FunctionpopupCenter

        • popupCenter(url, title, w, h): void

        • Parameters

          • url: string
          • title: string
          • w: number
          • h: number

          Returns void

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.range.html b/functions/_octra_utilities.range.html index 246abe854..4ffebc290 100644 --- a/functions/_octra_utilities.range.html +++ b/functions/_octra_utilities.range.html @@ -1,2 +1,2 @@ range | Octra libraries - v2.0.0

        Functionrange

        creates a range with start and end number.

        -
        • range(start, end): number[]

        • Parameters

          • start: number
          • end: number

          Returns number[]

        Settings

        Member Visibility
        +

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.removeEmptyProperties.html b/functions/_octra_utilities.removeEmptyProperties.html index 0aa95feb6..320612055 100644 --- a/functions/_octra_utilities.removeEmptyProperties.html +++ b/functions/_octra_utilities.removeEmptyProperties.html @@ -1,2 +1,2 @@ removeEmptyProperties | Octra libraries - v2.0.0

        FunctionremoveEmptyProperties

        • removeEmptyProperties<T>(obj, options?): T

        • removes all empty values from an given object.

          -

          Type Parameters

          • T

          Parameters

          • obj: T
          • options: {
                removeEmptyStrings?: boolean;
                removeNull?: boolean;
                removeUndefined?: boolean;
            } = ...
            • OptionalremoveEmptyStrings?: boolean
            • OptionalremoveNull?: boolean
            • OptionalremoveUndefined?: boolean

          Returns T

        Settings

        Member Visibility
        +

        Type Parameters

        Parameters

        Returns T

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.unEscapeHtml.html b/functions/_octra_utilities.unEscapeHtml.html index ad990d3d3..ac8b52744 100644 --- a/functions/_octra_utilities.unEscapeHtml.html +++ b/functions/_octra_utilities.unEscapeHtml.html @@ -1 +1 @@ -unEscapeHtml | Octra libraries - v2.0.0

        FunctionunEscapeHtml

        • unEscapeHtml(text): string

        • Parameters

          • text: string

          Returns string

        Settings

        Member Visibility
        +unEscapeHtml | Octra libraries - v2.0.0

        FunctionunEscapeHtml

        • unEscapeHtml(text): string

        • Parameters

          • text: string

          Returns string

        Settings

        Member Visibility
        diff --git a/functions/_octra_utilities.waitTillResultRetrieved.html b/functions/_octra_utilities.waitTillResultRetrieved.html index 942423340..062f45c3a 100644 --- a/functions/_octra_utilities.waitTillResultRetrieved.html +++ b/functions/_octra_utilities.waitTillResultRetrieved.html @@ -1 +1 @@ -waitTillResultRetrieved | Octra libraries - v2.0.0

        FunctionwaitTillResultRetrieved

        • waitTillResultRetrieved<A1, A2, T>(actions, success, failure): Promise<T>

        • Type Parameters

          • A1 extends {
                subscribe: any;
            }
          • A2 extends {
                type: string;
            }
          • T

          Parameters

          • actions: A1
          • success: A2
          • failure: A2

          Returns Promise<T>

        Settings

        Member Visibility
        +waitTillResultRetrieved | Octra libraries - v2.0.0

        FunctionwaitTillResultRetrieved

        • waitTillResultRetrieved<A1, A2, T>(actions, success, failure): Promise<T>

        • Type Parameters

          • A1 extends {
                subscribe: any;
            }
          • A2 extends {
                type: string;
            }
          • T

          Parameters

          • actions: A1
          • success: A2
          • failure: A2

          Returns Promise<T>

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.downloadFile.html b/functions/_octra_web_media.downloadFile.html index 20fe1b548..e89339d90 100644 --- a/functions/_octra_web_media.downloadFile.html +++ b/functions/_octra_web_media.downloadFile.html @@ -1 +1 @@ -downloadFile | Octra libraries - v2.0.0

        FunctiondownloadFile

        • downloadFile(url, type?): Promise<File>

        • Parameters

          • url: string
          • type: XMLHttpRequestResponseType = 'text'

          Returns Promise<File>

        Settings

        Member Visibility
        +downloadFile | Octra libraries - v2.0.0

        FunctiondownloadFile

        • downloadFile(url, type?): Promise<File>

        • Parameters

          • url: string
          • type: XMLHttpRequestResponseType = 'text'

          Returns Promise<File>

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.fileListToArray.html b/functions/_octra_web_media.fileListToArray.html index 27085c26e..38930aaa7 100644 --- a/functions/_octra_web_media.fileListToArray.html +++ b/functions/_octra_web_media.fileListToArray.html @@ -1 +1 @@ -fileListToArray | Octra libraries - v2.0.0

        FunctionfileListToArray

        • fileListToArray(fileList): File[]

        • Parameters

          • fileList: FileList

          Returns File[]

        Settings

        Member Visibility
        +fileListToArray | Octra libraries - v2.0.0

        FunctionfileListToArray

        • fileListToArray(fileList): File[]

        • Parameters

          • fileList: FileList

          Returns File[]

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.findElements.html b/functions/_octra_web_media.findElements.html index 65148da37..9f8720649 100644 --- a/functions/_octra_web_media.findElements.html +++ b/functions/_octra_web_media.findElements.html @@ -1 +1 @@ -findElements | Octra libraries - v2.0.0

        FunctionfindElements

        • findElements(parent, selector): HTMLElement[]

        • Parameters

          • parent: HTMLElement
          • selector: string

          Returns HTMLElement[]

        Settings

        Member Visibility
        +findElements | Octra libraries - v2.0.0

        FunctionfindElements

        • findElements(parent, selector): HTMLElement[]

        • Parameters

          • parent: HTMLElement
          • selector: string

          Returns HTMLElement[]

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.getAttr.html b/functions/_octra_web_media.getAttr.html index 2e14100ac..64d52aae6 100644 --- a/functions/_octra_web_media.getAttr.html +++ b/functions/_octra_web_media.getAttr.html @@ -1 +1 @@ -getAttr | Octra libraries - v2.0.0

        FunctiongetAttr

        • getAttr(elem, attribute): undefined | string

        • Parameters

          • elem: HTMLElement
          • attribute: string

          Returns undefined | string

        Settings

        Member Visibility
        +getAttr | Octra libraries - v2.0.0

        FunctiongetAttr

        • getAttr(elem, attribute): undefined | string

        • Parameters

          • elem: HTMLElement
          • attribute: string

          Returns undefined | string

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.getAudioInfo.html b/functions/_octra_web_media.getAudioInfo.html index 7025be50b..ced3175c3 100644 --- a/functions/_octra_web_media.getAudioInfo.html +++ b/functions/_octra_web_media.getAudioInfo.html @@ -1 +1 @@ -getAudioInfo | Octra libraries - v2.0.0

        FunctiongetAudioInfo

        Settings

        Member Visibility
        +getAudioInfo | Octra libraries - v2.0.0

        FunctiongetAudioInfo

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.getBaseHrefURL.html b/functions/_octra_web_media.getBaseHrefURL.html index a25441b68..d1c84f849 100644 --- a/functions/_octra_web_media.getBaseHrefURL.html +++ b/functions/_octra_web_media.getBaseHrefURL.html @@ -1,2 +1,2 @@ getBaseHrefURL | Octra libraries - v2.0.0

        FunctiongetBaseHrefURL

        • getBaseHrefURL(): string

        • returns the base URL path to the application

          -

          Returns string

        Settings

        Member Visibility
        +

        Returns string

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.getFileContent.html b/functions/_octra_web_media.getFileContent.html index f2dd44c81..1a99078df 100644 --- a/functions/_octra_web_media.getFileContent.html +++ b/functions/_octra_web_media.getFileContent.html @@ -1 +1 @@ -getFileContent | Octra libraries - v2.0.0

        FunctiongetFileContent

        • getFileContent(file, encoding?): Promise<string>

        • Parameters

          • file: File
          • Optionalencoding: string

          Returns Promise<string>

        Settings

        Member Visibility
        +getFileContent | Octra libraries - v2.0.0

        FunctiongetFileContent

        • getFileContent(file, encoding?): Promise<string>

        • Parameters

          • file: File
          • Optionalencoding: string

          Returns Promise<string>

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.popupCenter.html b/functions/_octra_web_media.popupCenter.html index 4d28d03a0..6541bbc90 100644 --- a/functions/_octra_web_media.popupCenter.html +++ b/functions/_octra_web_media.popupCenter.html @@ -1 +1 @@ -popupCenter | Octra libraries - v2.0.0

        FunctionpopupCenter

        • popupCenter(url, title, w, h): void

        • Parameters

          • url: string
          • title: string
          • w: number
          • h: number

          Returns void

        Settings

        Member Visibility
        +popupCenter | Octra libraries - v2.0.0

        FunctionpopupCenter

        • popupCenter(url, title, w, h): void

        • Parameters

          • url: string
          • title: string
          • w: number
          • h: number

          Returns void

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.readFile.html b/functions/_octra_web_media.readFile.html index a6bc4f05c..35410f307 100644 --- a/functions/_octra_web_media.readFile.html +++ b/functions/_octra_web_media.readFile.html @@ -1 +1 @@ -readFile | Octra libraries - v2.0.0

        FunctionreadFile

        • readFile<T>(file, method, encoding?): Observable<ReadFileEvent<T>>

        • Type Parameters

          • T

          Parameters

          • file: File
          • method: "text" | "binary" | "arraybuffer"
          • Optionalencoding: string

          Returns Observable<ReadFileEvent<T>>

        Settings

        Member Visibility
        +readFile | Octra libraries - v2.0.0

        FunctionreadFile

        • readFile<T>(file, method, encoding?): Observable<ReadFileEvent<T>>

        • Type Parameters

          • T

          Parameters

          • file: File
          • method: "text" | "binary" | "arraybuffer"
          • Optionalencoding: string

          Returns Observable<ReadFileEvent<T>>

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.readFileContents.html b/functions/_octra_web_media.readFileContents.html index 83984d2d4..c654535fd 100644 --- a/functions/_octra_web_media.readFileContents.html +++ b/functions/_octra_web_media.readFileContents.html @@ -1 +1 @@ -readFileContents | Octra libraries - v2.0.0

        FunctionreadFileContents

        • readFileContents<T>(file, method, encoding?): Promise<T>

        • Type Parameters

          • T

          Parameters

          • file: File
          • method: "text" | "binary" | "arraybuffer"
          • Optionalencoding: string

          Returns Promise<T>

        Settings

        Member Visibility
        +readFileContents | Octra libraries - v2.0.0

        FunctionreadFileContents

        • readFileContents<T>(file, method, encoding?): Promise<T>

        • Type Parameters

          • T

          Parameters

          • file: File
          • method: "text" | "binary" | "arraybuffer"
          • Optionalencoding: string

          Returns Promise<T>

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.renameFile.html b/functions/_octra_web_media.renameFile.html index 560bc14b8..392504496 100644 --- a/functions/_octra_web_media.renameFile.html +++ b/functions/_octra_web_media.renameFile.html @@ -1 +1 @@ -renameFile | Octra libraries - v2.0.0

        FunctionrenameFile

        • renameFile(file, newName, attributes): Promise<File>

        • Parameters

          • file: File
          • newName: string
          • attributes: any

          Returns Promise<File>

        Settings

        Member Visibility
        +renameFile | Octra libraries - v2.0.0

        FunctionrenameFile

        • renameFile(file, newName, attributes): Promise<File>

        • Parameters

          • file: File
          • newName: string
          • attributes: any

          Returns Promise<File>

        Settings

        Member Visibility
        diff --git a/functions/_octra_web_media.setStyle.html b/functions/_octra_web_media.setStyle.html index 0757cc5a1..902de9753 100644 --- a/functions/_octra_web_media.setStyle.html +++ b/functions/_octra_web_media.setStyle.html @@ -1 +1 @@ -setStyle | Octra libraries - v2.0.0

        FunctionsetStyle

        • setStyle(elem, styleObj): void

        • Parameters

          • elem: HTMLElement
          • styleObj: any

          Returns void

        Settings

        Member Visibility
        +setStyle | Octra libraries - v2.0.0

        FunctionsetStyle

        • setStyle(elem, styleObj): void

        • Parameters

          • elem: HTMLElement
          • styleObj: any

          Returns void

        Settings

        Member Visibility
        diff --git a/interfaces/_octra_annotation.ASRContext.html b/interfaces/_octra_annotation.ASRContext.html index 5eef23db3..3bd56df37 100644 --- a/interfaces/_octra_annotation.ASRContext.html +++ b/interfaces/_octra_annotation.ASRContext.html @@ -1,2 +1,2 @@ -ASRContext | Octra libraries - v2.0.0

        InterfaceASRContext

        interface ASRContext {
            asr?: {
                isBlockedBy?: ASRQueueItemType;
                progressInfo?: {
                    progress: number;
                    statusLabel: string;
                };
            };
        }

        Properties

        asr? -

        Properties

        Optionalasr

        asr?: {
            isBlockedBy?: ASRQueueItemType;
            progressInfo?: {
                progress: number;
                statusLabel: string;
            };
        }

        Settings

        Member Visibility

        On This Page

        Properties
        +ASRContext | Octra libraries - v2.0.0

        InterfaceASRContext

        interface ASRContext {
            asr?: {
                isBlockedBy?: ASRQueueItemType;
                progressInfo?: {
                    progress: number;
                    statusLabel: string;
                };
            };
        }

        Properties

        asr? +

        Properties

        Optionalasr

        asr?: {
            isBlockedBy?: ASRQueueItemType;
            progressInfo?: {
                progress: number;
                statusLabel: string;
            };
        }

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.Bundle.html b/interfaces/_octra_annotation.Bundle.html index 1ccd06c46..8e96ea061 100644 --- a/interfaces/_octra_annotation.Bundle.html +++ b/interfaces/_octra_annotation.Bundle.html @@ -1,4 +1,4 @@ -Bundle | Octra libraries - v2.0.0

        InterfaceBundle

        interface Bundle {
            annotation: IAnnotJSON;
            mediaFile: {
                data: string;
                encoding: string;
            };
            ssffFiles: {
                data: string;
                encoding: string;
                fileExtension: string;
            }[];
        }

        Properties

        annotation +Bundle | Octra libraries - v2.0.0

        InterfaceBundle

        interface Bundle {
            annotation: IAnnotJSON;
            mediaFile: {
                data: string;
                encoding: string;
            };
            ssffFiles: {
                data: string;
                encoding: string;
                fileExtension: string;
            }[];
        }

        Properties

        annotation mediaFile ssffFiles -

        Properties

        annotation

        annotation: IAnnotJSON

        mediaFile

        mediaFile: {
            data: string;
            encoding: string;
        }

        ssffFiles

        ssffFiles: {
            data: string;
            encoding: string;
            fileExtension: string;
        }[]

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        annotation

        annotation: IAnnotJSON

        mediaFile

        mediaFile: {
            data: string;
            encoding: string;
        }

        ssffFiles

        ssffFiles: {
            data: string;
            encoding: string;
            fileExtension: string;
        }[]

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.ELAN30Object.html b/interfaces/_octra_annotation.ELAN30Object.html index fd0abe040..eec309e38 100644 --- a/interfaces/_octra_annotation.ELAN30Object.html +++ b/interfaces/_octra_annotation.ELAN30Object.html @@ -1,2 +1,2 @@ -ELAN30Object | Octra libraries - v2.0.0

        InterfaceELAN30Object

        interface ELAN30Object {
            ANNOTATION_DOCUMENT: {
                _AUTHOR: string;
                _DATE: string;
                _FORMAT?: string;
                _VERSION: string;
                _xmlns:xsi: string;
                _xsi:noNamespaceSchemaLocation: string;
                CONSTRAINT: {
                    _DESCRIPTION?: string;
                    _STEREOTYPE: string;
                }[];
                CONTROLLED_VOCABULARY?: {
                    _CV_ID: string;
                    _EXT_REF?: string;
                    CV_ENTRY_ML?: {
                        _CVE_ID: string;
                        _EXT_REF?: string;
                        CVE_VALUE: {
                            _DESCRIPTION?: string;
                            _LANG_REF: string;
                            _text: string;
                        };
                    };
                    DESCRIPTION?: {
                        _LANG_REF: string;
                        _text: string;
                    };
                };
                EXTERNAL_REF?: {
                    _EXT_REF_ID: string;
                    _TYPE: string;
                    _VALUE: string;
                };
                HEADER: {
                    _MEDIA_FILE?: string;
                    _TIME_UNITS?: "milliseconds" | "NTSC-frames" | "PAL-frames";
                    LINKED_FILE_DESCRIPTOR?: {
                        _ASSOCIATED_WITH?: string;
                        _LINK_URL: string;
                        _MIME_TYPE: string;
                        _RELATIVE_LINK_URL?: string;
                        _TIME_ORIGIN?: number;
                    };
                    MEDIA_DESCRIPTOR?: {
                        _EXTRACTED_FROM?: string;
                        _MEDIA_URL: string;
                        _MIME_TYPE: string;
                        _RELATIVE_MEDIA_URL?: string;
                        _TIME_ORIGIN?: number;
                    };
                    PROPERTY: {
                        _NAME?: string;
                        _text: string;
                    }[];
                };
                LANGUAGE?: {
                    _LANG_DEF?: string;
                    _LANG_ID: string;
                    _LANG_LABEL?: string;
                };
                LEXICON_REF?: {
                    _DATCAT_ID?: string;
                    _DATCAT_NAME?: string;
                    _LEX_REF_ID: string;
                    _LEXICON_ID: string;
                    _LEXICON_NAME: string;
                    _NAME: string;
                    _TYPE: string;
                    _URL: string;
                };
                LICENSE?: {
                    _LICENSE_URL?: string;
                };
                LINGUISTIC_TYPE: {
                    _CONSTRAINTS?: string;
                    _CONTROLLED_VOCABULARY_REF?: string;
                    _EXT_REF?: string;
                    _GRAPHIC_REFERENCES?: boolean;
                    _LEXICON_REF?: string;
                    _LINGUISTIC_TYPE_ID: string;
                    _TIME_ALIGNABLE?: string;
                };
                LOCALE?: any;
                TIER: {
                    _ANNOTATOR?: string;
                    _DEFAULT_LOCALE?: string;
                    _EXT_REF?: string;
                    _LANG_REF?: string;
                    _LINGUISTIC_TYPE_REF: string;
                    _PARENT_REF?: string;
                    _PARTICIPANT?: string;
                    _TIER_ID: string;
                    ANNOTATION: {
                        ALIGNABLE_ANNOTATION?: {
                            _ANNOTATION_ID: string;
                            _SVG_REF?: string;
                            _TIME_SLOT_REF1: string;
                            _TIME_SLOT_REF2: string;
                            ANNOTATION_VALUE: string;
                        };
                        REF_ANNOTATION?: {
                            _ANNOTATION_ID: string;
                            _ANNOTATION_REF: string;
                            _CVE_REF: string;
                            _EXT_REF?: string;
                            _LANG_REF: string;
                            _PREVIOUS_ANNOTATION?: string;
                            ANNOTATION_VALUE: string;
                        };
                    }[];
                }[];
                TIME_ORDER: {
                    TIME_SLOT?: {
                        _TIME_SLOT_ID: string;
                        _TIME_VALUE?: number;
                    }[];
                };
            };
        }

        Properties

        ANNOTATION_DOCUMENT -

        Properties

        ANNOTATION_DOCUMENT

        ANNOTATION_DOCUMENT: {
            _AUTHOR: string;
            _DATE: string;
            _FORMAT?: string;
            _VERSION: string;
            _xmlns:xsi: string;
            _xsi:noNamespaceSchemaLocation: string;
            CONSTRAINT: {
                _DESCRIPTION?: string;
                _STEREOTYPE: string;
            }[];
            CONTROLLED_VOCABULARY?: {
                _CV_ID: string;
                _EXT_REF?: string;
                CV_ENTRY_ML?: {
                    _CVE_ID: string;
                    _EXT_REF?: string;
                    CVE_VALUE: {
                        _DESCRIPTION?: string;
                        _LANG_REF: string;
                        _text: string;
                    };
                };
                DESCRIPTION?: {
                    _LANG_REF: string;
                    _text: string;
                };
            };
            EXTERNAL_REF?: {
                _EXT_REF_ID: string;
                _TYPE: string;
                _VALUE: string;
            };
            HEADER: {
                _MEDIA_FILE?: string;
                _TIME_UNITS?: "milliseconds" | "NTSC-frames" | "PAL-frames";
                LINKED_FILE_DESCRIPTOR?: {
                    _ASSOCIATED_WITH?: string;
                    _LINK_URL: string;
                    _MIME_TYPE: string;
                    _RELATIVE_LINK_URL?: string;
                    _TIME_ORIGIN?: number;
                };
                MEDIA_DESCRIPTOR?: {
                    _EXTRACTED_FROM?: string;
                    _MEDIA_URL: string;
                    _MIME_TYPE: string;
                    _RELATIVE_MEDIA_URL?: string;
                    _TIME_ORIGIN?: number;
                };
                PROPERTY: {
                    _NAME?: string;
                    _text: string;
                }[];
            };
            LANGUAGE?: {
                _LANG_DEF?: string;
                _LANG_ID: string;
                _LANG_LABEL?: string;
            };
            LEXICON_REF?: {
                _DATCAT_ID?: string;
                _DATCAT_NAME?: string;
                _LEX_REF_ID: string;
                _LEXICON_ID: string;
                _LEXICON_NAME: string;
                _NAME: string;
                _TYPE: string;
                _URL: string;
            };
            LICENSE?: {
                _LICENSE_URL?: string;
            };
            LINGUISTIC_TYPE: {
                _CONSTRAINTS?: string;
                _CONTROLLED_VOCABULARY_REF?: string;
                _EXT_REF?: string;
                _GRAPHIC_REFERENCES?: boolean;
                _LEXICON_REF?: string;
                _LINGUISTIC_TYPE_ID: string;
                _TIME_ALIGNABLE?: string;
            };
            LOCALE?: any;
            TIER: {
                _ANNOTATOR?: string;
                _DEFAULT_LOCALE?: string;
                _EXT_REF?: string;
                _LANG_REF?: string;
                _LINGUISTIC_TYPE_REF: string;
                _PARENT_REF?: string;
                _PARTICIPANT?: string;
                _TIER_ID: string;
                ANNOTATION: {
                    ALIGNABLE_ANNOTATION?: {
                        _ANNOTATION_ID: string;
                        _SVG_REF?: string;
                        _TIME_SLOT_REF1: string;
                        _TIME_SLOT_REF2: string;
                        ANNOTATION_VALUE: string;
                    };
                    REF_ANNOTATION?: {
                        _ANNOTATION_ID: string;
                        _ANNOTATION_REF: string;
                        _CVE_REF: string;
                        _EXT_REF?: string;
                        _LANG_REF: string;
                        _PREVIOUS_ANNOTATION?: string;
                        ANNOTATION_VALUE: string;
                    };
                }[];
            }[];
            TIME_ORDER: {
                TIME_SLOT?: {
                    _TIME_SLOT_ID: string;
                    _TIME_VALUE?: number;
                }[];
            };
        }

        Settings

        Member Visibility

        On This Page

        Properties
        +ELAN30Object | Octra libraries - v2.0.0

        InterfaceELAN30Object

        interface ELAN30Object {
            ANNOTATION_DOCUMENT: {
                _AUTHOR: string;
                _DATE: string;
                _FORMAT?: string;
                _VERSION: string;
                _xmlns:xsi: string;
                _xsi:noNamespaceSchemaLocation: string;
                CONSTRAINT: {
                    _DESCRIPTION?: string;
                    _STEREOTYPE: string;
                }[];
                CONTROLLED_VOCABULARY?: {
                    _CV_ID: string;
                    _EXT_REF?: string;
                    CV_ENTRY_ML?: {
                        _CVE_ID: string;
                        _EXT_REF?: string;
                        CVE_VALUE: {
                            _DESCRIPTION?: string;
                            _LANG_REF: string;
                            _text: string;
                        };
                    };
                    DESCRIPTION?: {
                        _LANG_REF: string;
                        _text: string;
                    };
                };
                EXTERNAL_REF?: {
                    _EXT_REF_ID: string;
                    _TYPE: string;
                    _VALUE: string;
                };
                HEADER: {
                    _MEDIA_FILE?: string;
                    _TIME_UNITS?: "milliseconds" | "NTSC-frames" | "PAL-frames";
                    LINKED_FILE_DESCRIPTOR?: {
                        _ASSOCIATED_WITH?: string;
                        _LINK_URL: string;
                        _MIME_TYPE: string;
                        _RELATIVE_LINK_URL?: string;
                        _TIME_ORIGIN?: number;
                    };
                    MEDIA_DESCRIPTOR?: {
                        _EXTRACTED_FROM?: string;
                        _MEDIA_URL: string;
                        _MIME_TYPE: string;
                        _RELATIVE_MEDIA_URL?: string;
                        _TIME_ORIGIN?: number;
                    };
                    PROPERTY: {
                        _NAME?: string;
                        _text: string;
                    }[];
                };
                LANGUAGE?: {
                    _LANG_DEF?: string;
                    _LANG_ID: string;
                    _LANG_LABEL?: string;
                };
                LEXICON_REF?: {
                    _DATCAT_ID?: string;
                    _DATCAT_NAME?: string;
                    _LEX_REF_ID: string;
                    _LEXICON_ID: string;
                    _LEXICON_NAME: string;
                    _NAME: string;
                    _TYPE: string;
                    _URL: string;
                };
                LICENSE?: {
                    _LICENSE_URL?: string;
                };
                LINGUISTIC_TYPE: {
                    _CONSTRAINTS?: string;
                    _CONTROLLED_VOCABULARY_REF?: string;
                    _EXT_REF?: string;
                    _GRAPHIC_REFERENCES?: boolean;
                    _LEXICON_REF?: string;
                    _LINGUISTIC_TYPE_ID: string;
                    _TIME_ALIGNABLE?: string;
                };
                LOCALE?: any;
                TIER: {
                    _ANNOTATOR?: string;
                    _DEFAULT_LOCALE?: string;
                    _EXT_REF?: string;
                    _LANG_REF?: string;
                    _LINGUISTIC_TYPE_REF: string;
                    _PARENT_REF?: string;
                    _PARTICIPANT?: string;
                    _TIER_ID: string;
                    ANNOTATION: {
                        ALIGNABLE_ANNOTATION?: {
                            _ANNOTATION_ID: string;
                            _SVG_REF?: string;
                            _TIME_SLOT_REF1: string;
                            _TIME_SLOT_REF2: string;
                            ANNOTATION_VALUE: string;
                        };
                        REF_ANNOTATION?: {
                            _ANNOTATION_ID: string;
                            _ANNOTATION_REF: string;
                            _CVE_REF: string;
                            _EXT_REF?: string;
                            _LANG_REF: string;
                            _PREVIOUS_ANNOTATION?: string;
                            ANNOTATION_VALUE: string;
                        };
                    }[];
                }[];
                TIME_ORDER: {
                    TIME_SLOT?: {
                        _TIME_SLOT_ID: string;
                        _TIME_VALUE?: number;
                    }[];
                };
            };
        }

        Properties

        ANNOTATION_DOCUMENT +

        Properties

        ANNOTATION_DOCUMENT

        ANNOTATION_DOCUMENT: {
            _AUTHOR: string;
            _DATE: string;
            _FORMAT?: string;
            _VERSION: string;
            _xmlns:xsi: string;
            _xsi:noNamespaceSchemaLocation: string;
            CONSTRAINT: {
                _DESCRIPTION?: string;
                _STEREOTYPE: string;
            }[];
            CONTROLLED_VOCABULARY?: {
                _CV_ID: string;
                _EXT_REF?: string;
                CV_ENTRY_ML?: {
                    _CVE_ID: string;
                    _EXT_REF?: string;
                    CVE_VALUE: {
                        _DESCRIPTION?: string;
                        _LANG_REF: string;
                        _text: string;
                    };
                };
                DESCRIPTION?: {
                    _LANG_REF: string;
                    _text: string;
                };
            };
            EXTERNAL_REF?: {
                _EXT_REF_ID: string;
                _TYPE: string;
                _VALUE: string;
            };
            HEADER: {
                _MEDIA_FILE?: string;
                _TIME_UNITS?: "milliseconds" | "NTSC-frames" | "PAL-frames";
                LINKED_FILE_DESCRIPTOR?: {
                    _ASSOCIATED_WITH?: string;
                    _LINK_URL: string;
                    _MIME_TYPE: string;
                    _RELATIVE_LINK_URL?: string;
                    _TIME_ORIGIN?: number;
                };
                MEDIA_DESCRIPTOR?: {
                    _EXTRACTED_FROM?: string;
                    _MEDIA_URL: string;
                    _MIME_TYPE: string;
                    _RELATIVE_MEDIA_URL?: string;
                    _TIME_ORIGIN?: number;
                };
                PROPERTY: {
                    _NAME?: string;
                    _text: string;
                }[];
            };
            LANGUAGE?: {
                _LANG_DEF?: string;
                _LANG_ID: string;
                _LANG_LABEL?: string;
            };
            LEXICON_REF?: {
                _DATCAT_ID?: string;
                _DATCAT_NAME?: string;
                _LEX_REF_ID: string;
                _LEXICON_ID: string;
                _LEXICON_NAME: string;
                _NAME: string;
                _TYPE: string;
                _URL: string;
            };
            LICENSE?: {
                _LICENSE_URL?: string;
            };
            LINGUISTIC_TYPE: {
                _CONSTRAINTS?: string;
                _CONTROLLED_VOCABULARY_REF?: string;
                _EXT_REF?: string;
                _GRAPHIC_REFERENCES?: boolean;
                _LEXICON_REF?: string;
                _LINGUISTIC_TYPE_ID: string;
                _TIME_ALIGNABLE?: string;
            };
            LOCALE?: any;
            TIER: {
                _ANNOTATOR?: string;
                _DEFAULT_LOCALE?: string;
                _EXT_REF?: string;
                _LANG_REF?: string;
                _LINGUISTIC_TYPE_REF: string;
                _PARENT_REF?: string;
                _PARTICIPANT?: string;
                _TIER_ID: string;
                ANNOTATION: {
                    ALIGNABLE_ANNOTATION?: {
                        _ANNOTATION_ID: string;
                        _SVG_REF?: string;
                        _TIME_SLOT_REF1: string;
                        _TIME_SLOT_REF2: string;
                        ANNOTATION_VALUE: string;
                    };
                    REF_ANNOTATION?: {
                        _ANNOTATION_ID: string;
                        _ANNOTATION_REF: string;
                        _CVE_REF: string;
                        _EXT_REF?: string;
                        _LANG_REF: string;
                        _PREVIOUS_ANNOTATION?: string;
                        ANNOTATION_VALUE: string;
                    };
                }[];
            }[];
            TIME_ORDER: {
                TIME_SLOT?: {
                    _TIME_SLOT_ID: string;
                    _TIME_VALUE?: number;
                }[];
            };
        }

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.ExportResult.html b/interfaces/_octra_annotation.ExportResult.html index 8110849b8..b6c00c2bf 100644 --- a/interfaces/_octra_annotation.ExportResult.html +++ b/interfaces/_octra_annotation.ExportResult.html @@ -1,3 +1,3 @@ -ExportResult | Octra libraries - v2.0.0

        InterfaceExportResult

        interface ExportResult {
            error?: string;
            file?: IFile;
        }

        Properties

        error? +ExportResult | Octra libraries - v2.0.0

        InterfaceExportResult

        interface ExportResult {
            error?: string;
            file?: IFile;
        }

        Properties

        error? file? -

        Properties

        Optionalerror

        error?: string

        Optionalfile

        file?: IFile

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        Optionalerror

        error?: string

        Optionalfile

        file?: IFile

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.IAnnotJSON.html b/interfaces/_octra_annotation.IAnnotJSON.html index ad9c0fb9a..7c5890efc 100644 --- a/interfaces/_octra_annotation.IAnnotJSON.html +++ b/interfaces/_octra_annotation.IAnnotJSON.html @@ -1,6 +1,6 @@ -IAnnotJSON | Octra libraries - v2.0.0

        InterfaceIAnnotJSON

        interface IAnnotJSON {
            annotates: string;
            levels: ILevel[];
            links: ILink[];
            name: string;
            sampleRate: number;
        }

        Implemented by

        Properties

        annotates +IAnnotJSON | Octra libraries - v2.0.0

        InterfaceIAnnotJSON

        interface IAnnotJSON {
            annotates: string;
            levels: ILevel[];
            links: ILink[];
            name: string;
            sampleRate: number;
        }

        Implemented by

        Properties

        annotates levels links name sampleRate -

        Properties

        annotates

        annotates: string

        levels

        levels: ILevel[]

        links

        links: ILink[]

        name

        name: string

        sampleRate

        sampleRate: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        annotates

        annotates: string

        levels

        levels: ILevel[]

        links

        links: ILink[]

        name

        name: string

        sampleRate

        sampleRate: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.IAudioFile.html b/interfaces/_octra_annotation.IAudioFile.html index 9680561c5..6463020e5 100644 --- a/interfaces/_octra_annotation.IAudioFile.html +++ b/interfaces/_octra_annotation.IAudioFile.html @@ -1,8 +1,8 @@ -IAudioFile | Octra libraries - v2.0.0

        InterfaceIAudioFile

        interface IAudioFile {
            arraybuffer?: ArrayBuffer;
            duration?: number;
            name: string;
            sampleRate: number;
            size?: number;
            type?: string;
            url?: string;
        }

        Properties

        arraybuffer? +IAudioFile | Octra libraries - v2.0.0

        InterfaceIAudioFile

        interface IAudioFile {
            arraybuffer?: ArrayBuffer;
            duration?: number;
            name: string;
            sampleRate: number;
            size?: number;
            type?: string;
            url?: string;
        }

        Properties

        arraybuffer? duration? name sampleRate size? type? url? -

        Properties

        Optionalarraybuffer

        arraybuffer?: ArrayBuffer

        Optionalduration

        duration?: number

        name

        name: string

        sampleRate

        sampleRate: number

        Optionalsize

        size?: number

        Optionaltype

        type?: string

        Optionalurl

        url?: string

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        Optionalarraybuffer

        arraybuffer?: ArrayBuffer

        Optionalduration

        duration?: number

        name

        name: string

        sampleRate

        sampleRate: number

        Optionalsize

        size?: number

        Optionaltype

        type?: string

        Optionalurl

        url?: string

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.IEvent.html b/interfaces/_octra_annotation.IEvent.html index 438459651..6c25bb51c 100644 --- a/interfaces/_octra_annotation.IEvent.html +++ b/interfaces/_octra_annotation.IEvent.html @@ -1,4 +1,4 @@ -IEvent | Octra libraries - v2.0.0

        InterfaceIEvent

        interface IEvent {
            id: number;
            labels: ILabel[];
            samplePoint: number;
        }

        Hierarchy (view full)

        Properties

        id +IEvent | Octra libraries - v2.0.0

        InterfaceIEvent

        interface IEvent {
            id: number;
            labels: ILabel[];
            samplePoint: number;
        }

        Hierarchy (view full)

        Properties

        id labels samplePoint -

        Properties

        id

        id: number

        labels

        labels: ILabel[]

        samplePoint

        samplePoint: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        id

        id: number

        labels

        labels: ILabel[]

        samplePoint

        samplePoint: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.IEventLevel.html b/interfaces/_octra_annotation.IEventLevel.html index 42806050f..ed1c40294 100644 --- a/interfaces/_octra_annotation.IEventLevel.html +++ b/interfaces/_octra_annotation.IEventLevel.html @@ -1,4 +1,4 @@ -IEventLevel | Octra libraries - v2.0.0

        InterfaceIEventLevel

        interface IEventLevel {
            items: IEvent[];
            name: string;
            type: AnnotationLevelType;
        }

        Hierarchy (view full)

        Implemented by

        Properties

        items +IEventLevel | Octra libraries - v2.0.0

        InterfaceIEventLevel

        interface IEventLevel {
            items: IEvent[];
            name: string;
            type: AnnotationLevelType;
        }

        Hierarchy (view full)

        Implemented by

        Properties

        items name type -

        Properties

        items

        items: IEvent[]

        name

        name: string

        type

        type: AnnotationLevelType

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        items

        items: IEvent[]

        name

        name: string

        type

        type: AnnotationLevelType

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.IFile.html b/interfaces/_octra_annotation.IFile.html index b2d2ed88d..dbf9634a0 100644 --- a/interfaces/_octra_annotation.IFile.html +++ b/interfaces/_octra_annotation.IFile.html @@ -1,5 +1,5 @@ -IFile | Octra libraries - v2.0.0

        InterfaceIFile

        interface IFile {
            content: string;
            encoding: string;
            name: string;
            type: string;
        }

        Properties

        content +IFile | Octra libraries - v2.0.0

        InterfaceIFile

        interface IFile {
            content: string;
            encoding: string;
            name: string;
            type: string;
        }

        Properties

        content encoding name type -

        Properties

        content

        content: string

        encoding

        encoding: string

        name

        name: string

        type

        type: string

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        content

        content: string

        encoding

        encoding: string

        name

        name: string

        type

        type: string

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.IItem.html b/interfaces/_octra_annotation.IItem.html index b5eebeacc..9f8d9e588 100644 --- a/interfaces/_octra_annotation.IItem.html +++ b/interfaces/_octra_annotation.IItem.html @@ -1,3 +1,3 @@ -IItem | Octra libraries - v2.0.0

        InterfaceIItem

        interface IItem {
            id: number;
            labels: ILabel[];
        }

        Hierarchy (view full)

        Implemented by

        Properties

        id +IItem | Octra libraries - v2.0.0

        InterfaceIItem

        interface IItem {
            id: number;
            labels: ILabel[];
        }

        Hierarchy (view full)

        Implemented by

        Properties

        id labels -

        Properties

        id

        id: number

        labels

        labels: ILabel[]

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        id

        id: number

        labels

        labels: ILabel[]

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.IItemLevel.html b/interfaces/_octra_annotation.IItemLevel.html index da82f8c2f..9d8c44348 100644 --- a/interfaces/_octra_annotation.IItemLevel.html +++ b/interfaces/_octra_annotation.IItemLevel.html @@ -1,4 +1,4 @@ -IItemLevel | Octra libraries - v2.0.0

        InterfaceIItemLevel

        interface IItemLevel {
            items: IItem[];
            name: string;
            type: AnnotationLevelType;
        }

        Hierarchy (view full)

        Implemented by

        Properties

        items +IItemLevel | Octra libraries - v2.0.0

        InterfaceIItemLevel

        interface IItemLevel {
            items: IItem[];
            name: string;
            type: AnnotationLevelType;
        }

        Hierarchy (view full)

        Implemented by

        Properties

        items name type -

        Properties

        items

        items: IItem[]

        name

        name: string

        type

        type: AnnotationLevelType

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        items

        items: IItem[]

        name

        name: string

        type

        type: AnnotationLevelType

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.ILabel.html b/interfaces/_octra_annotation.ILabel.html index 787a39707..b54736116 100644 --- a/interfaces/_octra_annotation.ILabel.html +++ b/interfaces/_octra_annotation.ILabel.html @@ -1,3 +1,3 @@ -ILabel | Octra libraries - v2.0.0

        InterfaceILabel

        interface ILabel {
            name: string;
            value: string;
        }

        Implemented by

        Properties

        name +ILabel | Octra libraries - v2.0.0

        InterfaceILabel

        interface ILabel {
            name: string;
            value: string;
        }

        Implemented by

        Properties

        name value -

        Properties

        name

        name: string

        value

        value: string

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        name

        name: string

        value

        value: string

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.ILevel.html b/interfaces/_octra_annotation.ILevel.html index 8bc23a61c..2dc495b5d 100644 --- a/interfaces/_octra_annotation.ILevel.html +++ b/interfaces/_octra_annotation.ILevel.html @@ -1,3 +1,3 @@ -ILevel | Octra libraries - v2.0.0

        InterfaceILevel

        interface ILevel {
            name: string;
            type: AnnotationLevelType;
        }

        Hierarchy (view full)

        Implemented by

        Properties

        name +ILevel | Octra libraries - v2.0.0

        InterfaceILevel

        interface ILevel {
            name: string;
            type: AnnotationLevelType;
        }

        Hierarchy (view full)

        Implemented by

        Properties

        name type -

        Properties

        name

        name: string

        type

        type: AnnotationLevelType

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        name

        name: string

        type

        type: AnnotationLevelType

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.ILink.html b/interfaces/_octra_annotation.ILink.html index 9a1d29c09..430012a82 100644 --- a/interfaces/_octra_annotation.ILink.html +++ b/interfaces/_octra_annotation.ILink.html @@ -1,3 +1,3 @@ -ILink | Octra libraries - v2.0.0

        InterfaceILink

        interface ILink {
            fromID: number;
            toID: number;
        }

        Implemented by

        Properties

        fromID +ILink | Octra libraries - v2.0.0

        InterfaceILink

        interface ILink {
            fromID: number;
            toID: number;
        }

        Implemented by

        Properties

        fromID toID -

        Properties

        fromID

        fromID: number

        toID

        toID: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        fromID

        fromID: number

        toID

        toID: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.ISegment.html b/interfaces/_octra_annotation.ISegment.html index 5b2739c22..128919e4f 100644 --- a/interfaces/_octra_annotation.ISegment.html +++ b/interfaces/_octra_annotation.ISegment.html @@ -1,5 +1,5 @@ -ISegment | Octra libraries - v2.0.0

        InterfaceISegment

        interface ISegment {
            id: number;
            labels: ILabel[];
            sampleDur: number;
            sampleStart: number;
        }

        Hierarchy (view full)

        Properties

        id +ISegment | Octra libraries - v2.0.0

        InterfaceISegment

        interface ISegment {
            id: number;
            labels: ILabel[];
            sampleDur: number;
            sampleStart: number;
        }

        Hierarchy (view full)

        Properties

        id labels sampleDur sampleStart -

        Properties

        id

        id: number

        labels

        labels: ILabel[]

        sampleDur

        sampleDur: number

        sampleStart

        sampleStart: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        id

        id: number

        labels

        labels: ILabel[]

        sampleDur

        sampleDur: number

        sampleStart

        sampleStart: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.ISegmentLevel.html b/interfaces/_octra_annotation.ISegmentLevel.html index 043a84911..fd3a14fdf 100644 --- a/interfaces/_octra_annotation.ISegmentLevel.html +++ b/interfaces/_octra_annotation.ISegmentLevel.html @@ -1,4 +1,4 @@ -ISegmentLevel | Octra libraries - v2.0.0

        InterfaceISegmentLevel

        interface ISegmentLevel {
            items: ISegment[];
            name: string;
            type: AnnotationLevelType;
        }

        Hierarchy (view full)

        Implemented by

        Properties

        items +ISegmentLevel | Octra libraries - v2.0.0

        InterfaceISegmentLevel

        interface ISegmentLevel {
            items: ISegment[];
            name: string;
            type: AnnotationLevelType;
        }

        Hierarchy (view full)

        Implemented by

        Properties

        items name type -

        Properties

        items

        items: ISegment[]

        name

        name: string

        type

        type: AnnotationLevelType

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        items

        items: ISegment[]

        name

        name: string

        type

        type: AnnotationLevelType

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.ImportResult.html b/interfaces/_octra_annotation.ImportResult.html index 9f161e51d..5a2a6c48a 100644 --- a/interfaces/_octra_annotation.ImportResult.html +++ b/interfaces/_octra_annotation.ImportResult.html @@ -1,4 +1,4 @@ -ImportResult | Octra libraries - v2.0.0

        InterfaceImportResult

        interface ImportResult {
            annotjson?: OAnnotJSON;
            audiofile?: OAudiofile;
            error?: string;
        }

        Properties

        annotjson? +ImportResult | Octra libraries - v2.0.0

        InterfaceImportResult

        interface ImportResult {
            annotjson?: OAnnotJSON;
            audiofile?: OAudiofile;
            error?: string;
        }

        Properties

        annotjson? audiofile? error? -

        Properties

        Optionalannotjson

        annotjson?: OAnnotJSON

        Optionalaudiofile

        audiofile?: OAudiofile

        Optionalerror

        error?: string

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        Optionalannotjson

        annotjson?: OAnnotJSON

        Optionalaudiofile

        audiofile?: OAudiofile

        Optionalerror

        error?: string

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.SegmentWithContext.html b/interfaces/_octra_annotation.SegmentWithContext.html index 1488773ae..f59eb9454 100644 --- a/interfaces/_octra_annotation.SegmentWithContext.html +++ b/interfaces/_octra_annotation.SegmentWithContext.html @@ -1,5 +1,5 @@ -SegmentWithContext | Octra libraries - v2.0.0

        InterfaceSegmentWithContext<T>

        interface SegmentWithContext<T> {
            context?: T;
            id: number;
            labels: OLabel[];
            time: SampleUnit;
        }

        Type Parameters

        Implemented by

        Properties

        context? +SegmentWithContext | Octra libraries - v2.0.0

        InterfaceSegmentWithContext<T>

        interface SegmentWithContext<T> {
            context?: T;
            id: number;
            labels: OLabel[];
            time: SampleUnit;
        }

        Type Parameters

        Implemented by

        Properties

        context? id labels time -

        Properties

        Optionalcontext

        context?: T

        id

        id: number

        labels

        labels: OLabel[]

        time

        time: SampleUnit

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        Optionalcontext

        context?: T

        id

        id: number

        labels

        labels: OLabel[]

        time

        time: SampleUnit

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_annotation.WhisperJSONWord.html b/interfaces/_octra_annotation.WhisperJSONWord.html index 5ad95cba3..dfb260f64 100644 --- a/interfaces/_octra_annotation.WhisperJSONWord.html +++ b/interfaces/_octra_annotation.WhisperJSONWord.html @@ -1,7 +1,7 @@ -WhisperJSONWord | Octra libraries - v2.0.0

        InterfaceWhisperJSONWord

        interface WhisperJSONWord {
            end: number;
            probability?: number;
            score?: number;
            speaker?: string;
            start: number;
            word: string;
        }

        Properties

        end +WhisperJSONWord | Octra libraries - v2.0.0

        InterfaceWhisperJSONWord

        interface WhisperJSONWord {
            end: number;
            probability?: number;
            score?: number;
            speaker?: string;
            start: number;
            word: string;
        }

        Properties

        end probability? score? speaker? start word -

        Properties

        end

        end: number

        Optionalprobability

        probability?: number

        Optionalscore

        score?: number

        Optionalspeaker

        speaker?: string

        start

        start: number

        word

        word: string

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        end

        end: number

        Optionalprobability

        probability?: number

        Optionalscore

        score?: number

        Optionalspeaker

        speaker?: string

        start

        start: number

        word

        word: string

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_assets.OctraGuidelines.html b/interfaces/_octra_assets.OctraGuidelines.html index 717ab6e9b..ceaefb4f9 100644 --- a/interfaces/_octra_assets.OctraGuidelines.html +++ b/interfaces/_octra_assets.OctraGuidelines.html @@ -1,4 +1,4 @@ -OctraGuidelines | Octra libraries - v2.0.0

        InterfaceOctraGuidelines

        interface OctraGuidelines {
            instructions: {
                entries: {
                    code: string;
                    description: string;
                    examples: {
                        annotation: string;
                        url: string;
                    }[];
                    priority: string;
                    title: string;
                }[];
                group: string;
            }[];
            markers: {
                button_text: string;
                code: string;
                description: string;
                icon: string;
                id: number;
                name: string;
                shortcuts: {
                    mac: string;
                    pc: string;
                }[];
                type: string;
            }[];
            meta: {
                authors: string;
                date: string;
                encoding: string;
                object_language: string;
                pdf: {
                    url: string;
                };
                project: string;
                validation_url: string;
                version: string;
            };
        }

        Properties

        instructions +OctraGuidelines | Octra libraries - v2.0.0

        InterfaceOctraGuidelines

        interface OctraGuidelines {
            instructions: {
                entries: {
                    code: string;
                    description: string;
                    examples: {
                        annotation: string;
                        url: string;
                    }[];
                    priority: string;
                    title: string;
                }[];
                group: string;
            }[];
            markers: {
                button_text: string;
                code: string;
                description: string;
                icon: string;
                id: number;
                name: string;
                shortcuts: {
                    mac: string;
                    pc: string;
                }[];
                type: string;
            }[];
            meta: {
                authors: string;
                date: string;
                encoding: string;
                object_language: string;
                pdf: {
                    url: string;
                };
                project: string;
                validation_url: string;
                version: string;
            };
        }

        Properties

        instructions markers meta -

        Properties

        instructions

        instructions: {
            entries: {
                code: string;
                description: string;
                examples: {
                    annotation: string;
                    url: string;
                }[];
                priority: string;
                title: string;
            }[];
            group: string;
        }[]

        markers

        markers: {
            button_text: string;
            code: string;
            description: string;
            icon: string;
            id: number;
            name: string;
            shortcuts: {
                mac: string;
                pc: string;
            }[];
            type: string;
        }[]

        meta

        meta: {
            authors: string;
            date: string;
            encoding: string;
            object_language: string;
            pdf: {
                url: string;
            };
            project: string;
            validation_url: string;
            version: string;
        }

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        instructions

        instructions: {
            entries: {
                code: string;
                description: string;
                examples: {
                    annotation: string;
                    url: string;
                }[];
                priority: string;
                title: string;
            }[];
            group: string;
        }[]

        markers

        markers: {
            button_text: string;
            code: string;
            description: string;
            icon: string;
            id: number;
            name: string;
            shortcuts: {
                mac: string;
                pc: string;
            }[];
            type: string;
        }[]

        meta

        meta: {
            authors: string;
            date: string;
            encoding: string;
            object_language: string;
            pdf: {
                url: string;
            };
            project: string;
            validation_url: string;
            version: string;
        }

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_json_sets.AudioFileMetaData.html b/interfaces/_octra_json_sets.AudioFileMetaData.html index f13138628..af86ae099 100644 --- a/interfaces/_octra_json_sets.AudioFileMetaData.html +++ b/interfaces/_octra_json_sets.AudioFileMetaData.html @@ -1,8 +1,8 @@ -AudioFileMetaData | Octra libraries - v2.0.0

        InterfaceAudioFileMetaData

        interface AudioFileMetaData {
            bitRate?: number;
            codec?: string;
            container?: string;
            duration?: {
                samples: number;
                seconds: number;
            };
            lossless?: boolean;
            numberOfChannels?: number;
            sampleRate?: number;
        }

        Properties

        bitRate? +AudioFileMetaData | Octra libraries - v2.0.0

        InterfaceAudioFileMetaData

        interface AudioFileMetaData {
            bitRate?: number;
            codec?: string;
            container?: string;
            duration?: {
                samples: number;
                seconds: number;
            };
            lossless?: boolean;
            numberOfChannels?: number;
            sampleRate?: number;
        }

        Properties

        bitRate? codec? container? duration? lossless? numberOfChannels? sampleRate? -

        Properties

        OptionalbitRate

        bitRate?: number

        Optionalcodec

        codec?: string

        Optionalcontainer

        container?: string

        Optionalduration

        duration?: {
            samples: number;
            seconds: number;
        }

        Optionallossless

        lossless?: boolean

        OptionalnumberOfChannels

        numberOfChannels?: number

        OptionalsampleRate

        sampleRate?: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        OptionalbitRate

        bitRate?: number

        Optionalcodec

        codec?: string

        Optionalcontainer

        container?: string

        Optionalduration

        duration?: {
            samples: number;
            seconds: number;
        }

        Optionallossless

        lossless?: boolean

        OptionalnumberOfChannels

        numberOfChannels?: number

        OptionalsampleRate

        sampleRate?: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_media.IAudioFile.html b/interfaces/_octra_media.IAudioFile.html index 301b91fba..7445e8c7e 100644 --- a/interfaces/_octra_media.IAudioFile.html +++ b/interfaces/_octra_media.IAudioFile.html @@ -1,7 +1,7 @@ -IAudioFile | Octra libraries - v2.0.0

        InterfaceIAudioFile

        interface IAudioFile {
            duration: number;
            name: string;
            sampleRate: number;
            size: number;
            type: string;
            url?: string;
        }

        Implemented by

        Properties

        duration +IAudioFile | Octra libraries - v2.0.0

        InterfaceIAudioFile

        interface IAudioFile {
            duration: number;
            name: string;
            sampleRate: number;
            size: number;
            type: string;
            url?: string;
        }

        Implemented by

        Properties

        duration name sampleRate size type url? -

        Properties

        duration

        duration: number

        name

        name: string

        sampleRate

        sampleRate: number

        size

        size: number

        type

        type: string

        Optionalurl

        url?: string

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        duration

        duration: number

        name

        name: string

        sampleRate

        sampleRate: number

        size

        size: number

        type

        type: string

        Optionalurl

        url?: string

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_media.NumeratedSegment.html b/interfaces/_octra_media.NumeratedSegment.html index 2e87d0e2d..1f728699f 100644 --- a/interfaces/_octra_media.NumeratedSegment.html +++ b/interfaces/_octra_media.NumeratedSegment.html @@ -1,4 +1,4 @@ -NumeratedSegment | Octra libraries - v2.0.0

        InterfaceNumeratedSegment

        interface NumeratedSegment {
            number: number;
            sampleDur: number;
            sampleStart: number;
        }

        Properties

        number +NumeratedSegment | Octra libraries - v2.0.0

        InterfaceNumeratedSegment

        interface NumeratedSegment {
            number: number;
            sampleDur: number;
            sampleStart: number;
        }

        Properties

        number sampleDur sampleStart -

        Properties

        number

        number: number

        sampleDur

        sampleDur: number

        sampleStart

        sampleStart: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        number

        number: number

        sampleDur

        sampleDur: number

        sampleStart

        sampleStart: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_media.SampleTimeValues.html b/interfaces/_octra_media.SampleTimeValues.html index 4bc8eff90..67758ae8c 100644 --- a/interfaces/_octra_media.SampleTimeValues.html +++ b/interfaces/_octra_media.SampleTimeValues.html @@ -1,4 +1,4 @@ SampleTimeValues | Octra libraries - v2.0.0

        InterfaceSampleTimeValues

        class initialized with samples which can output other units like seconds, milliseconds

        -
        interface SampleTimeValues {
            seconds: number;
            unix: number;
        }

        Properties

        seconds +
        interface SampleTimeValues {
            seconds: number;
            unix: number;
        }

        Properties

        seconds unix -

        Properties

        seconds

        seconds: number

        unix

        unix: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        seconds

        seconds: number

        unix

        unix: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_ngx_components.AudioViewerShortcutEvent.html b/interfaces/_octra_ngx_components.AudioViewerShortcutEvent.html index 1d933b728..50a21ddc3 100644 --- a/interfaces/_octra_ngx_components.AudioViewerShortcutEvent.html +++ b/interfaces/_octra_ngx_components.AudioViewerShortcutEvent.html @@ -1,8 +1,8 @@ -AudioViewerShortcutEvent | Octra libraries - v2.0.0

        InterfaceAudioViewerShortcutEvent

        interface AudioViewerShortcutEvent {
            selection?: AudioSelection;
            shortcut: string;
            shortcutName: string;
            timePosition?: SampleUnit;
            timestamp: number;
            type: string;
            value?: string;
        }

        Properties

        selection? +AudioViewerShortcutEvent | Octra libraries - v2.0.0

        InterfaceAudioViewerShortcutEvent

        interface AudioViewerShortcutEvent {
            selection?: AudioSelection;
            shortcut: string;
            shortcutName: string;
            timePosition?: SampleUnit;
            timestamp: number;
            type: string;
            value?: string;
        }

        Properties

        selection? shortcut shortcutName timePosition? timestamp type value? -

        Properties

        Optionalselection

        selection?: AudioSelection

        shortcut

        shortcut: string

        shortcutName

        shortcutName: string

        OptionaltimePosition

        timePosition?: SampleUnit

        timestamp

        timestamp: number

        type

        type: string

        Optionalvalue

        value?: string

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        Optionalselection

        selection?: AudioSelection

        shortcut

        shortcut: string

        shortcutName

        shortcutName: string

        OptionaltimePosition

        timePosition?: SampleUnit

        timestamp

        timestamp: number

        type

        type: string

        Optionalvalue

        value?: string

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_ngx_components.CurrentLevelChangeEvent.html b/interfaces/_octra_ngx_components.CurrentLevelChangeEvent.html index 13478e553..a9fcd2312 100644 --- a/interfaces/_octra_ngx_components.CurrentLevelChangeEvent.html +++ b/interfaces/_octra_ngx_components.CurrentLevelChangeEvent.html @@ -1,4 +1,4 @@ -CurrentLevelChangeEvent | Octra libraries - v2.0.0

        InterfaceCurrentLevelChangeEvent

        interface CurrentLevelChangeEvent {
            items: {
                id?: number;
                index?: number;
                instance?: AnnotationAnySegment;
            }[];
            removeOptions?: {
                mergeTranscripts: boolean;
                silenceCode: undefined | string;
            };
            type: "change" | "add" | "remove";
        }

        Properties

        items +CurrentLevelChangeEvent | Octra libraries - v2.0.0

        InterfaceCurrentLevelChangeEvent

        interface CurrentLevelChangeEvent {
            items: {
                id?: number;
                index?: number;
                instance?: AnnotationAnySegment;
            }[];
            removeOptions?: {
                mergeTranscripts: boolean;
                silenceCode: undefined | string;
            };
            type: "change" | "add" | "remove";
        }

        Properties

        items removeOptions? type -

        Properties

        items

        items: {
            id?: number;
            index?: number;
            instance?: AnnotationAnySegment;
        }[]

        OptionalremoveOptions

        removeOptions?: {
            mergeTranscripts: boolean;
            silenceCode: undefined | string;
        }

        type

        type: "change" | "add" | "remove"

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        items

        items: {
            id?: number;
            index?: number;
            instance?: AnnotationAnySegment;
        }[]

        OptionalremoveOptions

        removeOptions?: {
            mergeTranscripts: boolean;
            silenceCode: undefined | string;
        }

        type

        type: "change" | "add" | "remove"

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_ngx_components.ICircle.html b/interfaces/_octra_ngx_components.ICircle.html index fa3bba2f4..f35167d7f 100644 --- a/interfaces/_octra_ngx_components.ICircle.html +++ b/interfaces/_octra_ngx_components.ICircle.html @@ -1,3 +1,3 @@ -ICircle | Octra libraries - v2.0.0

        InterfaceICircle

        interface ICircle {
            position: IPosition;
            radius: number;
        }

        Properties

        position +ICircle | Octra libraries - v2.0.0

        InterfaceICircle

        interface ICircle {
            position: IPosition;
            radius: number;
        }

        Properties

        position radius -

        Properties

        position

        position: IPosition

        radius

        radius: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        position

        position: IPosition

        radius

        radius: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_ngx_components.IInterval.html b/interfaces/_octra_ngx_components.IInterval.html index 803ffe0f1..8f2dc575a 100644 --- a/interfaces/_octra_ngx_components.IInterval.html +++ b/interfaces/_octra_ngx_components.IInterval.html @@ -1,4 +1,4 @@ IInterval | Octra libraries - v2.0.0

        InterfaceIInterval

        collections

        -
        interface IInterval {
            end: number;
            start: number;
        }

        Implemented by

        Properties

        end +
        interface IInterval {
            end: number;
            start: number;
        }

        Implemented by

        Properties

        end start -

        Properties

        end

        end: number

        start

        start: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        end

        end: number

        start

        start: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_ngx_components.IMargin.html b/interfaces/_octra_ngx_components.IMargin.html index a976d98d4..ee5b33fd0 100644 --- a/interfaces/_octra_ngx_components.IMargin.html +++ b/interfaces/_octra_ngx_components.IMargin.html @@ -1,5 +1,5 @@ -IMargin | Octra libraries - v2.0.0

        InterfaceIMargin

        interface IMargin {
            bottom: number;
            left: number;
            right: number;
            top: number;
        }

        Implemented by

        Properties

        bottom +IMargin | Octra libraries - v2.0.0

        InterfaceIMargin

        interface IMargin {
            bottom: number;
            left: number;
            right: number;
            top: number;
        }

        Implemented by

        Properties

        bottom left right top -

        Properties

        bottom

        bottom: number

        left

        left: number

        right

        right: number

        top

        top: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        bottom

        bottom: number

        left

        left: number

        right

        right: number

        top

        top: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_ngx_components.IPosition.html b/interfaces/_octra_ngx_components.IPosition.html index cf7665d96..7e6c318f8 100644 --- a/interfaces/_octra_ngx_components.IPosition.html +++ b/interfaces/_octra_ngx_components.IPosition.html @@ -1,3 +1,3 @@ -IPosition | Octra libraries - v2.0.0

        InterfaceIPosition

        interface IPosition {
            x: number;
            y: number;
        }

        Properties

        x +IPosition | Octra libraries - v2.0.0

        InterfaceIPosition

        interface IPosition {
            x: number;
            y: number;
        }

        Properties

        x y -

        Properties

        x

        x: number

        y

        y: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        x

        x: number

        y

        y: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_ngx_components.IRectangle.html b/interfaces/_octra_ngx_components.IRectangle.html index 64b54a4e2..c298db2ef 100644 --- a/interfaces/_octra_ngx_components.IRectangle.html +++ b/interfaces/_octra_ngx_components.IRectangle.html @@ -1,4 +1,4 @@ IRectangle | Octra libraries - v2.0.0

        InterfaceIRectangle

        SHAPES

        -
        interface IRectangle {
            position: IPosition;
            size: ISize;
        }

        Implemented by

        Properties

        position +
        interface IRectangle {
            position: IPosition;
            size: ISize;
        }

        Implemented by

        Properties

        position size -

        Properties

        position

        position: IPosition

        size

        size: ISize

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        position

        position: IPosition

        size

        size: ISize

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_ngx_components.ISize.html b/interfaces/_octra_ngx_components.ISize.html index a159b2faf..f0ecc08ab 100644 --- a/interfaces/_octra_ngx_components.ISize.html +++ b/interfaces/_octra_ngx_components.ISize.html @@ -1,3 +1,3 @@ -ISize | Octra libraries - v2.0.0

        InterfaceISize

        interface ISize {
            height: number;
            width: number;
        }

        Implemented by

        Properties

        height +ISize | Octra libraries - v2.0.0

        InterfaceISize

        interface ISize {
            height: number;
            width: number;
        }

        Implemented by

        Properties

        height width -

        Properties

        height

        height: number

        width

        width: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        height

        height: number

        width

        width: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_utilities.FileSize.html b/interfaces/_octra_utilities.FileSize.html index 9da79c736..712460b9e 100644 --- a/interfaces/_octra_utilities.FileSize.html +++ b/interfaces/_octra_utilities.FileSize.html @@ -1,4 +1,4 @@ FileSize | Octra libraries - v2.0.0

        InterfaceFileSize

        represents a file size definition giving size and label.

        -
        interface FileSize {
            label: string;
            size: number;
        }

        Properties

        label +
        interface FileSize {
            label: string;
            size: number;
        }

        Properties

        label size -

        Properties

        label

        label: string

        size

        size: number

        Settings

        Member Visibility

        On This Page

        Properties
        +

        Properties

        label

        label: string

        size

        size: number

        Settings

        Member Visibility

        On This Page

        Properties
        diff --git a/interfaces/_octra_utilities.Serializable.html b/interfaces/_octra_utilities.Serializable.html index e25642193..c25ed6e3f 100644 --- a/interfaces/_octra_utilities.Serializable.html +++ b/interfaces/_octra_utilities.Serializable.html @@ -1,3 +1,3 @@ -Serializable | Octra libraries - v2.0.0

        InterfaceSerializable<S, T>

        interface Serializable<S, T> {
            deserialize(jsonObject: S, sampleRate: number): undefined | T;
            serialize(): S;
        }

        Type Parameters

        • S
        • T

        Implemented by

          Methods

          deserialize +Serializable | Octra libraries - v2.0.0

          InterfaceSerializable<S, T>

          interface Serializable<S, T> {
              deserialize(jsonObject: S, sampleRate: number): undefined | T;
              serialize(): S;
          }

          Type Parameters

          • S
          • T

          Implemented by

            Methods

            deserialize serialize -

            Methods

            deserialize

            • deserialize(jsonObject, sampleRate): undefined | T

            • Parameters

              • jsonObject: S
              • sampleRate: number

              Returns undefined | T

            serialize

            Settings

            Member Visibility

            On This Page

            Methods
            +

            Methods

            deserialize

            • deserialize(jsonObject, sampleRate): undefined | T

            • Parameters

              • jsonObject: S
              • sampleRate: number

              Returns undefined | T

            serialize

            Settings

            Member Visibility

            On This Page

            Methods
            diff --git a/interfaces/_octra_web_media.KeyMappingEntry.html b/interfaces/_octra_web_media.KeyMappingEntry.html index df74bd7bc..6cdf60b88 100644 --- a/interfaces/_octra_web_media.KeyMappingEntry.html +++ b/interfaces/_octra_web_media.KeyMappingEntry.html @@ -1,4 +1,4 @@ KeyMappingEntry | Octra libraries - v2.0.0

            InterfaceKeyMappingEntry

            entry that maps a key name to a code

            -
            interface KeyMappingEntry {
                keyCode: number;
                name: string;
            }

            Properties

            keyCode +
            interface KeyMappingEntry {
                keyCode: number;
                name: string;
            }

            Properties

            keyCode name -

            Properties

            keyCode

            keyCode: number

            name

            name: string

            Settings

            Member Visibility

            On This Page

            Properties
            +

            Properties

            keyCode

            keyCode: number

            name

            name: string

            Settings

            Member Visibility

            On This Page

            Properties
            diff --git a/interfaces/_octra_web_media.ReadFileEvent.html b/interfaces/_octra_web_media.ReadFileEvent.html index 59401a851..948882722 100644 --- a/interfaces/_octra_web_media.ReadFileEvent.html +++ b/interfaces/_octra_web_media.ReadFileEvent.html @@ -1,4 +1,4 @@ -ReadFileEvent | Octra libraries - v2.0.0

            InterfaceReadFileEvent<T>

            interface ReadFileEvent<T> {
                progress: number;
                result?: T;
                status: "initialized" | "reading" | "success";
            }

            Type Parameters

            • T

            Properties

            progress +ReadFileEvent | Octra libraries - v2.0.0

            InterfaceReadFileEvent<T>

            interface ReadFileEvent<T> {
                progress: number;
                result?: T;
                status: "initialized" | "reading" | "success";
            }

            Type Parameters

            • T

            Properties

            progress result? status -

            Properties

            progress

            progress: number

            Optionalresult

            result?: T

            status

            status: "initialized" | "reading" | "success"

            Settings

            Member Visibility

            On This Page

            Properties
            +

            Properties

            progress

            progress: number

            Optionalresult

            result?: T

            status

            status: "initialized" | "reading" | "success"

            Settings

            Member Visibility

            On This Page

            Properties
            diff --git a/interfaces/_octra_web_media.SegmentToDecode.html b/interfaces/_octra_web_media.SegmentToDecode.html index 935b055ef..1bba14f34 100644 --- a/interfaces/_octra_web_media.SegmentToDecode.html +++ b/interfaces/_octra_web_media.SegmentToDecode.html @@ -1,4 +1,4 @@ -SegmentToDecode | Octra libraries - v2.0.0

            InterfaceSegmentToDecode

            interface SegmentToDecode {
                number: number;
                sampleDur: SampleUnit;
                sampleStart: SampleUnit;
            }

            Properties

            number +SegmentToDecode | Octra libraries - v2.0.0

            InterfaceSegmentToDecode

            interface SegmentToDecode {
                number: number;
                sampleDur: SampleUnit;
                sampleStart: SampleUnit;
            }

            Properties

            number sampleDur sampleStart -

            Properties

            number

            number: number

            sampleDur

            sampleDur: SampleUnit

            sampleStart

            sampleStart: SampleUnit

            Settings

            Member Visibility

            On This Page

            Properties
            +

            Properties

            number

            number: number

            sampleDur

            sampleDur: SampleUnit

            sampleStart

            sampleStart: SampleUnit

            Settings

            Member Visibility

            On This Page

            Properties
            diff --git a/interfaces/_octra_web_media.Shortcut.html b/interfaces/_octra_web_media.Shortcut.html index fbfb5b444..72dc75b0c 100644 --- a/interfaces/_octra_web_media.Shortcut.html +++ b/interfaces/_octra_web_media.Shortcut.html @@ -1,8 +1,8 @@ Shortcut | Octra libraries - v2.0.0

            InterfaceShortcut

            shortcut definition

            -
            interface Shortcut {
                callback?: ((keyboardEvent: KeyboardEvent, shortcut: Shortcut, hotkeyEvent: HotkeysEvent, shortcutGroup: ShortcutGroup) => void);
                focusonly?: boolean;
                keys: {
                    mac?: string;
                    pc?: string;
                };
                label?: string;
                name: string;
                title: string;
            }

            Properties

            callback? +
            interface Shortcut {
                callback?: ((keyboardEvent: KeyboardEvent, shortcut: Shortcut, hotkeyEvent: HotkeysEvent, shortcutGroup: ShortcutGroup) => void);
                focusonly?: boolean;
                keys: {
                    mac?: string;
                    pc?: string;
                };
                label?: string;
                name: string;
                title: string;
            }

            Properties

            callback? focusonly? keys label? name title -

            Properties

            Optionalcallback

            callback?: ((keyboardEvent: KeyboardEvent, shortcut: Shortcut, hotkeyEvent: HotkeysEvent, shortcutGroup: ShortcutGroup) => void)

            Optionalfocusonly

            focusonly?: boolean

            keys

            keys: {
                mac?: string;
                pc?: string;
            }

            Optionallabel

            label?: string

            name

            name: string

            title

            title: string

            Settings

            Member Visibility

            On This Page

            Properties
            +

            Properties

            Optionalcallback

            callback?: ((keyboardEvent: KeyboardEvent, shortcut: Shortcut, hotkeyEvent: HotkeysEvent, shortcutGroup: ShortcutGroup) => void)

            Optionalfocusonly

            focusonly?: boolean

            keys

            keys: {
                mac?: string;
                pc?: string;
            }

            Optionallabel

            label?: string

            name

            name: string

            title

            title: string

            Settings

            Member Visibility

            On This Page

            Properties
            diff --git a/interfaces/_octra_web_media.ShortcutEvent.html b/interfaces/_octra_web_media.ShortcutEvent.html index 7f84dc6bc..2f279696f 100644 --- a/interfaces/_octra_web_media.ShortcutEvent.html +++ b/interfaces/_octra_web_media.ShortcutEvent.html @@ -1,9 +1,9 @@ ShortcutEvent | Octra libraries - v2.0.0

            InterfaceShortcutEvent

            wrapper containing KeyboardEvent information with additional data

            -
            interface ShortcutEvent {
                event: KeyboardEvent;
                onFocusOnly?: boolean;
                platform: string;
                shortcut: string;
                shortcutGroupName: string;
                shortcutName: string;
                timestamp: number;
            }

            Properties

            event +
            interface ShortcutEvent {
                event: KeyboardEvent;
                onFocusOnly?: boolean;
                platform: string;
                shortcut: string;
                shortcutGroupName: string;
                shortcutName: string;
                timestamp: number;
            }

            Properties

            event onFocusOnly? platform shortcut shortcutGroupName shortcutName timestamp -

            Properties

            event

            event: KeyboardEvent

            OptionalonFocusOnly

            onFocusOnly?: boolean

            platform

            platform: string

            shortcut

            shortcut: string

            shortcutGroupName

            shortcutGroupName: string

            shortcutName

            shortcutName: string

            timestamp

            timestamp: number

            Settings

            Member Visibility

            On This Page

            Properties
            +

            Properties

            event

            event: KeyboardEvent

            OptionalonFocusOnly

            onFocusOnly?: boolean

            platform

            platform: string

            shortcut

            shortcut: string

            shortcutGroupName

            shortcutGroupName: string

            shortcutName

            shortcutName: string

            timestamp

            timestamp: number

            Settings

            Member Visibility

            On This Page

            Properties
            diff --git a/interfaces/_octra_web_media.ShortcutGroup.html b/interfaces/_octra_web_media.ShortcutGroup.html index c7c584c95..a0693935d 100644 --- a/interfaces/_octra_web_media.ShortcutGroup.html +++ b/interfaces/_octra_web_media.ShortcutGroup.html @@ -1,5 +1,5 @@ ShortcutGroup | Octra libraries - v2.0.0

            InterfaceShortcutGroup

            defines a group of shortcuts

            -
            interface ShortcutGroup {
                enabled: boolean;
                items: Shortcut[];
                name: string;
            }

            Properties

            enabled +
            interface ShortcutGroup {
                enabled: boolean;
                items: Shortcut[];
                name: string;
            }

            Properties

            enabled items name -

            Properties

            enabled

            enabled: boolean

            items

            items: Shortcut[]

            name

            name: string

            Settings

            Member Visibility

            On This Page

            Properties
            +

            Properties

            enabled

            enabled: boolean

            items

            items: Shortcut[]

            name

            name: string

            Settings

            Member Visibility

            On This Page

            Properties
            diff --git a/types/_octra_annotation.AnnotationAnySegment.html b/types/_octra_annotation.AnnotationAnySegment.html index 1c9a9fa69..7094510f1 100644 --- a/types/_octra_annotation.AnnotationAnySegment.html +++ b/types/_octra_annotation.AnnotationAnySegment.html @@ -1 +1 @@ -AnnotationAnySegment | Octra libraries - v2.0.0

            Type AliasAnnotationAnySegment

            AnnotationAnySegment: OctraAnnotationSegment<ASRContext> | OItem | OctraAnnotationEvent

            Settings

            Member Visibility
            +AnnotationAnySegment | Octra libraries - v2.0.0

            Type AliasAnnotationAnySegment

            AnnotationAnySegment: OctraAnnotationSegment<ASRContext> | OItem | OctraAnnotationEvent

            Settings

            Member Visibility
            diff --git a/types/_octra_annotation.IAnyLevel.html b/types/_octra_annotation.IAnyLevel.html index f97b096d5..0b89a38e7 100644 --- a/types/_octra_annotation.IAnyLevel.html +++ b/types/_octra_annotation.IAnyLevel.html @@ -1 +1 @@ -IAnyLevel | Octra libraries - v2.0.0

            Type AliasIAnyLevel

            IAnyLevel: ISegmentLevel | IItemLevel | IEventLevel

            Settings

            Member Visibility
            +IAnyLevel | Octra libraries - v2.0.0

            Type AliasIAnyLevel

            IAnyLevel: ISegmentLevel | IItemLevel | IEventLevel

            Settings

            Member Visibility
            diff --git a/types/_octra_annotation.OAnyLevel.html b/types/_octra_annotation.OAnyLevel.html index 68fbf62b2..717f8bf13 100644 --- a/types/_octra_annotation.OAnyLevel.html +++ b/types/_octra_annotation.OAnyLevel.html @@ -1 +1 @@ -OAnyLevel | Octra libraries - v2.0.0

            Type AliasOAnyLevel<T>

            OAnyLevel<T>: OSegmentLevel<T> | OItemLevel | OEventLevel

            Type Parameters

            Settings

            Member Visibility
            +OAnyLevel | Octra libraries - v2.0.0

            Type AliasOAnyLevel<T>

            OAnyLevel<T>: OSegmentLevel<T> | OItemLevel | OEventLevel

            Type Parameters

            Settings

            Member Visibility
            diff --git a/types/_octra_annotation.OctraAnnotationAnyLevel.html b/types/_octra_annotation.OctraAnnotationAnyLevel.html index e232a72f9..15863f110 100644 --- a/types/_octra_annotation.OctraAnnotationAnyLevel.html +++ b/types/_octra_annotation.OctraAnnotationAnyLevel.html @@ -1 +1 @@ -OctraAnnotationAnyLevel | Octra libraries - v2.0.0

            Type AliasOctraAnnotationAnyLevel<T>

            OctraAnnotationAnyLevel<T>: OctraAnnotationSegmentLevel<T> | OctraAnnotationItemLevel | OctraAnnotationEventLevel

            Type Parameters

            Settings

            Member Visibility
            +OctraAnnotationAnyLevel | Octra libraries - v2.0.0

            Type AliasOctraAnnotationAnyLevel<T>

            OctraAnnotationAnyLevel<T>: OctraAnnotationSegmentLevel<T> | OctraAnnotationItemLevel | OctraAnnotationEventLevel

            Type Parameters

            Settings

            Member Visibility
            diff --git a/types/_octra_annotation.OctraAnnotationFormatType.html b/types/_octra_annotation.OctraAnnotationFormatType.html index 664e3d341..0d3d4e509 100644 --- a/types/_octra_annotation.OctraAnnotationFormatType.html +++ b/types/_octra_annotation.OctraAnnotationFormatType.html @@ -1 +1 @@ -OctraAnnotationFormatType | Octra libraries - v2.0.0

            Type AliasOctraAnnotationFormatType

            OctraAnnotationFormatType:
                | "AnnotJSON"
                | "BundleJSON"
                | "CTM"
                | "ELAN"
                | "BASPartitur"
                | "PraatTextTable"
                | "SRT"
                | "PlainText"
                | "TextGrid"
                | "WhisperJSON"
                | "WebVTT"

            Settings

            Member Visibility
            +OctraAnnotationFormatType | Octra libraries - v2.0.0

            Type AliasOctraAnnotationFormatType

            OctraAnnotationFormatType:
                | "AnnotJSON"
                | "BundleJSON"
                | "CTM"
                | "ELAN"
                | "BASPartitur"
                | "PraatTextTable"
                | "SRT"
                | "PlainText"
                | "TextGrid"
                | "WhisperJSON"
                | "WebVTT"

            Settings

            Member Visibility
            diff --git a/types/_octra_json_sets.JSONSetExpression.html b/types/_octra_json_sets.JSONSetExpression.html index 8c98a8a4d..8a37cf91f 100644 --- a/types/_octra_json_sets.JSONSetExpression.html +++ b/types/_octra_json_sets.JSONSetExpression.html @@ -1 +1 @@ -JSONSetExpression | Octra libraries - v2.0.0

            Type AliasJSONSetExpression<U>

            JSONSetExpression<U>: JSONSetStatement<U> | JSONSet<U>

            Type Parameters

            • U

            Settings

            Member Visibility
            +JSONSetExpression | Octra libraries - v2.0.0

            Type AliasJSONSetExpression<U>

            JSONSetExpression<U>: JSONSetStatement<U> | JSONSet<U>

            Type Parameters

            • U

            Settings

            Member Visibility
            diff --git a/types/_octra_web_media.IntArray.html b/types/_octra_web_media.IntArray.html index 970d76cdb..d02f82a28 100644 --- a/types/_octra_web_media.IntArray.html +++ b/types/_octra_web_media.IntArray.html @@ -1 +1 @@ -IntArray | Octra libraries - v2.0.0

            Type AliasIntArray

            IntArray: Uint8Array | Int16Array | Int32Array

            Settings

            Member Visibility
            +IntArray | Octra libraries - v2.0.0

            Type AliasIntArray

            IntArray: Uint8Array | Int16Array | Int32Array

            Settings

            Member Visibility
            diff --git a/variables/_octra_assets.IO_SETS.html b/variables/_octra_assets.IO_SETS.html index b12b197db..97d7b9701 100644 --- a/variables/_octra_assets.IO_SETS.html +++ b/variables/_octra_assets.IO_SETS.html @@ -1 +1 @@ -IO_SETS | Octra libraries - v2.0.0

            VariableIO_SETSConst

            IO_SETS: {
                inputs: {
                    combine: {
                        expressions: ({
                            description: string;
                            name: string;
                            select: string;
                            with: {
                                extension: string[];
                                mimeType: string[];
                                size: string;
                            }[];
                        } | {
                            description: string;
                            name: string;
                            select: string;
                            with: ({
                                content: string[];
                                extension: string[];
                                mimeType: string[];
                            } | {
                                content: string[];
                                extension: string[];
                                mimeType?: undefined;
                            })[];
                        })[];
                        type: string;
                    };
                    description: string;
                    name: string;
                };
                outputs: {
                    combine: {
                        expressions: {
                            description: string;
                            name: string;
                            select: string;
                            with: {
                                content: string;
                                extension: string[];
                                mimeType: string[];
                            };
                        }[];
                        type: string;
                    };
                    description: string;
                    name: string;
                };
            } = ...

            Settings

            Member Visibility
            +IO_SETS | Octra libraries - v2.0.0

            VariableIO_SETSConst

            IO_SETS: {
                inputs: {
                    combine: {
                        expressions: ({
                            description: string;
                            name: string;
                            select: string;
                            with: {
                                extension: string[];
                                mimeType: string[];
                                size: string;
                            }[];
                        } | {
                            description: string;
                            name: string;
                            select: string;
                            with: ({
                                content: string[];
                                extension: string[];
                                mimeType: string[];
                            } | {
                                content: string[];
                                extension: string[];
                                mimeType?: undefined;
                            })[];
                        })[];
                        type: string;
                    };
                    description: string;
                    name: string;
                };
                outputs: {
                    combine: {
                        expressions: {
                            description: string;
                            name: string;
                            select: string;
                            with: {
                                content: string;
                                extension: string[];
                                mimeType: string[];
                            };
                        }[];
                        type: string;
                    };
                    description: string;
                    name: string;
                };
            } = ...

            Settings

            Member Visibility
            diff --git a/variables/_octra_assets.OctraGuidelinesJSONSchema.html b/variables/_octra_assets.OctraGuidelinesJSONSchema.html index eaccf235e..ebb707dc5 100644 --- a/variables/_octra_assets.OctraGuidelinesJSONSchema.html +++ b/variables/_octra_assets.OctraGuidelinesJSONSchema.html @@ -1 +1 @@ -OctraGuidelinesJSONSchema | Octra libraries - v2.0.0

            VariableOctraGuidelinesJSONSchemaConst

            OctraGuidelinesJSONSchema: {
                properties: {
                    instructions: {
                        items: {
                            properties: {
                                entries: {
                                    items: {
                                        properties: {
                                            code: {
                                                type: string;
                                            };
                                            description: {
                                                type: string;
                                            };
                                            examples: {
                                                items: {
                                                    properties: {
                                                        annotation: ...;
                                                        url: ...;
                                                    };
                                                    type: string;
                                                };
                                                type: string;
                                            };
                                            priority: {
                                                type: string;
                                            };
                                            title: {
                                                type: string;
                                            };
                                        };
                                    };
                                    type: string;
                                };
                                group: {
                                    type: string;
                                };
                            };
                            type: string;
                        };
                        type: string;
                    };
                    markers: {
                        items: {
                            properties: {
                                button_text: {
                                    type: string;
                                };
                                code: {
                                    type: string;
                                };
                                description: {
                                    type: string;
                                };
                                icon: {
                                    type: string;
                                };
                                id: {
                                    type: string;
                                };
                                name: {
                                    type: string;
                                };
                                shortcut: {
                                    properties: {
                                        mac: {
                                            type: string;
                                        };
                                        pc: {
                                            type: string;
                                        };
                                    };
                                    type: string;
                                };
                                type: {
                                    type: string;
                                };
                            };
                            type: string;
                        };
                        type: string;
                    };
                    meta: {
                        properties: {
                            authors: {
                                type: string;
                            };
                            date: {
                                type: string;
                            };
                            encoding: {
                                type: string;
                            };
                            object_language: {
                                type: string;
                            };
                            project: {
                                type: string;
                            };
                            validation_url: {
                                type: string;
                            };
                            version: {
                                type: string;
                            };
                        };
                        required: string[];
                        type: string;
                    };
                };
                required: string[];
                type: string;
            } = ...

            Settings

            Member Visibility
            +OctraGuidelinesJSONSchema | Octra libraries - v2.0.0

            VariableOctraGuidelinesJSONSchemaConst

            OctraGuidelinesJSONSchema: {
                properties: {
                    instructions: {
                        items: {
                            properties: {
                                entries: {
                                    items: {
                                        properties: {
                                            code: {
                                                type: string;
                                            };
                                            description: {
                                                type: string;
                                            };
                                            examples: {
                                                items: {
                                                    properties: {
                                                        annotation: ...;
                                                        url: ...;
                                                    };
                                                    type: string;
                                                };
                                                type: string;
                                            };
                                            priority: {
                                                type: string;
                                            };
                                            title: {
                                                type: string;
                                            };
                                        };
                                    };
                                    type: string;
                                };
                                group: {
                                    type: string;
                                };
                            };
                            type: string;
                        };
                        type: string;
                    };
                    markers: {
                        items: {
                            properties: {
                                button_text: {
                                    type: string;
                                };
                                code: {
                                    type: string;
                                };
                                description: {
                                    type: string;
                                };
                                icon: {
                                    type: string;
                                };
                                id: {
                                    type: string;
                                };
                                name: {
                                    type: string;
                                };
                                shortcut: {
                                    properties: {
                                        mac: {
                                            type: string;
                                        };
                                        pc: {
                                            type: string;
                                        };
                                    };
                                    type: string;
                                };
                                type: {
                                    type: string;
                                };
                            };
                            type: string;
                        };
                        type: string;
                    };
                    meta: {
                        properties: {
                            authors: {
                                type: string;
                            };
                            date: {
                                type: string;
                            };
                            encoding: {
                                type: string;
                            };
                            object_language: {
                                type: string;
                            };
                            project: {
                                type: string;
                            };
                            validation_url: {
                                type: string;
                            };
                            version: {
                                type: string;
                            };
                        };
                        required: string[];
                        type: string;
                    };
                };
                required: string[];
                type: string;
            } = ...

            Settings

            Member Visibility
            diff --git a/variables/_octra_assets.OctraLoggingJSONSchema.html b/variables/_octra_assets.OctraLoggingJSONSchema.html index 5f76c686f..083dc7f29 100644 --- a/variables/_octra_assets.OctraLoggingJSONSchema.html +++ b/variables/_octra_assets.OctraLoggingJSONSchema.html @@ -1 +1 @@ -OctraLoggingJSONSchema | Octra libraries - v2.0.0

            VariableOctraLoggingJSONSchemaConst

            OctraLoggingJSONSchema: {
                properties: {
                    additionalProperties: boolean;
                    encoding: {
                        type: string;
                    };
                    logs: {
                        items: {
                            properties: {
                                caretpos: {
                                    type: string;
                                };
                                playpos: {
                                    type: string;
                                };
                                target: {
                                    type: string;
                                };
                                timestamp: {
                                    type: string;
                                };
                                type: {
                                    type: string;
                                };
                                value: {
                                    type: string[];
                                };
                            };
                            type: string;
                        };
                        type: string;
                    };
                    projectname: {
                        type: string;
                    };
                    version: {
                        type: string;
                    };
                };
            } = ...

            Settings

            Member Visibility
            +OctraLoggingJSONSchema | Octra libraries - v2.0.0

            VariableOctraLoggingJSONSchemaConst

            OctraLoggingJSONSchema: {
                properties: {
                    additionalProperties: boolean;
                    encoding: {
                        type: string;
                    };
                    logs: {
                        items: {
                            properties: {
                                caretpos: {
                                    type: string;
                                };
                                playpos: {
                                    type: string;
                                };
                                target: {
                                    type: string;
                                };
                                timestamp: {
                                    type: string;
                                };
                                type: {
                                    type: string;
                                };
                                value: {
                                    type: string[];
                                };
                            };
                            type: string;
                        };
                        type: string;
                    };
                    projectname: {
                        type: string;
                    };
                    version: {
                        type: string;
                    };
                };
            } = ...

            Settings

            Member Visibility
            diff --git a/variables/_octra_assets.OctraProjectConfigJSONSchema.html b/variables/_octra_assets.OctraProjectConfigJSONSchema.html index 31e04e6a1..4b6b0134b 100644 --- a/variables/_octra_assets.OctraProjectConfigJSONSchema.html +++ b/variables/_octra_assets.OctraProjectConfigJSONSchema.html @@ -1 +1 @@ -OctraProjectConfigJSONSchema | Octra libraries - v2.0.0

            VariableOctraProjectConfigJSONSchemaConst

            OctraProjectConfigJSONSchema: {
                $id: string;
                additionalProperties: boolean;
                properties: {
                    agreement: {
                        properties: {
                            enabled: {
                                type: string;
                            };
                            text: {
                                type: string;
                            };
                        };
                        type: string;
                    };
                    feedback_form: {
                        items: {
                            properties: {
                                controls: {
                                    items: {
                                        properties: {
                                            custom: {
                                                type: string;
                                            };
                                            label: {
                                                type: string;
                                            };
                                            name: {
                                                type: string;
                                            };
                                            required: {
                                                type: string;
                                            };
                                            type: {
                                                type: string;
                                            };
                                            value: {
                                                type: string;
                                            };
                                        };
                                        type: string;
                                    };
                                    type: string;
                                };
                                title: {
                                    type: string;
                                };
                            };
                            type: string;
                        };
                        type: string;
                    };
                    interfaces: {
                        items: {
                            type: string;
                        };
                        type: string;
                    };
                    languages: {
                        items: {
                            type: string;
                        };
                        type: string;
                    };
                    navigation: {
                        properties: {
                            export: {
                                type: string;
                            };
                            help_url: {
                                type: string;
                            };
                            interfaces: {
                                type: string;
                            };
                        };
                        type: string;
                    };
                    octra: {
                        properties: {
                            allowed_browsers: {
                                items: {
                                    properties: {
                                        name: {
                                            type: string;
                                        };
                                        version: {
                                            type: string;
                                        };
                                    };
                                    type: string;
                                };
                                type: string;
                            };
                            bugreport: {
                                properties: {
                                    auth_token: {
                                        type: string;
                                    };
                                    enabled: {
                                        type: string;
                                    };
                                    name: {
                                        type: string;
                                    };
                                    url: {
                                        type: string;
                                    };
                                };
                                type: string;
                            };
                            languages: {
                                items: {
                                    type: string;
                                };
                                type: string;
                            };
                            login: {
                                properties: {
                                    enabled: {
                                        type: string;
                                    };
                                };
                                type: string;
                            };
                            responsive: {
                                $id: string;
                                properties: {
                                    enabled: {
                                        type: string;
                                    };
                                    fixedwidth: {
                                        type: string;
                                    };
                                };
                                type: string;
                            };
                            showdetails: {
                                type: string;
                            };
                            tools: {
                                items: {
                                    enum: string[];
                                    type: string;
                                };
                                type: string;
                            };
                        };
                        type: string;
                    };
                    plugins: {
                        type: string;
                    };
                    responsive: {
                        properties: {
                            enabled: {
                                type: string;
                            };
                            fixedwidth: {
                                type: string;
                            };
                        };
                        type: string;
                    };
                    version: {
                        readOnly: boolean;
                        type: string;
                    };
                };
                required: string[];
                type: string;
            } = ...

            Settings

            Member Visibility
            +OctraProjectConfigJSONSchema | Octra libraries - v2.0.0

            VariableOctraProjectConfigJSONSchemaConst

            OctraProjectConfigJSONSchema: {
                $id: string;
                additionalProperties: boolean;
                properties: {
                    agreement: {
                        properties: {
                            enabled: {
                                type: string;
                            };
                            text: {
                                type: string;
                            };
                        };
                        type: string;
                    };
                    feedback_form: {
                        items: {
                            properties: {
                                controls: {
                                    items: {
                                        properties: {
                                            custom: {
                                                type: string;
                                            };
                                            label: {
                                                type: string;
                                            };
                                            name: {
                                                type: string;
                                            };
                                            required: {
                                                type: string;
                                            };
                                            type: {
                                                type: string;
                                            };
                                            value: {
                                                type: string;
                                            };
                                        };
                                        type: string;
                                    };
                                    type: string;
                                };
                                title: {
                                    type: string;
                                };
                            };
                            type: string;
                        };
                        type: string;
                    };
                    interfaces: {
                        items: {
                            type: string;
                        };
                        type: string;
                    };
                    languages: {
                        items: {
                            type: string;
                        };
                        type: string;
                    };
                    navigation: {
                        properties: {
                            export: {
                                type: string;
                            };
                            help_url: {
                                type: string;
                            };
                            interfaces: {
                                type: string;
                            };
                        };
                        type: string;
                    };
                    octra: {
                        properties: {
                            allowed_browsers: {
                                items: {
                                    properties: {
                                        name: {
                                            type: string;
                                        };
                                        version: {
                                            type: string;
                                        };
                                    };
                                    type: string;
                                };
                                type: string;
                            };
                            bugreport: {
                                properties: {
                                    auth_token: {
                                        type: string;
                                    };
                                    enabled: {
                                        type: string;
                                    };
                                    name: {
                                        type: string;
                                    };
                                    url: {
                                        type: string;
                                    };
                                };
                                type: string;
                            };
                            languages: {
                                items: {
                                    type: string;
                                };
                                type: string;
                            };
                            login: {
                                properties: {
                                    enabled: {
                                        type: string;
                                    };
                                };
                                type: string;
                            };
                            responsive: {
                                $id: string;
                                properties: {
                                    enabled: {
                                        type: string;
                                    };
                                    fixedwidth: {
                                        type: string;
                                    };
                                };
                                type: string;
                            };
                            showdetails: {
                                type: string;
                            };
                            tools: {
                                items: {
                                    enum: string[];
                                    type: string;
                                };
                                type: string;
                            };
                        };
                        type: string;
                    };
                    plugins: {
                        type: string;
                    };
                    responsive: {
                        properties: {
                            enabled: {
                                type: string;
                            };
                            fixedwidth: {
                                type: string;
                            };
                        };
                        type: string;
                    };
                    version: {
                        readOnly: boolean;
                        type: string;
                    };
                };
                required: string[];
                type: string;
            } = ...

            Settings

            Member Visibility