diff --git a/classes/_octra_annotation.AnnotJSONConverter.html b/classes/_octra_annotation.AnnotJSONConverter.html index b6d764fb3..0953d5fb6 100644 --- a/classes/_octra_annotation.AnnotJSONConverter.html +++ b/classes/_octra_annotation.AnnotJSONConverter.html @@ -1,4 +1,4 @@ -AnnotJSONConverter | Octra libraries - v2.0.0

Class AnnotJSONConverter

Hierarchy (view full)

Constructors

constructor +AnnotJSONConverter | Octra libraries - v2.0.0

Class AnnotJSONConverter

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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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

Returns ImportResult

needsOptionsForImport

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
\ No newline at end of file diff --git a/classes/_octra_annotation.BundleJSONConverter.html b/classes/_octra_annotation.BundleJSONConverter.html index ecbb36a96..16789a6ab 100644 --- a/classes/_octra_annotation.BundleJSONConverter.html +++ b/classes/_octra_annotation.BundleJSONConverter.html @@ -1,4 +1,4 @@ -BundleJSONConverter | Octra libraries - v2.0.0

Class BundleJSONConverter

Hierarchy (view full)

Constructors

constructor +BundleJSONConverter | Octra libraries - v2.0.0

Class BundleJSONConverter

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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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

Returns ImportResult

needsOptionsForImport

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
\ No newline at end of file diff --git a/classes/_octra_annotation.CTMConverter.html b/classes/_octra_annotation.CTMConverter.html index a61ac85aa..d1f21acd1 100644 --- a/classes/_octra_annotation.CTMConverter.html +++ b/classes/_octra_annotation.CTMConverter.html @@ -1,4 +1,4 @@ -CTMConverter | Octra libraries - v2.0.0

Class CTMConverter

Hierarchy (view full)

Constructors

constructor +CTMConverter | Octra libraries - v2.0.0

Class CTMConverter

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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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

Returns ImportResult

needsOptionsForImport

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
\ No newline at end of file diff --git a/classes/_octra_annotation.Converter.html b/classes/_octra_annotation.Converter.html index 5f7c75bbc..9b13240c4 100644 --- a/classes/_octra_annotation.Converter.html +++ b/classes/_octra_annotation.Converter.html @@ -1,4 +1,4 @@ -Converter | Octra libraries - v2.0.0

Class ConverterAbstract

Hierarchy (view full)

Constructors

constructor +Converter | Octra libraries - v2.0.0

Class ConverterAbstract

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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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

Abstract 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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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

Abstract export

  • 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

    • Optional levelnum: number

      the level number for export returns resulted file or error.

      -

    Returns ExportResult

Abstract 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

Abstract import

Abstract needsOptionsForImport

Returns ImportResult

Abstract needsOptionsForImport

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
\ No newline at end of file diff --git a/classes/_octra_annotation.ELANConverter.html b/classes/_octra_annotation.ELANConverter.html index f6ffb09d8..17bdc06f4 100644 --- a/classes/_octra_annotation.ELANConverter.html +++ b/classes/_octra_annotation.ELANConverter.html @@ -1,4 +1,4 @@ -ELANConverter | Octra libraries - v2.0.0

Class ELANConverter

Hierarchy (view full)

Constructors

constructor +ELANConverter | Octra libraries - v2.0.0

Class ELANConverter

Hierarchy (view full)

Constructors

constructor

Properties

_application _conversion _encoding @@ -21,14 +21,14 @@ getSamplesFromTimeSlot import needsOptionsForImport -

Constructors

constructor

Properties

Protected _application

_application: string = ''

Protected _conversion

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

Type declaration

  • 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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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;
} = ...

Type declaration

  • 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

Private getSamplesFromTimeSlot

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

Private getSamplesFromTimeSlot

import

needsOptionsForImport

Returns ImportResult

needsOptionsForImport

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportgetSamplesFromTimeSlotimportneedsOptionsForImport
\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

On This Page

constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportgetSamplesFromTimeSlotimportneedsOptionsForImport
\ No newline at end of file diff --git a/classes/_octra_annotation.Link.html b/classes/_octra_annotation.Link.html index 8f7b89976..7fb72de97 100644 --- a/classes/_octra_annotation.Link.html +++ b/classes/_octra_annotation.Link.html @@ -1,4 +1,4 @@ -Link | Octra libraries - v2.0.0

Class Link

Implements

Constructors

constructor +Link | Octra libraries - v2.0.0

Class Link

Implements

Constructors

constructor

Properties

fromID toID -

Constructors

constructor

Properties

fromID

fromID: number

toID

toID: number

Settings

Member Visibility

Theme

On This Page

constructorfromIDtoID
\ No newline at end of file +

Constructors

constructor

Properties

fromID

fromID: number

toID

toID: number

Settings

Member Visibility

Theme

On This Page

constructorfromIDtoID
\ No newline at end of file diff --git a/classes/_octra_annotation.OAnnotJSON.html b/classes/_octra_annotation.OAnnotJSON.html index 440e5e517..5550686cc 100644 --- a/classes/_octra_annotation.OAnnotJSON.html +++ b/classes/_octra_annotation.OAnnotJSON.html @@ -1,4 +1,4 @@ -OAnnotJSON | Octra libraries - v2.0.0

Class OAnnotJSON

Implements

Constructors

constructor +OAnnotJSON | Octra libraries - v2.0.0

Class OAnnotJSON

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
    • Optional levels: ILevel[]
    • Optional links: 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

Static deserialize

Settings

Member Visibility

Theme

On This Page

constructorannotateslevelslinksnamesampleRatemaxItemIDmaxLevelIDdeserializeserializedeserialize
\ No newline at end of file +
  • sampleRate: number
  • Optional levels: ILevel[]
  • Optional links: 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

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructorannotateslevelslinksnamesampleRatemaxItemIDmaxLevelIDdeserializeserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OEvent.html b/classes/_octra_annotation.OEvent.html index 0e52f4bf0..44d13804d 100644 --- a/classes/_octra_annotation.OEvent.html +++ b/classes/_octra_annotation.OEvent.html @@ -1,4 +1,4 @@ -OEvent | Octra libraries - v2.0.0

    Class OEvent

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OEvent | Octra libraries - v2.0.0

    Class OEvent

    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

    Readonly type

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

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridlabelssamplePointtypeclonedeserializegetFirstLabelWithoutNameisEqualWithserializedeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    id

    id: number = 0

    labels

    labels: OLabel[]

    samplePoint

    samplePoint: number

    Readonly type

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

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridlabelssamplePointtypeclonedeserializegetFirstLabelWithoutNameisEqualWithserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OEventLevel.html b/classes/_octra_annotation.OEventLevel.html index 644fb9ee2..e39cdac4f 100644 --- a/classes/_octra_annotation.OEventLevel.html +++ b/classes/_octra_annotation.OEventLevel.html @@ -1,4 +1,4 @@ -OEventLevel | Octra libraries - v2.0.0

    Class OEventLevel

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OEventLevel | Octra libraries - v2.0.0

    Class OEventLevel

    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

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoritemsnametypeclonedeserializegetLeftSiblinggetRightSiblingserializedeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    items

    items: OEvent[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    deserialize

    getLeftSibling

    getRightSibling

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoritemsnametypeclonedeserializegetLeftSiblinggetRightSiblingserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OItem.html b/classes/_octra_annotation.OItem.html index a60666e35..21788184e 100644 --- a/classes/_octra_annotation.OItem.html +++ b/classes/_octra_annotation.OItem.html @@ -1,4 +1,4 @@ -OItem | Octra libraries - v2.0.0

    Class OItem

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OItem | Octra libraries - v2.0.0

    Class OItem

    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[]

    Readonly type

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

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridlabelstypeclonedeserializegetFirstLabelWithoutNameisEqualWithserializedeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    id

    id: number = 0

    labels

    labels: OLabel[]

    Readonly type

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

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridlabelstypeclonedeserializegetFirstLabelWithoutNameisEqualWithserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OItemLevel.html b/classes/_octra_annotation.OItemLevel.html index ebadf1d1e..bfa431ab6 100644 --- a/classes/_octra_annotation.OItemLevel.html +++ b/classes/_octra_annotation.OItemLevel.html @@ -1,4 +1,4 @@ -OItemLevel | Octra libraries - v2.0.0

    Class OItemLevel

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OItemLevel | Octra libraries - v2.0.0

    Class OItemLevel

    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

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoritemsnametypeclonedeserializegetLeftSiblinggetRightSiblingserializedeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    items

    items: OItem[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    deserialize

    getLeftSibling

    getRightSibling

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoritemsnametypeclonedeserializegetLeftSiblinggetRightSiblingserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OLabel.html b/classes/_octra_annotation.OLabel.html index 5705ec9b7..35eb5f7ed 100644 --- a/classes/_octra_annotation.OLabel.html +++ b/classes/_octra_annotation.OLabel.html @@ -1,7 +1,7 @@ -OLabel | Octra libraries - v2.0.0

    Class OLabel

    Implements

    Constructors

    constructor +OLabel | Octra libraries - v2.0.0

    Class OLabel

    Implements

    Constructors

    constructor

    Properties

    name value

    Methods

    deserialize serialize deserialize -

    Constructors

    constructor

    Properties

    name

    name: string = ''

    value

    value: string = ''

    Methods

    deserialize

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructornamevaluedeserializeserializedeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    name

    name: string = ''

    value

    value: string = ''

    Methods

    deserialize

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructornamevaluedeserializeserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OLevel.html b/classes/_octra_annotation.OLevel.html index 60dff5a2c..20a7b815e 100644 --- a/classes/_octra_annotation.OLevel.html +++ b/classes/_octra_annotation.OLevel.html @@ -1,8 +1,8 @@ -OLevel | Octra libraries - v2.0.0

    Class OLevel<T>

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OLevel | Octra libraries - v2.0.0

    Class OLevel<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

    Theme

    On This Page

    constructoritemsnametypeclonegetLeftSiblinggetRightSibling
    \ No newline at end of file +

    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

    Theme

    On This Page

    constructoritemsnametypeclonegetLeftSiblinggetRightSibling
    \ No newline at end of file diff --git a/classes/_octra_annotation.OLink.html b/classes/_octra_annotation.OLink.html index 06efda6fb..6553745ba 100644 --- a/classes/_octra_annotation.OLink.html +++ b/classes/_octra_annotation.OLink.html @@ -1,8 +1,8 @@ -OLink | Octra libraries - v2.0.0

    Class OLink

    Implements

    Constructors

    constructor +OLink | Octra libraries - v2.0.0

    Class OLink

    Implements

    Constructors

    constructor

    Properties

    fromID toID

    Methods

    clone deserialize serialize deserialize -

    Constructors

    constructor

    Properties

    fromID

    fromID: number

    toID

    toID: number

    Methods

    clone

    deserialize

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructorfromIDtoIDclonedeserializeserializedeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    fromID

    fromID: number

    toID

    toID: number

    Methods

    clone

    deserialize

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructorfromIDtoIDclonedeserializeserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OSegment.html b/classes/_octra_annotation.OSegment.html index e45fb8b9f..139453fc1 100644 --- a/classes/_octra_annotation.OSegment.html +++ b/classes/_octra_annotation.OSegment.html @@ -1,4 +1,4 @@ -OSegment | Octra libraries - v2.0.0

    Class OSegment

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OSegment | Octra libraries - v2.0.0

    Class OSegment

    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

    Readonly type

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

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridlabelssampleDursampleStarttypeclonedeserializegetFirstLabelWithoutNameisEqualWithserializedeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    id

    id: number = 0

    labels

    labels: OLabel[]

    sampleDur

    sampleDur: number = 0

    sampleStart

    sampleStart: number = 0

    Readonly type

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

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridlabelssampleDursampleStarttypeclonedeserializegetFirstLabelWithoutNameisEqualWithserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OSegmentLevel.html b/classes/_octra_annotation.OSegmentLevel.html index c38070b44..80d748502 100644 --- a/classes/_octra_annotation.OSegmentLevel.html +++ b/classes/_octra_annotation.OSegmentLevel.html @@ -1,4 +1,4 @@ -OSegmentLevel | Octra libraries - v2.0.0

    Class OSegmentLevel<T>

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor +OSegmentLevel | Octra libraries - v2.0.0

    Class OSegmentLevel<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

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoritemsnametypeclonedeserializegetLeftSiblinggetRightSiblingserializedeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    items

    items: T[]

    name

    name: string = ''

    type

    type: AnnotationLevelType

    Methods

    clone

    deserialize

    getLeftSibling

    getRightSibling

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoritemsnametypeclonedeserializegetLeftSiblinggetRightSiblingserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OctraAnnotation.html b/classes/_octra_annotation.OctraAnnotation.html index e5ef9ddf1..ec34952ab 100644 --- a/classes/_octra_annotation.OctraAnnotation.html +++ b/classes/_octra_annotation.OctraAnnotation.html @@ -1,4 +1,4 @@ -OctraAnnotation | Octra libraries - v2.0.0

    Class OctraAnnotation<S, T>

    Type Parameters

    Constructors

    constructor +OctraAnnotation | Octra libraries - v2.0.0

    Class OctraAnnotation<S, T>

    Type Parameters

    Constructors

    constructor

    Properties

    _idCounters _levels _links @@ -41,4 +41,4 @@ sortSegmentsBySampleUnit updateIDCounters deserialize -

    Constructors

    constructor

    Properties

    Private _idCounters

    _idCounters: {
        item: number;
        level: number;
        link: number;
    } = ...

    Type declaration

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

    Private _levels

    _levels: OctraAnnotationAnyLevel<T>[] = []

    Private _links

    _links: OctraAnnotationLink[] = []

    Private Optional _selectedLevelIndex

    _selectedLevelIndex?: number

    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

    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

    Private sortEventsBySampleUnit

    Private sortSegmentsBySampleUnit

    updateIDCounters

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_idCounters_levels_links_selectedLevelIndexcurrentLevelidCounterslevelslinksselectedLevelIndexaddItemToCurrentLeveladdLeveladdLinkchangeCurrentItemByIdchangeCurrentItemByIndexchangeCurrentLevelIndexchangeCurrentSegmentBySamplePositionchangeLevelByIdchangeLevelByIndexchangeLevelIndexchangeLevelNameByIndexchangeLinkByIdchangeLinkByIndexchangeSampleRateclearAllItemsFromCurrentLevelclonecombineSegmentscreateEventLevelcreateItemLevelcreateSegmentcreateSegmentLeveldeserializeduplicateLevelgetCurrentSegmentIndexBySamplePositiongetItemByIdremoveItemByIdremoveItemByIndexremoveLevelserializesortEventsBySampleUnitsortSegmentsBySampleUnitupdateIDCountersdeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private _idCounters

    _idCounters: {
        item: number;
        level: number;
        link: number;
    } = ...

    Type declaration

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

    Private _levels

    _levels: OctraAnnotationAnyLevel<T>[] = []

    Private _links

    _links: OctraAnnotationLink[] = []

    Private Optional _selectedLevelIndex

    _selectedLevelIndex?: number

    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

    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

    Private sortEventsBySampleUnit

    Private sortSegmentsBySampleUnit

    updateIDCounters

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_idCounters_levels_links_selectedLevelIndexcurrentLevelidCounterslevelslinksselectedLevelIndexaddItemToCurrentLeveladdLeveladdLinkchangeCurrentItemByIdchangeCurrentItemByIndexchangeCurrentLevelIndexchangeCurrentSegmentBySamplePositionchangeLevelByIdchangeLevelByIndexchangeLevelIndexchangeLevelNameByIndexchangeLinkByIdchangeLinkByIndexchangeSampleRateclearAllItemsFromCurrentLevelclonecombineSegmentscreateEventLevelcreateItemLevelcreateSegmentcreateSegmentLeveldeserializeduplicateLevelgetCurrentSegmentIndexBySamplePositiongetItemByIdremoveItemByIdremoveItemByIndexremoveLevelserializesortEventsBySampleUnitsortSegmentsBySampleUnitupdateIDCountersdeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OctraAnnotationEvent.html b/classes/_octra_annotation.OctraAnnotationEvent.html index 2f6292d77..1145c282d 100644 --- a/classes/_octra_annotation.OctraAnnotationEvent.html +++ b/classes/_octra_annotation.OctraAnnotationEvent.html @@ -1,4 +1,4 @@ -OctraAnnotationEvent | Octra libraries - v2.0.0

    Class OctraAnnotationEvent

    Implements

    Constructors

    constructor +OctraAnnotationEvent | Octra libraries - v2.0.0

    Class OctraAnnotationEvent

    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

    Readonly type

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

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridlabelssamplePointtypeclonedeserializegetFirstLabelWithoutNameisEqualWithserializedeserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    id

    id: number

    labels

    labels: OLabel[] = []

    samplePoint

    samplePoint: SampleUnit

    Readonly type

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

    Methods

    clone

    deserialize

    getFirstLabelWithoutName

    isEqualWith

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridlabelssamplePointtypeclonedeserializegetFirstLabelWithoutNameisEqualWithserializedeserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OctraAnnotationEventLevel.html b/classes/_octra_annotation.OctraAnnotationEventLevel.html index 691fe69c8..6a3b36c12 100644 --- a/classes/_octra_annotation.OctraAnnotationEventLevel.html +++ b/classes/_octra_annotation.OctraAnnotationEventLevel.html @@ -1,4 +1,4 @@ -OctraAnnotationEventLevel | Octra libraries - v2.0.0

    Class OctraAnnotationEventLevel

    Constructors

    constructor +OctraAnnotationEventLevel | Octra libraries - v2.0.0

    Class OctraAnnotationEventLevel

    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

    Theme

    On This Page

    constructoriditemsnametypechangeItemclearcloneduplicategetLeftSiblinggetRightSiblingoverwriteItemsserialize
    \ No newline at end of file +

    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

    Theme

    On This Page

    constructoriditemsnametypechangeItemclearcloneduplicategetLeftSiblinggetRightSiblingoverwriteItemsserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OctraAnnotationItemLevel.html b/classes/_octra_annotation.OctraAnnotationItemLevel.html index 96fb1eb28..023abc6a8 100644 --- a/classes/_octra_annotation.OctraAnnotationItemLevel.html +++ b/classes/_octra_annotation.OctraAnnotationItemLevel.html @@ -1,4 +1,4 @@ -OctraAnnotationItemLevel | Octra libraries - v2.0.0

    Class OctraAnnotationItemLevel

    Hierarchy (view full)

    Constructors

    constructor +OctraAnnotationItemLevel | Octra libraries - v2.0.0

    Class OctraAnnotationItemLevel

    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

    items

    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

    Theme

    On This Page

    constructor_idleveliditemsnamesortordertypechangeItemclearcloneduplicategetLeftSiblinggetRightSiblingoverwriteItemsserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected _id

    _id: number

    level

    level: OItemLevel

    Accessors

    id

    items

    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

    Theme

    On This Page

    constructor_idleveliditemsnamesortordertypechangeItemclearcloneduplicategetLeftSiblinggetRightSiblingoverwriteItemsserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OctraAnnotationLevel.html b/classes/_octra_annotation.OctraAnnotationLevel.html index dd30f6313..b89ff4f4c 100644 --- a/classes/_octra_annotation.OctraAnnotationLevel.html +++ b/classes/_octra_annotation.OctraAnnotationLevel.html @@ -1,4 +1,4 @@ -OctraAnnotationLevel | Octra libraries - v2.0.0

    Class OctraAnnotationLevel<T, S>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +OctraAnnotationLevel | Octra libraries - v2.0.0

    Class OctraAnnotationLevel<T, S>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _id _sortorder level @@ -14,4 +14,4 @@ getRightSibling overwriteItems serialize -

    Constructors

    constructor

    Properties

    Protected _id

    _id: number

    Private _sortorder

    _sortorder: number = 0

    level

    level: T

    Accessors

    id

    items

    name

    sortorder

    type

    Methods

    changeItem

    clear

    duplicate

    getLeftSibling

    getRightSibling

    overwriteItems

    serialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_id_sortorderleveliditemsnamesortordertypechangeItemclearduplicategetLeftSiblinggetRightSiblingoverwriteItemsserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected _id

    _id: number

    Private _sortorder

    _sortorder: number = 0

    level

    level: T

    Accessors

    id

    items

    name

    sortorder

    type

    Methods

    changeItem

    clear

    duplicate

    getLeftSibling

    getRightSibling

    overwriteItems

    serialize

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_id_sortorderleveliditemsnamesortordertypechangeItemclearduplicategetLeftSiblinggetRightSiblingoverwriteItemsserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.OctraAnnotationLink.html b/classes/_octra_annotation.OctraAnnotationLink.html index c16250c38..64865b2e3 100644 --- a/classes/_octra_annotation.OctraAnnotationLink.html +++ b/classes/_octra_annotation.OctraAnnotationLink.html @@ -1,7 +1,7 @@ -OctraAnnotationLink | Octra libraries - v2.0.0

    Class OctraAnnotationLink

    Constructors

    constructor +OctraAnnotationLink | Octra libraries - v2.0.0

    Class OctraAnnotationLink

    Constructors

    constructor

    Properties

    _id _link

    Accessors

    id link

    Methods

    clone -

    Constructors

    constructor

    Properties

    Private _id

    _id: number

    Private _link

    _link: OLink

    Accessors

    id

    link

    Methods

    clone

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_id_linkidlinkclone
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private _id

    _id: number

    Private _link

    _link: OLink

    Accessors

    id

    link

    Methods

    clone

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_id_linkidlinkclone
    \ No newline at end of file diff --git a/classes/_octra_annotation.OctraAnnotationSegment.html b/classes/_octra_annotation.OctraAnnotationSegment.html index 96e0bda6c..8f0430fd1 100644 --- a/classes/_octra_annotation.OctraAnnotationSegment.html +++ b/classes/_octra_annotation.OctraAnnotationSegment.html @@ -1,4 +1,4 @@ -OctraAnnotationSegment | Octra libraries - v2.0.0

    Class OctraAnnotationSegment<T>

    Type Parameters

    Implements

    Constructors

    constructor +OctraAnnotationSegment | Octra libraries - v2.0.0

    Class OctraAnnotationSegment<T>

    Type Parameters

    Implements

    Constructors

    constructor

    Properties

    _id context? labels @@ -16,4 +16,4 @@ serializeToOSegment deserialize deserializeFromOSegment -

    Constructors

    constructor

    Properties

    Private _id

    _id: number

    Optional context

    context?: T

    labels

    labels: OLabel[]

    time

    time: SampleUnit

    Readonly type

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

    Accessors

    id

    Methods

    changeFirstLabelWithoutName

    changeLabel

    clone

    deserialize

    getFirstLabelWithoutName

    getLabel

    isEqualWith

    serialize

    serializeToOSegment

    Static deserialize

    Static deserializeFromOSegment

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_idcontextlabelstimetypeidchangeFirstLabelWithoutNamechangeLabelclonedeserializegetFirstLabelWithoutNamegetLabelisEqualWithserializeserializeToOSegmentdeserializedeserializeFromOSegment
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private _id

    _id: number

    Optional context

    context?: T

    labels

    labels: OLabel[]

    time

    time: SampleUnit

    Readonly type

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

    Accessors

    id

    Methods

    changeFirstLabelWithoutName

    changeLabel

    clone

    deserialize

    getFirstLabelWithoutName

    getLabel

    isEqualWith

    serialize

    serializeToOSegment

    Static deserialize

    Static deserializeFromOSegment

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_idcontextlabelstimetypeidchangeFirstLabelWithoutNamechangeLabelclonedeserializegetFirstLabelWithoutNamegetLabelisEqualWithserializeserializeToOSegmentdeserializedeserializeFromOSegment
    \ No newline at end of file diff --git a/classes/_octra_annotation.OctraAnnotationSegmentLevel.html b/classes/_octra_annotation.OctraAnnotationSegmentLevel.html index 7e097766c..8b66d4ed2 100644 --- a/classes/_octra_annotation.OctraAnnotationSegmentLevel.html +++ b/classes/_octra_annotation.OctraAnnotationSegmentLevel.html @@ -1,4 +1,4 @@ -OctraAnnotationSegmentLevel | Octra libraries - v2.0.0

    Class OctraAnnotationSegmentLevel<T>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +OctraAnnotationSegmentLevel | Octra libraries - v2.0.0

    Class OctraAnnotationSegmentLevel<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

    items

    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

    Theme

    On This Page

    constructor_idleveliditemsnamesortordertypechangeItemclearcloneduplicategetLeftSiblinggetRightSiblingoverwriteItemsserialize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected _id

    _id: number

    level

    level: OLevel<T>

    Accessors

    id

    items

    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

    Theme

    On This Page

    constructor_idleveliditemsnamesortordertypechangeItemclearcloneduplicategetLeftSiblinggetRightSiblingoverwriteItemsserialize
    \ No newline at end of file diff --git a/classes/_octra_annotation.PartiturConverter.html b/classes/_octra_annotation.PartiturConverter.html index 3ecb24edd..096d4c091 100644 --- a/classes/_octra_annotation.PartiturConverter.html +++ b/classes/_octra_annotation.PartiturConverter.html @@ -1,4 +1,4 @@ -PartiturConverter | Octra libraries - v2.0.0

    Class PartiturConverter

    Hierarchy (view full)

    Constructors

    constructor +PartiturConverter | Octra libraries - v2.0.0

    Class PartiturConverter

    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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
    \ No newline at end of file +

    Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
    \ No newline at end of file diff --git a/classes/_octra_annotation.PraatTableConverter.html b/classes/_octra_annotation.PraatTableConverter.html index 9105a317c..1391dd561 100644 --- a/classes/_octra_annotation.PraatTableConverter.html +++ b/classes/_octra_annotation.PraatTableConverter.html @@ -1,4 +1,4 @@ -PraatTableConverter | Octra libraries - v2.0.0

    Class PraatTableConverter

    Hierarchy (view full)

    Constructors

    constructor +PraatTableConverter | Octra libraries - v2.0.0

    Class PraatTableConverter

    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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
    \ No newline at end of file +

    Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
    \ No newline at end of file diff --git a/classes/_octra_annotation.PraatTextgridConverter.html b/classes/_octra_annotation.PraatTextgridConverter.html index 5e175a521..eb5e821c8 100644 --- a/classes/_octra_annotation.PraatTextgridConverter.html +++ b/classes/_octra_annotation.PraatTextgridConverter.html @@ -1,4 +1,4 @@ -PraatTextgridConverter | Octra libraries - v2.0.0

    Class PraatTextgridConverter

    Hierarchy (view full)

    Constructors

    constructor +PraatTextgridConverter | Octra libraries - v2.0.0

    Class PraatTextgridConverter

    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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
    \ No newline at end of file +

    Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportimportneedsOptionsForImport
    \ No newline at end of file diff --git a/classes/_octra_annotation.SRTConverter.html b/classes/_octra_annotation.SRTConverter.html index 67b2d4b8a..8d1dd6139 100644 --- a/classes/_octra_annotation.SRTConverter.html +++ b/classes/_octra_annotation.SRTConverter.html @@ -1,4 +1,4 @@ -SRTConverter | Octra libraries - v2.0.0

    Class SRTConverter

    Hierarchy (view full)

    Constructors

    constructor +SRTConverter | Octra libraries - v2.0.0

    Class SRTConverter

    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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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

    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

    import

    needsOptionsForImport

    Returns ImportResult

    needsOptionsForImport

    Static getSamplesFromTimeString

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportformatNumbergetTimeStringFromSamplesimportneedsOptionsForImportgetSamplesFromTimeString
    \ No newline at end of file +

    Returns any

    Static getSamplesFromTimeString

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportformatNumbergetTimeStringFromSamplesimportneedsOptionsForImportgetSamplesFromTimeString
    \ No newline at end of file diff --git a/classes/_octra_annotation.SRTConverterImportOptions.html b/classes/_octra_annotation.SRTConverterImportOptions.html index 372de1cd8..c7c11b57d 100644 --- a/classes/_octra_annotation.SRTConverterImportOptions.html +++ b/classes/_octra_annotation.SRTConverterImportOptions.html @@ -1,5 +1,5 @@ -SRTConverterImportOptions | Octra libraries - v2.0.0

    Class SRTConverterImportOptions

    Constructors

    constructor +SRTConverterImportOptions | Octra libraries - v2.0.0

    Class SRTConverterImportOptions

    Constructors

    constructor

    Properties

    combineSegmentsWithSameSpeakerThreshold? sortSpeakerSegments speakerIdentifierPattern? -

    Constructors

    constructor

    Properties

    Optional combineSegmentsWithSameSpeakerThreshold

    combineSegmentsWithSameSpeakerThreshold?: number

    sortSpeakerSegments

    sortSpeakerSegments: boolean = false

    Optional speakerIdentifierPattern

    speakerIdentifierPattern?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcombineSegmentsWithSameSpeakerThresholdsortSpeakerSegmentsspeakerIdentifierPattern
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional combineSegmentsWithSameSpeakerThreshold

    combineSegmentsWithSameSpeakerThreshold?: number

    sortSpeakerSegments

    sortSpeakerSegments: boolean = false

    Optional speakerIdentifierPattern

    speakerIdentifierPattern?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcombineSegmentsWithSameSpeakerThresholdsortSpeakerSegmentsspeakerIdentifierPattern
    \ No newline at end of file diff --git a/classes/_octra_annotation.TextConverter.html b/classes/_octra_annotation.TextConverter.html index 2e77370b0..c1c69293a 100644 --- a/classes/_octra_annotation.TextConverter.html +++ b/classes/_octra_annotation.TextConverter.html @@ -1,4 +1,4 @@ -TextConverter | Octra libraries - v2.0.0

    Class TextConverter

    Hierarchy (view full)

    Constructors

    constructor +TextConverter | Octra libraries - v2.0.0

    Class TextConverter

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _application _conversion _encoding @@ -28,18 +28,18 @@ import needsOptionsForImport timeStringToSamples -

    Constructors

    constructor

    Properties

    Protected _application

    _application: string = ''

    Protected _conversion

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

    Type declaration

    • 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;
    } = ...

    Type declaration

    • title: string
    • url: string

    defaultImportOptions

    defaultImportOptions: any

    options

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

    Type declaration

    • 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

    Private cleanTranscript

    convertToTimeString

    • convertToTimeString(value, args?): string

    • transforms milliseconds to time string

      +

    Constructors

    constructor

    Properties

    Protected _application

    _application: string = ''

    Protected _conversion

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

    Type declaration

    • 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;
    } = ...

    Type declaration

    • title: string
    • url: string

    defaultImportOptions

    defaultImportOptions: any

    options

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

    Type declaration

    • 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

    Private cleanTranscript

    convertToTimeString

    • convertToTimeString(value, args?): string

    • transforms milliseconds to time string

      Parameters

      • value: number

        number or milliseconds

        -
      • Optional args: {
            maxDuration?: number;
            showHour?: boolean;
            showMilliSeconds?: boolean;
        }
        • Optional maxDuration?: number
        • Optional showHour?: boolean
        • Optional showMilliSeconds?: boolean

      Returns string

    export

    • export(annotation, audiofile, levelnum): ExportResult

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

      +
    • Optional args: {
          maxDuration?: number;
          showHour?: boolean;
          showMilliSeconds?: boolean;
      }
      • Optional maxDuration?: number
      • Optional showHour?: boolean
      • Optional showMilliSeconds?: boolean

    Returns string

    export

    Private formatNumber

    Private getHours

    Private getMilliSeconds

    Private getMinutes

    Private getSeconds

    import

    Returns ExportResult

    Private formatNumber

    Private getHours

    Private getMilliSeconds

    Private getMinutes

    Private getSeconds

    import

    needsOptionsForImport

    Returns ImportResult

    needsOptionsForImport

    Private timeStringToSamples

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsitecleanTranscriptconvertToTimeStringexportformatNumbergetHoursgetMilliSecondsgetMinutesgetSecondsimportneedsOptionsForImporttimeStringToSamples
    \ No newline at end of file +

    Returns any

    Private timeStringToSamples

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsitecleanTranscriptconvertToTimeStringexportformatNumbergetHoursgetMilliSecondsgetMinutesgetSecondsimportneedsOptionsForImporttimeStringToSamples
    \ No newline at end of file diff --git a/classes/_octra_annotation.WebVTTConverter.html b/classes/_octra_annotation.WebVTTConverter.html index 355b6fcc7..017689d7e 100644 --- a/classes/_octra_annotation.WebVTTConverter.html +++ b/classes/_octra_annotation.WebVTTConverter.html @@ -1,4 +1,4 @@ -WebVTTConverter | Octra libraries - v2.0.0

    Class WebVTTConverter

    Hierarchy (view full)

    Constructors

    constructor +WebVTTConverter | Octra libraries - v2.0.0

    Class WebVTTConverter

    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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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

    Returns ImportResult

    needsOptionsForImport

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportformatNumbergetSamplesFromTimeStringgetTimeStringFromSamplesimportneedsOptionsForImport
    \ No newline at end of file +

    Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteexportformatNumbergetSamplesFromTimeStringgetTimeStringFromSamplesimportneedsOptionsForImport
    \ No newline at end of file diff --git a/classes/_octra_annotation.WhisperJSON.html b/classes/_octra_annotation.WhisperJSON.html index a36423da4..2939b6101 100644 --- a/classes/_octra_annotation.WhisperJSON.html +++ b/classes/_octra_annotation.WhisperJSON.html @@ -1,6 +1,6 @@ -WhisperJSON | Octra libraries - v2.0.0

    Class WhisperJSON

    Constructors

    constructor +WhisperJSON | Octra libraries - v2.0.0

    Class WhisperJSON

    Constructors

    constructor

    Properties

    language segments text? word_segments? -

    Constructors

    constructor

    Properties

    language

    language: string

    segments

    segments: WhisperJSONSegment[]

    Optional text

    text?: string

    Optional word_segments

    word_segments?: WhisperJSONWord[]

    Settings

    Member Visibility

    Theme

    On This Page

    constructorlanguagesegmentstextword_segments
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    language

    language: string

    segments

    segments: WhisperJSONSegment[]

    Optional text

    text?: string

    Optional word_segments

    word_segments?: WhisperJSONWord[]

    Settings

    Member Visibility

    Theme

    On This Page

    constructorlanguagesegmentstextword_segments
    \ No newline at end of file diff --git a/classes/_octra_annotation.WhisperJSONConverter.html b/classes/_octra_annotation.WhisperJSONConverter.html index 1f085325b..c0defedbc 100644 --- a/classes/_octra_annotation.WhisperJSONConverter.html +++ b/classes/_octra_annotation.WhisperJSONConverter.html @@ -1,4 +1,4 @@ -WhisperJSONConverter | Octra libraries - v2.0.0

    Class WhisperJSONConverter

    Hierarchy (view full)

    Constructors

    constructor +WhisperJSONConverter | Octra libraries - v2.0.0

    Class WhisperJSONConverter

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _application _conversion _encoding @@ -23,14 +23,14 @@ import needsOptionsForImport validateJSONFile -

    Constructors

    constructor

    Properties

    Protected _application

    _application: string = ''

    Protected _conversion

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

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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

    Private addSegment

    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;
    } = ...

    Type declaration

    • 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;
    } = ...

    Type declaration

    • 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

    Private addSegment

    export

    Private getSpeakers

    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

    Private getSpeakers

    import

    needsOptionsForImport

    Returns ImportResult

    needsOptionsForImport

    Private validateJSONFile

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteaddSegmentexportgetSpeakersimportneedsOptionsForImportvalidateJSONFile
    \ No newline at end of file +

    Returns any

    Private validateJSONFile

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_application_conversion_encoding_extension_multitiers_name_notice_websitedefaultImportOptionsoptionsapplicationconversionencodingextensionmultitiersnamenoticewebsiteaddSegmentexportgetSpeakersimportneedsOptionsForImportvalidateJSONFile
    \ No newline at end of file diff --git a/classes/_octra_annotation.WhisperJSONSegment.html b/classes/_octra_annotation.WhisperJSONSegment.html index d68394f5c..89ac66be3 100644 --- a/classes/_octra_annotation.WhisperJSONSegment.html +++ b/classes/_octra_annotation.WhisperJSONSegment.html @@ -1,4 +1,4 @@ -WhisperJSONSegment | Octra libraries - v2.0.0

    Class WhisperJSONSegment

    Constructors

    constructor +WhisperJSONSegment | Octra libraries - v2.0.0

    Class WhisperJSONSegment

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Optional avg_logprob

    avg_logprob?: number

    Optional compression_ratio

    compression_ratio?: number

    end

    end: number

    Optional id

    id?: number

    Optional no_speech_prob

    no_speech_prob?: number

    Optional seek

    seek?: number

    Optional speaker

    speaker?: string

    start

    start: number

    Optional temperature

    temperature?: number

    text

    text: string

    Optional tokens

    tokens?: number[]

    words

    words: WhisperJSONWord[]

    Settings

    Member Visibility

    Theme

    On This Page

    constructoravg_logprobcompression_ratioendidno_speech_probseekspeakerstarttemperaturetexttokenswords
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional avg_logprob

    avg_logprob?: number

    Optional compression_ratio

    compression_ratio?: number

    end

    end: number

    Optional id

    id?: number

    Optional no_speech_prob

    no_speech_prob?: number

    Optional seek

    seek?: number

    Optional speaker

    speaker?: string

    start

    start: number

    Optional temperature

    temperature?: number

    text

    text: string

    Optional tokens

    tokens?: number[]

    words

    words: WhisperJSONWord[]

    Settings

    Member Visibility

    Theme

    On This Page

    constructoravg_logprobcompression_ratioendidno_speech_probseekspeakerstarttemperaturetexttokenswords
    \ No newline at end of file diff --git a/classes/_octra_json_sets.DecisionTreeCombination.html b/classes/_octra_json_sets.DecisionTreeCombination.html index 07482349a..f0750f32e 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

    Class DecisionTreeCombination<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +DecisionTreeCombination | Octra libraries - v2.0.0

    Class DecisionTreeCombination<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 Readonly blueprint

    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

    possibleSelections

    Methods

    append

    clone

    insert

    outputSolutions

    Protected powArray

    remove

    removeById

    validate

    Static json2tree

    Static json2treeCombination

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_errors_id_parent_possibleSelectionsblueprintchildrencombinationdescriptionidnamepathpossibleSelectionsappendcloneinsertoutputSolutionspowArrayremoveremoveByIdvalidatejson2treejson2treeCombination
    \ No newline at end of file +

    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 Readonly blueprint

    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

    possibleSelections

    Methods

    append

    clone

    insert

    outputSolutions

    Protected powArray

    remove

    removeById

    validate

    Static json2tree

    Static json2treeCombination

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_errors_id_parent_possibleSelectionsblueprintchildrencombinationdescriptionidnamepathpossibleSelectionsappendcloneinsertoutputSolutionspowArrayremoveremoveByIdvalidatejson2treejson2treeCombination
    \ No newline at end of file diff --git a/classes/_octra_json_sets.DecisionTreeExpression.html b/classes/_octra_json_sets.DecisionTreeExpression.html index 186dd15bc..923b433c8 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

    Class DecisionTreeExpression<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +DecisionTreeExpression | Octra libraries - v2.0.0

    Class DecisionTreeExpression<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _errors _id _parent? @@ -18,4 +18,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 Readonly blueprint

    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

    possibleSelections

    Methods

    clone

    Private generatePossibleSolutions

    outputSolutions

    Private parseSelectStatement

    • parseSelectStatement(selectStatement): {
          selectNumber: number;
          type: "exact" | "min" | "max";
      }

    • Parameters

      • selectStatement: string

      Returns {
          selectNumber: number;
          type: "exact" | "min" | "max";
      }

      • selectNumber: number
      • type: "exact" | "min" | "max"

    Protected powArray

    validate

    Static json2tree

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_errors_id_parent_possibleSelectionsblueprintstatementvalidItemdescriptionidnamepathpossibleSelectionsclonegeneratePossibleSolutionsoutputSolutionsparseSelectStatementpowArrayvalidatejson2tree
    \ No newline at end of file +

    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 Readonly blueprint

    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

    possibleSelections

    Methods

    clone

    Private generatePossibleSolutions

    outputSolutions

    Private parseSelectStatement

    • parseSelectStatement(selectStatement): {
          selectNumber: number;
          type: "exact" | "min" | "max";
      }

    • Parameters

      • selectStatement: string

      Returns {
          selectNumber: number;
          type: "exact" | "min" | "max";
      }

      • selectNumber: number
      • type: "exact" | "min" | "max"

    Protected powArray

    validate

    Static json2tree

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_errors_id_parent_possibleSelectionsblueprintstatementvalidItemdescriptionidnamepathpossibleSelectionsclonegeneratePossibleSolutionsoutputSolutionsparseSelectStatementpowArrayvalidatejson2tree
    \ No newline at end of file diff --git a/classes/_octra_json_sets.DecisionTreeNode.html b/classes/_octra_json_sets.DecisionTreeNode.html index e20cc56ae..2e0dbb3b0 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

    Class DecisionTreeNode<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +DecisionTreeNode | Octra libraries - v2.0.0

    Class DecisionTreeNode<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _description? _errors _id @@ -17,4 +17,4 @@ powArray validate json2tree -

    Constructors

    constructor

    Properties

    Private Optional Readonly _description

    _description?: string

    _errors

    _errors: JSONSetValidationError<T>[] = []

    Protected Readonly _id

    _id: number

    Private Optional Readonly _name

    _name?: string

    Protected Optional Readonly _parent

    _parent?: DecisionTreeCombination<T, U>

    Protected _possibleSelections

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

    Protected Readonly blueprint

    blueprint: JSONSetBlueprint<T, U>

    Private Static id

    id: number = 1

    Accessors

    description

    id

    name

    path

    possibleSelections

    Methods

    clone

    outputSolutions

    Protected powArray

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

    • Type Parameters

      • T

      Parameters

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

      Returns T[][]

    validate

    Static json2tree

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_description_errors_id_name_parent_possibleSelectionsblueprintiddescriptionidnamepathpossibleSelectionscloneoutputSolutionspowArrayvalidatejson2tree
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional Readonly _description

    _description?: string

    _errors

    _errors: JSONSetValidationError<T>[] = []

    Protected Readonly _id

    _id: number

    Private Optional Readonly _name

    _name?: string

    Protected Optional Readonly _parent

    _parent?: DecisionTreeCombination<T, U>

    Protected _possibleSelections

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

    Protected Readonly blueprint

    blueprint: JSONSetBlueprint<T, U>

    Private Static id

    id: number = 1

    Accessors

    description

    id

    name

    path

    possibleSelections

    Methods

    clone

    outputSolutions

    Protected powArray

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

    • Type Parameters

      • T

      Parameters

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

      Returns T[][]

    validate

    Static json2tree

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_description_errors_id_name_parent_possibleSelectionsblueprintiddescriptionidnamepathpossibleSelectionscloneoutputSolutionspowArrayvalidatejson2tree
    \ No newline at end of file diff --git a/classes/_octra_json_sets.FileSetValidator.html b/classes/_octra_json_sets.FileSetValidator.html index 5dcad9505..f2ab644be 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

    Class FileSetValidator

    Hierarchy (view full)

    Constructors

    constructor +FileSetValidator | Octra libraries - v2.0.0

    Class FileSetValidator

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    blueprint

    Accessors

    decisionTree

    Methods

    parse validate -

    Constructors

    constructor

    Properties

    blueprint

    blueprint: JSONSetFileBlueprint = ...

    Accessors

    decisionTree

    Methods

    Protected parse

    validate

    Settings

    Member Visibility

    Theme

    On This Page

    constructorblueprintdecisionTreeparsevalidate
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    blueprint

    blueprint: JSONSetFileBlueprint = ...

    Accessors

    decisionTree

    Methods

    Protected parse

    validate

    Settings

    Member Visibility

    Theme

    On This Page

    constructorblueprintdecisionTreeparsevalidate
    \ No newline at end of file diff --git a/classes/_octra_json_sets.IFile.html b/classes/_octra_json_sets.IFile.html index 1373117b8..743217159 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

    Class IFile

    Constructors

    constructor +IFile | Octra libraries - v2.0.0

    Class IFile

    Constructors

    constructor

    Properties

    content? name size? type? -

    Constructors

    constructor

    Properties

    Optional content

    content?: string

    name

    name: string

    Optional size

    size?: number

    Optional type

    type?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontentnamesizetype
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional content

    content?: string

    name

    name: string

    Optional size

    size?: number

    Optional type

    type?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontentnamesizetype
    \ No newline at end of file diff --git a/classes/_octra_json_sets.JSONSet.html b/classes/_octra_json_sets.JSONSet.html index 8a4475e28..7e872ea5f 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

    Class JSONSet<U>

    Type Parameters

    • U

    Constructors

    constructor +JSONSet | Octra libraries - v2.0.0

    Class JSONSet<U>

    Type Parameters

    • U

    Constructors

    constructor

    Properties

    combine description? name? -

    Constructors

    constructor

    Properties

    combine

    combine: JSONSetCombination<U>

    Optional description

    description?: string

    Optional name

    name?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcombinedescriptionname
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    combine

    combine: JSONSetCombination<U>

    Optional description

    description?: string

    Optional name

    name?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcombinedescriptionname
    \ No newline at end of file diff --git a/classes/_octra_json_sets.JSONSetBlueprint.html b/classes/_octra_json_sets.JSONSetBlueprint.html index 75f0f9e0b..a6ebfd20e 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

    Class JSONSetBlueprint<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +JSONSetBlueprint | Octra libraries - v2.0.0

    Class JSONSetBlueprint<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, conditions, combinationType, path) => JSONSetResult)[] = []

    Type declaration

      • (item, conditions, combinationType, path): JSONSetResult

      • Parameters

        • item: T
        • conditions: U
        • combinationType: "and" | "or"
        • path: string

        Returns JSONSetResult

    Accessors

    validationMethods

    Methods

    areEqualArray

    cleanUpSolutions

    outputTreeWithSolutions

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_validationMethodsvalidationMethodsareEqualArraycleanUpSolutionsoutputTreeWithSolutions
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected _validationMethods

    _validationMethods: ((item, conditions, combinationType, path) => JSONSetResult)[] = []

    Type declaration

      • (item, conditions, combinationType, path): JSONSetResult

      • Parameters

        • item: T
        • conditions: U
        • combinationType: "and" | "or"
        • path: string

        Returns JSONSetResult

    Accessors

    validationMethods

    Methods

    areEqualArray

    cleanUpSolutions

    outputTreeWithSolutions

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_validationMethodsvalidationMethodsareEqualArraycleanUpSolutionsoutputTreeWithSolutions
    \ No newline at end of file diff --git a/classes/_octra_json_sets.JSONSetCombination.html b/classes/_octra_json_sets.JSONSetCombination.html index 0b4bb8700..b9329a050 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

    Class JSONSetCombination<U>

    Type Parameters

    • U

    Constructors

    constructor +JSONSetCombination | Octra libraries - v2.0.0

    Class JSONSetCombination<U>

    Type Parameters

    • U

    Constructors

    constructor

    Properties

    expressions type -

    Constructors

    constructor

    Properties

    expressions

    expressions: JSONSetExpression<U>[]

    type

    type: "and" | "or"

    Settings

    Member Visibility

    Theme

    On This Page

    constructorexpressionstype
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    expressions

    expressions: JSONSetExpression<U>[]

    type

    type: "and" | "or"

    Settings

    Member Visibility

    Theme

    On This Page

    constructorexpressionstype
    \ No newline at end of file diff --git a/classes/_octra_json_sets.JSONSetFileBlueprint.html b/classes/_octra_json_sets.JSONSetFileBlueprint.html index 19501ea4b..066a03239 100644 --- a/classes/_octra_json_sets.JSONSetFileBlueprint.html +++ b/classes/_octra_json_sets.JSONSetFileBlueprint.html @@ -1,4 +1,4 @@ -JSONSetFileBlueprint | Octra libraries - v2.0.0

    Class JSONSetFileBlueprint

    Hierarchy (view full)

    Constructors

    constructor +JSONSetFileBlueprint | Octra libraries - v2.0.0

    Class JSONSetFileBlueprint

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _validationMethods

    Accessors

    validationMethods

    Methods

    areEqualArray @@ -10,4 +10,4 @@ validateFileSize validateMimeType validateNamePattern -

    Constructors

    constructor

    Properties

    Protected _validationMethods

    _validationMethods: ((item, conditions, combinationType, path) => JSONSetResult)[] = []

    Type declaration

    Accessors

    validationMethods

    Methods

    areEqualArray

    cleanUpSolutions

    Private convertFileString

    • convertFileString(fileString): undefined | number

    • Parameters

      • fileString: string

      Returns undefined | number

    outputTreeWithSolutions

    Private validateContent

    Private validateExtension

    Private validateFileSize

    • validateFileSize(item, conditions, combinationType, path): {
          combinationType: "and" | "or";
          error: string;
          path: string;
          valid: boolean;
      } | {
          combinationType: "and" | "or";
          error?: undefined;
          path: string;
          valid: boolean;
      }

    • Parameters

      Returns {
          combinationType: "and" | "or";
          error: string;
          path: string;
          valid: boolean;
      } | {
          combinationType: "and" | "or";
          error?: undefined;
          path: string;
          valid: boolean;
      }

    Private validateMimeType

    Private validateNamePattern

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_validationMethodsvalidationMethodsareEqualArraycleanUpSolutionsconvertFileStringoutputTreeWithSolutionsvalidateContentvalidateExtensionvalidateFileSizevalidateMimeTypevalidateNamePattern
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected _validationMethods

    _validationMethods: ((item, conditions, combinationType, path) => JSONSetResult)[] = []

    Type declaration

    Accessors

    validationMethods

    Methods

    areEqualArray

    cleanUpSolutions

    Private convertFileString

    • convertFileString(fileString): undefined | number

    • Parameters

      • fileString: string

      Returns undefined | number

    outputTreeWithSolutions

    Private validateContent

    Private validateExtension

    Private validateFileSize

    • validateFileSize(item, conditions, combinationType, path): {
          combinationType: "and" | "or";
          error: string;
          path: string;
          valid: boolean;
      } | {
          combinationType: "and" | "or";
          error?: undefined;
          path: string;
          valid: boolean;
      }

    • Parameters

      Returns {
          combinationType: "and" | "or";
          error: string;
          path: string;
          valid: boolean;
      } | {
          combinationType: "and" | "or";
          error?: undefined;
          path: string;
          valid: boolean;
      }

    Private validateMimeType

    Private validateNamePattern

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_validationMethodsvalidationMethodsareEqualArraycleanUpSolutionsconvertFileStringoutputTreeWithSolutionsvalidateContentvalidateExtensionvalidateFileSizevalidateMimeTypevalidateNamePattern
    \ No newline at end of file diff --git a/classes/_octra_json_sets.JSONSetFileConditions.html b/classes/_octra_json_sets.JSONSetFileConditions.html index e392341b6..172575591 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

    Class JSONSetFileConditions

    Constructors

    constructor +JSONSetFileConditions | Octra libraries - v2.0.0

    Class JSONSetFileConditions

    Constructors

    constructor

    Properties

    content? extension? mimeType? namePattern? size? -

    Constructors

    constructor

    Properties

    Optional content

    content?: string[]

    Optional extension

    extension?: string[]

    Optional mimeType

    mimeType?: string[]

    Optional namePattern

    namePattern?: string

    Optional size

    size?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontentextensionmimeTypenamePatternsize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional content

    content?: string[]

    Optional extension

    extension?: string[]

    Optional mimeType

    mimeType?: string[]

    Optional namePattern

    namePattern?: string

    Optional size

    size?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontentextensionmimeTypenamePatternsize
    \ No newline at end of file diff --git a/classes/_octra_json_sets.JSONSetResult.html b/classes/_octra_json_sets.JSONSetResult.html index 34ccf85dd..04ab3ee58 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

    Class JSONSetResult

    Constructors

    constructor +JSONSetResult | Octra libraries - v2.0.0

    Class JSONSetResult

    Constructors

    constructor

    Properties

    combinationType? error? path? valid -

    Constructors

    constructor

    Properties

    Optional combinationType

    combinationType?: "and" | "or"

    Optional error

    error?: string

    Optional path

    path?: string

    valid

    valid: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcombinationTypeerrorpathvalid
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional combinationType

    combinationType?: "and" | "or"

    Optional error

    error?: string

    Optional path

    path?: string

    valid

    valid: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcombinationTypeerrorpathvalid
    \ No newline at end of file diff --git a/classes/_octra_json_sets.JSONSetStatement.html b/classes/_octra_json_sets.JSONSetStatement.html index 6ec3a133c..9a0d80b02 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

    Class JSONSetStatement<U>

    Type Parameters

    • U

    Constructors

    constructor +JSONSetStatement | Octra libraries - v2.0.0

    Class JSONSetStatement<U>

    Type Parameters

    • U

    Constructors

    constructor

    Properties

    description? name? select with -

    Constructors

    constructor

    Properties

    Optional description

    description?: string

    Optional name

    name?: string

    select

    select: string

    with

    with: U | U[]

    Settings

    Member Visibility

    Theme

    On This Page

    constructordescriptionnameselectwith
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional description

    description?: string

    Optional name

    name?: string

    select

    select: string

    with

    with: U | U[]

    Settings

    Member Visibility

    Theme

    On This Page

    constructordescriptionnameselectwith
    \ No newline at end of file diff --git a/classes/_octra_json_sets.JSONSetValidationError.html b/classes/_octra_json_sets.JSONSetValidationError.html index d82e31b6e..2978e8340 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

    Class JSONSetValidationError<U>

    Type Parameters

    • U

    Constructors

    constructor +JSONSetValidationError | Octra libraries - v2.0.0

    Class JSONSetValidationError<U>

    Type Parameters

    • U

    Constructors

    constructor

    Properties

    combinationType? message path? statement? -

    Constructors

    constructor

    Properties

    Optional combinationType

    combinationType?: "and" | "or"

    message

    message: string

    Optional path

    path?: string

    Optional statement

    statement?: JSONSetStatement<U>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcombinationTypemessagepathstatement
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional combinationType

    combinationType?: "and" | "or"

    message

    message: string

    Optional path

    path?: string

    Optional statement

    statement?: JSONSetStatement<U>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcombinationTypemessagepathstatement
    \ No newline at end of file diff --git a/classes/_octra_json_sets.JsonSetValidator.html b/classes/_octra_json_sets.JsonSetValidator.html index 83586f99f..d72ce715b 100644 --- a/classes/_octra_json_sets.JsonSetValidator.html +++ b/classes/_octra_json_sets.JsonSetValidator.html @@ -1,7 +1,7 @@ -JsonSetValidator | Octra libraries - v2.0.0

    Class JsonSetValidator<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor +JsonSetValidator | Octra libraries - v2.0.0

    Class JsonSetValidator<T, U>

    Type Parameters

    • T
    • U

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _decisionTree? blueprint

    Accessors

    decisionTree

    Methods

    parse validate -

    Constructors

    constructor

    Properties

    Private Optional _decisionTree

    _decisionTree?: DecisionTreeCombination<T, U>

    Protected Readonly blueprint

    blueprint: JSONSetBlueprint<T, U>

    Accessors

    decisionTree

    Methods

    Protected parse

    validate

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_decisionTreeblueprintdecisionTreeparsevalidate
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Optional _decisionTree

    _decisionTree?: DecisionTreeCombination<T, U>

    Protected Readonly blueprint

    blueprint: JSONSetBlueprint<T, U>

    Accessors

    decisionTree

    Methods

    Protected parse

    validate

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_decisionTreeblueprintdecisionTreeparsevalidate
    \ No newline at end of file diff --git a/classes/_octra_json_sets.PossibleSolution.html b/classes/_octra_json_sets.PossibleSolution.html index b52dfa5d8..808097103 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

    Class PossibleSolution<T, U>

    Type Parameters

    • T
    • U

    Constructors

    constructor +PossibleSolution | Octra libraries - v2.0.0

    Class PossibleSolution<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

    Theme

    On This Page

    constructorpathselectionstatement
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    path

    path: string

    selection

    selection: T

    statement

    statement: JSONSetExpression<U>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathselectionstatement
    \ No newline at end of file diff --git a/classes/_octra_media.AudioSelection.html b/classes/_octra_media.AudioSelection.html index 15952d6fd..7c522ab80 100644 --- a/classes/_octra_media.AudioSelection.html +++ b/classes/_octra_media.AudioSelection.html @@ -1,4 +1,4 @@ -AudioSelection | Octra libraries - v2.0.0

    Class AudioSelection

    Constructors

    constructor +AudioSelection | Octra libraries - v2.0.0

    Class AudioSelection

    Constructors

    constructor

    Properties

    _end _start

    Accessors

    duration @@ -7,4 +7,4 @@ start

    Methods

    checkSelection clone -

    Constructors

    constructor

    Properties

    Private _end

    _end: SampleUnit

    Private _start

    _start: SampleUnit

    Accessors

    duration

    end

    length

    start

    Methods

    checkSelection

    clone

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_end_startdurationendlengthstartcheckSelectionclone
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private _end

    _end: SampleUnit

    Private _start

    _start: SampleUnit

    Accessors

    duration

    end

    length

    start

    Methods

    checkSelection

    clone

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_end_startdurationendlengthstartcheckSelectionclone
    \ No newline at end of file diff --git a/classes/_octra_media.OAudiofile.html b/classes/_octra_media.OAudiofile.html index 3fda28c58..66b9f3732 100644 --- a/classes/_octra_media.OAudiofile.html +++ b/classes/_octra_media.OAudiofile.html @@ -1,4 +1,4 @@ -OAudiofile | Octra libraries - v2.0.0

    Class OAudiofile

    Implements

    Constructors

    constructor +OAudiofile | Octra libraries - v2.0.0

    Class OAudiofile

    Implements

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Optional arraybuffer

    arraybuffer?: ArrayBuffer

    duration

    duration: number

    name

    name: string

    sampleRate

    sampleRate: number

    size

    size: number

    type

    type: string

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorarraybufferdurationnamesampleRatesizetypeurl
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional arraybuffer

    arraybuffer?: ArrayBuffer

    duration

    duration: number

    name

    name: string

    sampleRate

    sampleRate: number

    size

    size: number

    type

    type: string

    Optional url

    url?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorarraybufferdurationnamesampleRatesizetypeurl
    \ No newline at end of file diff --git a/classes/_octra_media.SampleUnit.html b/classes/_octra_media.SampleUnit.html index 6963bf3cb..478f667cc 100644 --- a/classes/_octra_media.SampleUnit.html +++ b/classes/_octra_media.SampleUnit.html @@ -1,4 +1,4 @@ -SampleUnit | Octra libraries - v2.0.0

    Class SampleUnit

    Constructors

    constructor +SampleUnit | Octra libraries - v2.0.0

    Class SampleUnit

    Constructors

    constructor

    Properties

    _sampleRate _samples validSampleRates @@ -16,4 +16,4 @@ fromMiliSeconds fromSeconds isValidSampleRate -

    Constructors

    constructor

    Properties

    Private _sampleRate

    _sampleRate: number

    Private _samples

    _samples: number

    Private Static Readonly validSampleRates

    validSampleRates: number[] = ...

    Accessors

    sampleRate

    samples

    seconds

    unix

    Methods

    add

    clone

    equals

    hasEqualSampleRate

    sub

    toString

    Static calculateSamples

    • calculateSamples(seconds, sampleRate): number

    • Parameters

      • seconds: number
      • sampleRate: number

      Returns number

    Static fromMiliSeconds

    Static fromSeconds

    Private Static isValidSampleRate

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_sampleRate_samplesvalidSampleRatessampleRatesamplessecondsunixaddcloneequalshasEqualSampleRatesubtoStringcalculateSamplesfromMiliSecondsfromSecondsisValidSampleRate
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private _sampleRate

    _sampleRate: number

    Private _samples

    _samples: number

    Private Static Readonly validSampleRates

    validSampleRates: number[] = ...

    Accessors

    sampleRate

    samples

    seconds

    unix

    Methods

    add

    clone

    equals

    hasEqualSampleRate

    sub

    toString

    Static calculateSamples

    • calculateSamples(seconds, sampleRate): number

    • Parameters

      • seconds: number
      • sampleRate: number

      Returns number

    Static fromMiliSeconds

    Static fromSeconds

    Private Static isValidSampleRate

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_sampleRate_samplesvalidSampleRatessampleRatesamplessecondsunixaddcloneequalshasEqualSampleRatesubtoStringcalculateSamplesfromMiliSecondsfromSecondsisValidSampleRate
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.AudioViewerComponent.html b/classes/_octra_ngx_components.AudioViewerComponent.html index a509746a6..cbf5b4ba7 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

    Class AudioViewerComponent

    Implements

    • OnInit
    • OnChanges
    • OnDestroy

    Constructors

    constructor +AudioViewerComponent | Octra libraries - v2.0.0

    Class AudioViewerComponent

    Implements

    • OnInit
    • OnChanges
    • OnDestroy

    Constructors

    constructor

    Properties

    audioChunk av elementRef @@ -44,20 +44,20 @@ redraw scrollToAbsY selectSegment -

    Constructors

    constructor

    Properties

    audioChunk

    audioChunk: undefined | AudioChunk

    current audio chunk displayed by this signal display

    -

    av

    av: AudioViewerService

    Private elementRef

    elementRef: ElementRef<any>

    konvaContainer

    konvaContainer: undefined | ElementRef<any>

    Private lastResize

    lastResize: number = 0

    Private renderer

    renderer: Renderer2

    Private resizing

    resizing: boolean = false

    Optional silencePlaceholder

    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

    Private elementRef

    elementRef: ElementRef<any>

    konvaContainer

    konvaContainer: undefined | ElementRef<any>

    Private lastResize

    lastResize: number = 0

    Private renderer

    renderer: Renderer2

    Private resizing

    resizing: boolean = false

    Optional silencePlaceholder

    silencePlaceholder?: string

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

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

    -

    Private subscrManager

    subscrManager: SubscriptionManager<Subscription>

    Accessors

    AudioPxWidth

    alert

    annotation

    annotationChange

    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

    Private afterLevelUpdated

    disableShortcuts

    enableShortcuts

    init

    ngOnChanges

    ngOnDestroy

    ngOnInit

    Private onAudioChunkStatusChanged

    onSecondsPerLineChanged

    onWindowResize

    redraw

    scrollToAbsY

    selectSegment

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraudioChunkavelementRefkonvaContainerlastResizerendererresizingsilencePlaceholdersubscrManagerAudioPxWidthalertannotationannotationChangeboundaryDraggingcurrentLevelChangecurrentLevelIDfocusedheightisMultiLinemouseCursormousecursorchangenameonInitializedplaycursorchangerefreshOnInternChangessecondsPerLinesegmententerselchangesettingsshortcutwidthafterChunkUpdatedafterLevelUpdateddisableShortcutsenableShortcutsinitngOnChangesngOnDestroyngOnInitonAudioChunkStatusChangedonSecondsPerLineChangedonWindowResizeredrawscrollToAbsYselectSegment
    \ No newline at end of file +

    Private subscrManager

    subscrManager: SubscriptionManager<Subscription>

    Accessors

    AudioPxWidth

    alert

    annotation

    annotationChange

    boundaryDragging

    currentLevelChange

    currentLevelID

    focused

    height

    isMultiLine

    mouseCursor

    mousecursorchange

    name

    onInitialized

    playcursorchange

    refreshOnInternChanges

    secondsPerLine

    segmententer

    selchange

    settings

    shortcut

    width

    Methods

    afterChunkUpdated

    Private afterLevelUpdated

    disableShortcuts

    enableShortcuts

    init

    ngOnChanges

    ngOnDestroy

    ngOnInit

    Private onAudioChunkStatusChanged

    onSecondsPerLineChanged

    onWindowResize

    redraw

    scrollToAbsY

    selectSegment

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraudioChunkavelementRefkonvaContainerlastResizerendererresizingsilencePlaceholdersubscrManagerAudioPxWidthalertannotationannotationChangeboundaryDraggingcurrentLevelChangecurrentLevelIDfocusedheightisMultiLinemouseCursormousecursorchangenameonInitializedplaycursorchangerefreshOnInternChangessecondsPerLinesegmententerselchangesettingsshortcutwidthafterChunkUpdatedafterLevelUpdateddisableShortcutsenableShortcutsinitngOnChangesngOnDestroyngOnInitonAudioChunkStatusChangedonSecondsPerLineChangedonWindowResizeredrawscrollToAbsYselectSegment
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.AudioplayerComponent.html b/classes/_octra_ngx_components.AudioplayerComponent.html index e3a7445a2..64f073e9f 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

    Class AudioplayerComponent

    Implements

    • OnInit
    • AfterViewInit
    • OnChanges
    • OnDestroy

    Constructors

    constructor +AudioplayerComponent | Octra libraries - v2.0.0

    Class AudioplayerComponent

    Implements

    • OnInit
    • AfterViewInit
    • OnChanges
    • OnDestroy

    Constructors

    constructor

    Properties

    _settings animation audioChunk @@ -33,4 +33,4 @@ pxToSample setPlayPosition update -

    Constructors

    constructor

    Properties

    Private _settings

    _settings: AudioplayerSettings = ...

    Private animation

    animation: {
        playHead: undefined | Animation;
    } = ...

    Type declaration

    • playHead: undefined | Animation

    audioChunk

    audioChunk: undefined | AudioChunk

    Private audiochunkSubscription

    audiochunkSubscription: undefined | Subscription

    Private backgroundLayer

    backgroundLayer: undefined | Layer

    Private bufferedSubscr

    bufferedSubscr: number = -1

    Private canvasElements

    canvasElements: {
        panel: undefined | Shape<ShapeConfig>;
        playHead: undefined | Shape<ShapeConfig>;
        sliderBar: undefined | Shape<ShapeConfig>;
    } = ...

    Type declaration

    • panel: undefined | Shape<ShapeConfig>
    • playHead: undefined | Shape<ShapeConfig>
    • sliderBar: undefined | Shape<ShapeConfig>

    konvaContainer

    konvaContainer: undefined | ElementRef<any>

    Private stage

    stage: undefined | Stage

    Private subscrmanager

    subscrmanager: SubscriptionManager<unknown> = ...

    Accessors

    getPlayHeadX

    settings

    timeLeft

    width

    Methods

    afterChunkUpdated

    Private doPlayHeadAnimation

    ngAfterViewInit

    ngOnChanges

    ngOnDestroy

    ngOnInit

    Private onAudioChunkStatusChanged

    Private onPanelClick

    Private onPanelMouseMove

    onPlayHeadDragging

    Private onPlayHeadMouseMove

    Private onPlaybackEnded

    Private onPlaybackPaused

    Private onPlaybackStarted

    Private onPlaybackStopped

    onResize

    Private onSliderClick

    pxToSample

    Private setPlayPosition

    update

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_settingsanimationaudioChunkaudiochunkSubscriptionbackgroundLayerbufferedSubscrcanvasElementskonvaContainerstagesubscrmanagergetPlayHeadXsettingstimeLeftwidthafterChunkUpdateddoPlayHeadAnimationngAfterViewInitngOnChangesngOnDestroyngOnInitonAudioChunkStatusChangedonPanelClickonPanelMouseMoveonPlayHeadDraggingonPlayHeadMouseMoveonPlaybackEndedonPlaybackPausedonPlaybackStartedonPlaybackStoppedonResizeonSliderClickpxToSamplesetPlayPositionupdate
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private _settings

    _settings: AudioplayerSettings = ...

    Private animation

    animation: {
        playHead: undefined | Animation;
    } = ...

    Type declaration

    • playHead: undefined | Animation

    audioChunk

    audioChunk: undefined | AudioChunk

    Private audiochunkSubscription

    audiochunkSubscription: undefined | Subscription

    Private backgroundLayer

    backgroundLayer: undefined | Layer

    Private bufferedSubscr

    bufferedSubscr: number = -1

    Private canvasElements

    canvasElements: {
        panel: undefined | Shape<ShapeConfig>;
        playHead: undefined | Shape<ShapeConfig>;
        sliderBar: undefined | Shape<ShapeConfig>;
    } = ...

    Type declaration

    • panel: undefined | Shape<ShapeConfig>
    • playHead: undefined | Shape<ShapeConfig>
    • sliderBar: undefined | Shape<ShapeConfig>

    konvaContainer

    konvaContainer: undefined | ElementRef<any>

    Private stage

    stage: undefined | Stage

    Private subscrmanager

    subscrmanager: SubscriptionManager<unknown> = ...

    Accessors

    getPlayHeadX

    settings

    timeLeft

    width

    Methods

    afterChunkUpdated

    Private doPlayHeadAnimation

    ngAfterViewInit

    ngOnChanges

    ngOnDestroy

    ngOnInit

    Private onAudioChunkStatusChanged

    Private onPanelClick

    Private onPanelMouseMove

    onPlayHeadDragging

    Private onPlayHeadMouseMove

    Private onPlaybackEnded

    Private onPlaybackPaused

    Private onPlaybackStarted

    Private onPlaybackStopped

    onResize

    Private onSliderClick

    pxToSample

    Private setPlayPosition

    update

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_settingsanimationaudioChunkaudiochunkSubscriptionbackgroundLayerbufferedSubscrcanvasElementskonvaContainerstagesubscrmanagergetPlayHeadXsettingstimeLeftwidthafterChunkUpdateddoPlayHeadAnimationngAfterViewInitngOnChangesngOnDestroyngOnInitonAudioChunkStatusChangedonPanelClickonPanelMouseMoveonPlayHeadDraggingonPlayHeadMouseMoveonPlaybackEndedonPlaybackPausedonPlaybackStartedonPlaybackStoppedonResizeonSliderClickpxToSamplesetPlayPositionupdate
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.AudioviewerConfig.html b/classes/_octra_ngx_components.AudioviewerConfig.html index 09765fbec..0da03f12e 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

    Class AudioviewerConfig

    Constructors

    constructor +AudioviewerConfig | Octra libraries - v2.0.0

    Class AudioviewerConfig

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    asr

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

    Type declaration

    • enabled: boolean

    backgroundcolor

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

    boundaries

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

    Type declaration

    • color: string
    • enabled: boolean
    • readonly: boolean
    • width: number

    cropping

    cropping: string = 'none'

    cursor

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

    Type declaration

    • color: string
    • fixed: boolean

    data

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

    Type declaration

    • color: string

    disabledKeys

    disabledKeys: string[] = ...

    frame

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

    Type declaration

    • color: string

    grid

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

    Type declaration

    • color: string
    • enabled: true

    justifySignalHeight

    justifySignalHeight: boolean = true

    lineheight

    lineheight: number = 60

    margin

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

    Type declaration

    • bottom: number
    • left: number
    • right: number
    • top: number

    multiLine

    multiLine: boolean = false

    pixelPerSec

    pixelPerSec: number = 50

    playcursor

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

    Type declaration

    • 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;
    } = ...

    Type declaration

    • background: {
          color: string;
          stroke: string;
          strokeWidth: number;
      }
      • color: string
      • stroke: string
      • strokeWidth: number
    • enabled: boolean
    • selector: {
          color: string;
          stroke: string;
          strokeWidth: number;
          width: number;
      }
      • color: string
      • stroke: string
      • strokeWidth: number
      • width: number
    • width: number

    selection

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

    Type declaration

    • 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 declaration

    • enabled: boolean
    • font: string
    • fontSize: number
    • fontWeight: string
    • foreColor: string
    • height: number

    type

    type: undefined | string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorasrbackgroundcolorboundariescroppingcursordatadisabledKeysframegridjustifySignalHeightlineheightmarginmultiLinepixelPerSecplaycursorroundValuesscrollbarselectionshortcutsshortcutsEnabledshowProgressBarsshowTimePerLineshowTranscriptsstepWidthRatiotimelinetype
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    asr

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

    Type declaration

    • enabled: boolean

    backgroundcolor

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

    boundaries

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

    Type declaration

    • color: string
    • enabled: boolean
    • readonly: boolean
    • width: number

    cropping

    cropping: string = 'none'

    cursor

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

    Type declaration

    • color: string
    • fixed: boolean

    data

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

    Type declaration

    • color: string

    disabledKeys

    disabledKeys: string[] = ...

    frame

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

    Type declaration

    • color: string

    grid

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

    Type declaration

    • color: string
    • enabled: true

    justifySignalHeight

    justifySignalHeight: boolean = true

    lineheight

    lineheight: number = 60

    margin

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

    Type declaration

    • bottom: number
    • left: number
    • right: number
    • top: number

    multiLine

    multiLine: boolean = false

    pixelPerSec

    pixelPerSec: number = 50

    playcursor

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

    Type declaration

    • 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;
    } = ...

    Type declaration

    • background: {
          color: string;
          stroke: string;
          strokeWidth: number;
      }
      • color: string
      • stroke: string
      • strokeWidth: number
    • enabled: boolean
    • selector: {
          color: string;
          stroke: string;
          strokeWidth: number;
          width: number;
      }
      • color: string
      • stroke: string
      • strokeWidth: number
      • width: number
    • width: number

    selection

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

    Type declaration

    • 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 declaration

    • enabled: boolean
    • font: string
    • fontSize: number
    • fontWeight: string
    • foreColor: string
    • height: number

    type

    type: undefined | string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorasrbackgroundcolorboundariescroppingcursordatadisabledKeysframegridjustifySignalHeightlineheightmarginmultiLinepixelPerSecplaycursorroundValuesscrollbarselectionshortcutsshortcutsEnabledshowProgressBarsshowTimePerLineshowTranscriptsstepWidthRatiotimelinetype
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationArrayControl.html b/classes/_octra_ngx_components.ConfigurationArrayControl.html index 65e1d880f..6a8224f48 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

    Class ConfigurationArrayControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationArrayControl | Octra libraries - v2.0.0

    Class ConfigurationArrayControl

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file +

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationControl.html b/classes/_octra_ngx_components.ConfigurationControl.html index f8d921576..1cc3cd10f 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

    Class ConfigurationControl<R, S>

    Type Parameters

    • R = any
    • S = any

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationControl | Octra libraries - v2.0.0

    Class ConfigurationControl<R, S>

    Type Parameters

    • R = any
    • S = any

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _id _name _options @@ -20,4 +20,4 @@

    Methods

    checkToggleStateOfControl findControlOfAttributeName toObj -

    Constructors

    constructor

    Properties

    Private _id

    _id: number

    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

    Private Static idCounter

    idCounter: number = 1

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    value

    Methods

    checkToggleStateOfControl

    Private findControlOfAttributeName

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_id_name_options_rootfocuseditemsTypetoggledidCountercontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControlfindControlOfAttributeNametoObj
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private _id

    _id: number

    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

    Private Static idCounter

    idCounter: number = 1

    Accessors

    context

    dependsOn

    description

    id

    ignore

    name

    title

    toggleable

    type

    value

    Methods

    checkToggleStateOfControl

    Private findControlOfAttributeName

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_id_name_options_rootfocuseditemsTypetoggledidCountercontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControlfindControlOfAttributeNametoObj
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationControlGroup.html b/classes/_octra_ngx_components.ConfigurationControlGroup.html index c9e0aa0bc..7d7c41a64 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

    Class ConfigurationControlGroup

    Constructors

    constructor +ConfigurationControlGroup | Octra libraries - v2.0.0

    Class ConfigurationControlGroup

    Constructors

    constructor

    Properties

    _dependsOn _name _title @@ -22,4 +22,4 @@

    Methods

    checkToggleStateOfControl findControlOfAttributeName toObj -

    Constructors

    constructor

    Properties

    Protected _dependsOn

    _dependsOn: string[] = []

    Protected _name

    _name: string

    Protected _title

    _title: string

    Protected _toggleable

    _toggleable: boolean = false

    Private _type

    _type: string = 'group'

    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 Readonly root

    root?: ConfigurationControlGroup

    toggled

    toggled: boolean = false

    value

    value: undefined = undefined

    Accessors

    dependsOn

    name

    title

    toggleable

    type

    Methods

    checkToggleStateOfControl

    Private findControlOfAttributeName

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_dependsOn_name_title_toggleable_typecontextcontrolsdescriptionfocusedidignoreitemsTyperoottoggledvaluedependsOnnametitletoggleabletypecheckToggleStateOfControlfindControlOfAttributeNametoObj
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected _dependsOn

    _dependsOn: string[] = []

    Protected _name

    _name: string

    Protected _title

    _title: string

    Protected _toggleable

    _toggleable: boolean = false

    Private _type

    _type: string = 'group'

    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 Readonly root

    root?: ConfigurationControlGroup

    toggled

    toggled: boolean = false

    value

    value: undefined = undefined

    Accessors

    dependsOn

    name

    title

    toggleable

    type

    Methods

    checkToggleStateOfControl

    Private findControlOfAttributeName

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_dependsOn_name_title_toggleable_typecontextcontrolsdescriptionfocusedidignoreitemsTyperoottoggledvaluedependsOnnametitletoggleabletypecheckToggleStateOfControlfindControlOfAttributeNametoObj
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationControlOptions.html b/classes/_octra_ngx_components.ConfigurationControlOptions.html index 45952e5fa..302cbe158 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

    Class ConfigurationControlOptions<R, S>

    Type Parameters

    • R
    • S = any

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationControlOptions | Octra libraries - v2.0.0

    Class ConfigurationControlOptions<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

    Optional context

    context?: S

    Optional defaultValue

    defaultValue?: R

    dependsOn

    dependsOn: string[] = []

    Optional description

    description?: string

    ignore

    ignore: boolean = false

    Optional title

    title?: string

    toggleable

    toggleable: boolean = false

    Optional type

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

    Optional value

    value?: R

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontextdefaultValuedependsOndescriptionignoretitletoggleabletypevalue
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional context

    context?: S

    Optional defaultValue

    defaultValue?: R

    dependsOn

    dependsOn: string[] = []

    Optional description

    description?: string

    ignore

    ignore: boolean = false

    Optional title

    title?: string

    toggleable

    toggleable: boolean = false

    Optional type

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

    Optional value

    value?: R

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontextdefaultValuedependsOndescriptionignoretitletoggleabletypevalue
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationMultipleChoiceControl.html b/classes/_octra_ngx_components.ConfigurationMultipleChoiceControl.html index 2d1474f7f..11793eee2 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

    Class ConfigurationMultipleChoiceControl

    Hierarchy (view full)

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

    Constructors

    constructor +ConfigurationMultipleChoiceControl | Octra libraries - v2.0.0

    Class ConfigurationMultipleChoiceControl

    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;
    }>

    Type declaration

    • 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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected _name

    _name: string

    Protected _options

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

    Type declaration

    • 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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationNumberControl.html b/classes/_octra_ngx_components.ConfigurationNumberControl.html index fc88cf20f..22a5f149a 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

    Class ConfigurationNumberControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationNumberControl | Octra libraries - v2.0.0

    Class ConfigurationNumberControl

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file +

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationSelectControl.html b/classes/_octra_ngx_components.ConfigurationSelectControl.html index 6a42e8b77..2d6280b77 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

    Class ConfigurationSelectControl

    Hierarchy (view full)

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

    Constructors

    constructor +ConfigurationSelectControl | Octra libraries - v2.0.0

    Class ConfigurationSelectControl

    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;
    }>

    Type declaration

    • 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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected _name

    _name: string

    Protected _options

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

    Type declaration

    • 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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationSwitchControl.html b/classes/_octra_ngx_components.ConfigurationSwitchControl.html index f73a7a774..9068d29b3 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

    Class ConfigurationSwitchControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationSwitchControl | Octra libraries - v2.0.0

    Class ConfigurationSwitchControl

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file +

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationTextControl.html b/classes/_octra_ngx_components.ConfigurationTextControl.html index 752b7068a..ec829a241 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

    Class ConfigurationTextControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationTextControl | Octra libraries - v2.0.0

    Class ConfigurationTextControl

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file +

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ConfigurationTextareaControl.html b/classes/_octra_ngx_components.ConfigurationTextareaControl.html index 7fed56899..eddd75a15 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

    Class ConfigurationTextareaControl

    Hierarchy (view full)

    Constructors

    constructor +ConfigurationTextareaControl | Octra libraries - v2.0.0

    Class ConfigurationTextareaControl

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file +

    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

    value

    Methods

    checkToggleStateOfControl

    toObj

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_name_options_rootfocuseditemsTypetoggledcontextdependsOndescriptionidignorenametitletoggleabletypevaluecheckToggleStateOfControltoObj
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.FixedConfigurationControlOptions.html b/classes/_octra_ngx_components.FixedConfigurationControlOptions.html index 830a6131d..f156e6adc 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

    Class FixedConfigurationControlOptions<R, S>

    Type Parameters

    • R
    • S = any

    Hierarchy (view full)

    Constructors

    constructor +FixedConfigurationControlOptions | Octra libraries - v2.0.0

    Class FixedConfigurationControlOptions<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

    Optional context

    context?: S

    Optional defaultValue

    defaultValue?: R

    dependsOn

    dependsOn: string[] = []

    Optional description

    description?: string

    ignore

    ignore: boolean = false

    Optional title

    title?: string

    toggleable

    toggleable: boolean = false

    type

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

    Optional value

    value?: R

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontextdefaultValuedependsOndescriptionignoretitletoggleabletypevalue
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional context

    context?: S

    Optional defaultValue

    defaultValue?: R

    dependsOn

    dependsOn: string[] = []

    Optional description

    description?: string

    ignore

    ignore: boolean = false

    Optional title

    title?: string

    toggleable

    toggleable: boolean = false

    type

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

    Optional value

    value?: R

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontextdefaultValuedependsOndescriptionignoretitletoggleabletypevalue
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.Interval.html b/classes/_octra_ngx_components.Interval.html index 0bf49dd9d..745cedb64 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

    Class Interval

    collections

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    end start -

    Constructors

    constructor

    Properties

    end

    end: number

    start

    start: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorendstart
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    end

    end: number

    start

    start: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorendstart
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.Margin.html b/classes/_octra_ngx_components.Margin.html index e80f0ccad..8d992db1f 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

    Class Margin

    Implements

    Constructors

    constructor +Margin | Octra libraries - v2.0.0

    Class Margin

    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

    Theme

    On This Page

    constructorbottomleftrighttop
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    bottom

    bottom: number

    left

    left: number

    right

    right: number

    top

    top: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorbottomleftrighttop
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.MultiThreadingService.html b/classes/_octra_ngx_components.MultiThreadingService.html index a8e0f9313..f69024da4 100644 --- a/classes/_octra_ngx_components.MultiThreadingService.html +++ b/classes/_octra_ngx_components.MultiThreadingService.html @@ -1,4 +1,4 @@ -MultiThreadingService | Octra libraries - v2.0.0

    Class MultiThreadingService

    Constructors

    constructor +MultiThreadingService | Octra libraries - v2.0.0

    Class MultiThreadingService

    Constructors

    constructor

    Properties

    _workers numberOfThreads subscrManager @@ -7,4 +7,4 @@ getBestWorker getStatistics run -

    Constructors

    constructor

    Properties

    Private _workers

    _workers: TsWorker[] = []

    Private numberOfThreads

    numberOfThreads: number = 2

    Private subscrManager

    subscrManager: SubscriptionManager<Subscription> = ...

    Accessors

    workers

    Methods

    destroy

    Private getBestWorker

    getStatistics

    run

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_workersnumberOfThreadssubscrManagerworkersdestroygetBestWorkergetStatisticsrun
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private _workers

    _workers: TsWorker[] = []

    Private numberOfThreads

    numberOfThreads: number = 2

    Private subscrManager

    subscrManager: SubscriptionManager<Subscription> = ...

    Accessors

    workers

    Methods

    destroy

    Private getBestWorker

    getStatistics

    run

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_workersnumberOfThreadssubscrManagerworkersdestroygetBestWorkergetStatisticsrun
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.OctraComponentsModule.html b/classes/_octra_ngx_components.OctraComponentsModule.html index 99c27405e..12b36755a 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

    Class OctraComponentsModule

    Constructors

    constructor +OctraComponentsModule | Octra libraries - v2.0.0

    Class OctraComponentsModule

    Constructors

    constructor

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    constructor
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.OctraFormGeneratorModule.html b/classes/_octra_ngx_components.OctraFormGeneratorModule.html index 5dfa18c2f..685fb3063 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

    Class OctraFormGeneratorModule

    Constructors

    constructor +OctraFormGeneratorModule | Octra libraries - v2.0.0

    Class OctraFormGeneratorModule

    Constructors

    constructor

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    constructor
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.Position.html b/classes/_octra_ngx_components.Position.html index 2299844e3..1f7e95c41 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

    Class Position

    Implements

    Implemented by

    Constructors

    constructor +Position | Octra libraries - v2.0.0

    Class Position

    Implements

    Implemented by

    Constructors

    constructor

    Properties

    x y -

    Constructors

    constructor

    Properties

    x

    x: number

    y

    y: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorxy
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    x

    x: number

    y

    y: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorxy
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.PreparedItem.html b/classes/_octra_ngx_components.PreparedItem.html index 50ddf0eef..42a42d19f 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

    Class PreparedItem

    Constructors

    constructor +PreparedItem | Octra libraries - v2.0.0

    Class PreparedItem

    Constructors

    constructor

    Properties

    selected value -

    Constructors

    constructor

    Properties

    selected

    selected: boolean = false

    value

    value: any

    Settings

    Member Visibility

    Theme

    On This Page

    constructorselectedvalue
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    selected

    selected: boolean = false

    value

    value: any

    Settings

    Member Visibility

    Theme

    On This Page

    constructorselectedvalue
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.Rectangle.html b/classes/_octra_ngx_components.Rectangle.html index d549c7af1..dd67e3ee1 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

    Class Rectangle

    SHAPES

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    position size -

    Constructors

    constructor

    Properties

    position

    position: Position

    size

    size: Size

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpositionsize
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    position

    position: Position

    size

    size: Size

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpositionsize
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.Size.html b/classes/_octra_ngx_components.Size.html index 11cbe53a0..681b9e1d9 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

    Class Size

    Implements

    Constructors

    constructor +Size | Octra libraries - v2.0.0

    Class Size

    Implements

    Constructors

    constructor

    Properties

    height width -

    Constructors

    constructor

    Properties

    height

    height: number

    width

    width: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorheightwidth
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    height

    height: number

    width

    width: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorheightwidth
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ToolConfigArrayAdderComponent.html b/classes/_octra_ngx_components.ToolConfigArrayAdderComponent.html index 1de281d1b..7baaf8f86 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

    Class ToolConfigArrayAdderComponent

    Hierarchy (view full)

    Constructors

    constructor +ToolConfigArrayAdderComponent | Octra libraries - v2.0.0

    Class ToolConfigArrayAdderComponent

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _items disabled inputValue @@ -13,5 +13,5 @@ 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

    Protected subscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Optional type

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

    uniqueItems

    uniqueItems: boolean = false

    values

    values: any[] = []

    Methods

    add

    ngOnDestroy

    open

    Protected subscribe

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_itemsdisabledinputValueitemsitemsAddpopoversubscriptionManagertypeuniqueItemsvaluesaddngOnDestroyopensubscribe
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected _items

    _items: PreparedItem[] = []

    disabled

    disabled: boolean = false

    inputValue

    inputValue: any

    items

    items: any[] = []

    itemsAdd

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

    popover

    popover: NgbPopover

    Protected subscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Optional type

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

    uniqueItems

    uniqueItems: boolean = false

    values

    values: any[] = []

    Methods

    add

    ngOnDestroy

    open

    Protected subscribe

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_itemsdisabledinputValueitemsitemsAddpopoversubscriptionManagertypeuniqueItemsvaluesaddngOnDestroyopensubscribe
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ToolConfiguratorComponent.html b/classes/_octra_ngx_components.ToolConfiguratorComponent.html index 32e721d18..d1bfcddfb 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

    Class ToolConfiguratorComponent

    Hierarchy (view full)

    Implements

    • OnChanges

    Constructors

    constructor +ToolConfiguratorComponent | Octra libraries - v2.0.0

    Class ToolConfiguratorComponent

    Hierarchy (view full)

    Implements

    • OnChanges

    Constructors

    constructor

    Properties

    form? json? jsonSchema? @@ -11,5 +11,5 @@ onSomethingChanged parse subscribe -

    Constructors

    constructor

    Properties

    Optional form

    form?: ConfigurationControlGroup

    Optional json

    json?: any

    Optional jsonSchema

    jsonSchema?: any

    Optional jsonText

    jsonText?: string

    jsonTextChange

    jsonTextChange: EventEmitter<string> = ...

    Private ownChange

    ownChange: boolean = false

    Protected subscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Methods

    ngOnChanges

    ngOnDestroy

    onSomethingChanged

    Private parse

    Protected subscribe

    Settings

    Member Visibility

    Theme

    On This Page

    constructorformjsonjsonSchemajsonTextjsonTextChangeownChangesubscriptionManagerngOnChangesngOnDestroyonSomethingChangedparsesubscribe
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional form

    form?: ConfigurationControlGroup

    Optional json

    json?: any

    Optional jsonSchema

    jsonSchema?: any

    Optional jsonText

    jsonText?: string

    jsonTextChange

    jsonTextChange: EventEmitter<string> = ...

    Private ownChange

    ownChange: boolean = false

    Protected subscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Methods

    ngOnChanges

    ngOnDestroy

    onSomethingChanged

    Private parse

    Protected subscribe

    Settings

    Member Visibility

    Theme

    On This Page

    constructorformjsonjsonSchemajsonTextjsonTextChangeownChangesubscriptionManagerngOnChangesngOnDestroyonSomethingChangedparsesubscribe
    \ No newline at end of file diff --git a/classes/_octra_ngx_components.ToolconfigGroupComponent.html b/classes/_octra_ngx_components.ToolconfigGroupComponent.html index f6056d668..921b97a3a 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

    Class ToolconfigGroupComponent

    Hierarchy (view full)

    Constructors

    constructor +ToolconfigGroupComponent | Octra libraries - v2.0.0

    Class ToolconfigGroupComponent

    Hierarchy (view full)

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Optional group

    group?: ConfigurationControlGroup

    somethingChanged

    somethingChanged: EventEmitter<void> = ...

    Protected subscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Methods

    ngOnDestroy

    onArrayItemAdd

    onArrayItemDelete

    Protected subscribe

    Settings

    Member Visibility

    Theme

    On This Page

    constructorgroupsomethingChangedsubscriptionManagerngOnDestroyonArrayItemAddonArrayItemDeletesubscribe
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional group

    group?: ConfigurationControlGroup

    somethingChanged

    somethingChanged: EventEmitter<void> = ...

    Protected subscriptionManager

    subscriptionManager: SubscriptionManager<Subscription> = ...

    Methods

    ngOnDestroy

    onArrayItemAdd

    onArrayItemDelete

    Protected subscribe

    Settings

    Member Visibility

    Theme

    On This Page

    constructorgroupsomethingChangedsubscriptionManagerngOnDestroyonArrayItemAddonArrayItemDeletesubscribe
    \ No newline at end of file diff --git a/classes/_octra_ngx_utilities.CapitalLetterPipe.html b/classes/_octra_ngx_utilities.CapitalLetterPipe.html index 6495468a1..3e85ebb38 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

    Class CapitalLetterPipe

    Implements

    • PipeTransform

    Constructors

    constructor +CapitalLetterPipe | Octra libraries - v2.0.0

    Class CapitalLetterPipe

    Implements

    • PipeTransform

    Constructors

    constructor

    Methods

    transform -

    Constructors

    constructor

    Methods

    transform

    Settings

    Member Visibility

    Theme

    On This Page

    constructortransform
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    transform

    Settings

    Member Visibility

    Theme

    On This Page

    constructortransform
    \ No newline at end of file diff --git a/classes/_octra_ngx_utilities.JoinPipe.html b/classes/_octra_ngx_utilities.JoinPipe.html index cd732bb7c..76e7a79da 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

    Class JoinPipe

    Implements

    • PipeTransform

    Constructors

    constructor +JoinPipe | Octra libraries - v2.0.0

    Class JoinPipe

    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

    Theme

    On This Page

    constructortransform
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    transform

    • transform(value, options): string

    • Parameters

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

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    constructortransform
    \ No newline at end of file diff --git a/classes/_octra_ngx_utilities.LeadingNullPipe.html b/classes/_octra_ngx_utilities.LeadingNullPipe.html index f4fd47373..6d794329d 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

    Class LeadingNullPipe

    Implements

    • PipeTransform

    Constructors

    constructor +LeadingNullPipe | Octra libraries - v2.0.0

    Class LeadingNullPipe

    Implements

    • PipeTransform

    Constructors

    constructor

    Methods

    transform -

    Constructors

    constructor

    Methods

    transform

    • transform(value, maxnum): any

    • Parameters

      • value: any
      • maxnum: number

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    constructortransform
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    transform

    • transform(value, maxnum): any

    • Parameters

      • value: any
      • maxnum: number

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    constructortransform
    \ No newline at end of file diff --git a/classes/_octra_ngx_utilities.MapPipe.html b/classes/_octra_ngx_utilities.MapPipe.html index 79c612c9b..afd2587b2 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

    Class MapPipe

    Implements

    • PipeTransform

    Constructors

    constructor +MapPipe | Octra libraries - v2.0.0

    Class MapPipe

    Implements

    • PipeTransform

    Constructors

    constructor

    Methods

    transform -

    Constructors

    constructor

    Methods

    transform

    • transform(value, options): any[]

    • Parameters

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

            • Parameters

              • a: any

              Returns any

      Returns any[]

    Settings

    Member Visibility

    Theme

    On This Page

    constructortransform
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    transform

    • transform(value, options): any[]

    • Parameters

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

            • Parameters

              • a: any

              Returns any

      Returns any[]

    Settings

    Member Visibility

    Theme

    On This Page

    constructortransform
    \ No newline at end of file diff --git a/classes/_octra_ngx_utilities.OctraUtilitiesModule.html b/classes/_octra_ngx_utilities.OctraUtilitiesModule.html index 6306cfc3e..1e5e8824c 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

    Class OctraUtilitiesModule

    Constructors

    constructor +OctraUtilitiesModule | Octra libraries - v2.0.0

    Class OctraUtilitiesModule

    Constructors

    constructor

    Constructors

    constructor

    Settings

    Member Visibility

    Theme

    On This Page

    constructor
    \ No newline at end of file diff --git a/classes/_octra_ngx_utilities.ProcentPipe.html b/classes/_octra_ngx_utilities.ProcentPipe.html index 5f66679bc..c445d19c9 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

    Class ProcentPipe

    Implements

    • PipeTransform

    Constructors

    constructor +ProcentPipe | Octra libraries - v2.0.0

    Class ProcentPipe

    Implements

    • PipeTransform

    Constructors

    constructor

    Methods

    transform -

    Constructors

    constructor

    Methods

    transform

    Settings

    Member Visibility

    Theme

    On This Page

    constructortransform
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    transform

    Settings

    Member Visibility

    Theme

    On This Page

    constructortransform
    \ No newline at end of file diff --git a/classes/_octra_ngx_utilities.SubscriberComponent.html b/classes/_octra_ngx_utilities.SubscriberComponent.html index 2375d9127..cb6417fef 100644 --- a/classes/_octra_ngx_utilities.SubscriberComponent.html +++ b/classes/_octra_ngx_utilities.SubscriberComponent.html @@ -1,6 +1,6 @@ -SubscriberComponent | Octra libraries - v2.0.0

    Class SubscriberComponent

    Hierarchy

    • SubscriberComponent

      Implements

      • OnDestroy

      Constructors

      constructor +SubscriberComponent | Octra libraries - v2.0.0

      Class SubscriberComponent

      Hierarchy

      • SubscriberComponent

        Implements

        • OnDestroy

        Constructors

        constructor

        Properties

        subscriptionManager

        Methods

        ngOnDestroy subscribe -

        Constructors

        constructor

        Properties

        Protected subscriptionManager

        subscriptionManager: SubscriptionManager<Subscription> = ...

        Methods

        ngOnDestroy

        Protected subscribe

        • 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>
          • Optional observerOrNext: Partial<Observer<R>> | ((value) => void)
          • Optional tag: string

          Returns number

        Settings

        Member Visibility

        Theme

        On This Page

        constructorsubscriptionManagerngOnDestroysubscribe
        \ No newline at end of file +

        Constructors

        constructor

        Properties

        Protected subscriptionManager

        subscriptionManager: SubscriptionManager<Subscription> = ...

        Methods

        ngOnDestroy

        Protected subscribe

        • 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>
          • Optional observerOrNext: Partial<Observer<R>> | ((value) => void)
          • Optional tag: string

          Returns number

        Settings

        Member Visibility

        Theme

        On This Page

        constructorsubscriptionManagerngOnDestroysubscribe
        \ No newline at end of file diff --git a/classes/_octra_ngx_utilities.TimespanPipe.html b/classes/_octra_ngx_utilities.TimespanPipe.html index 67ddfeac2..523f364e3 100644 --- a/classes/_octra_ngx_utilities.TimespanPipe.html +++ b/classes/_octra_ngx_utilities.TimespanPipe.html @@ -1,4 +1,4 @@ -TimespanPipe | Octra libraries - v2.0.0

        Class TimespanPipe

        Implements

        • PipeTransform

        Constructors

        constructor +TimespanPipe | Octra libraries - v2.0.0

        Class TimespanPipe

        Implements

        • PipeTransform

        Constructors

        constructor

        Properties

        timespan

        Accessors

        Hours MilliSeconds @@ -6,7 +6,7 @@ Seconds

        Methods

        formatNumber transform -

        Constructors

        constructor

        Properties

        Private timespan

        timespan: number = 0

        Accessors

        Private Hours

        Private MilliSeconds

        Private Minutes

        Private Seconds

        Methods

        Private formatNumber

        transform

        • transform(value, args?): any

        • transforms milliseconds to time string

          +

        Constructors

        constructor

        Properties

        Private timespan

        timespan: number = 0

        Accessors

        Private Hours

        Private MilliSeconds

        Private Minutes

        Private Seconds

        Methods

        Private formatNumber

        transform

        • transform(value, args?): any

        • transforms milliseconds to time string

          Parameters

          • value: undefined | number

            number or milliseconds

          • Optional args: {
                maxDuration?: number;
                showHour?: boolean;
                showMilliSeconds?: boolean;
            }

            [showHour, showMilliSeconds]

            -
            • Optional maxDuration?: number
            • Optional showHour?: boolean
            • Optional showMilliSeconds?: boolean

          Returns any

        Settings

        Member Visibility

        Theme

        On This Page

        constructortimespanHoursMilliSecondsMinutesSecondsformatNumbertransform
        \ No newline at end of file +
        • Optional maxDuration?: number
        • Optional showHour?: boolean
        • Optional showMilliSeconds?: boolean

        Returns any

        Settings

        Member Visibility

        Theme

        On This Page

        constructortimespanHoursMilliSecondsMinutesSecondsformatNumbertransform
        \ No newline at end of file diff --git a/classes/_octra_ngx_utilities.UnixDurationPipe.html b/classes/_octra_ngx_utilities.UnixDurationPipe.html index 4c0d2efe7..c84c1a7ac 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

        Class UnixDurationPipe

        Implements

        • PipeTransform

        Constructors

        constructor +UnixDurationPipe | Octra libraries - v2.0.0

        Class UnixDurationPipe

        Implements

        • PipeTransform

        Constructors

        constructor

        Methods

        transform -

        Constructors

        constructor

        Methods

        transform

        Settings

        Member Visibility

        Theme

        On This Page

        constructortransform
        \ No newline at end of file +

        Constructors

        constructor

        Methods

        transform

        Settings

        Member Visibility

        Theme

        On This Page

        constructortransform
        \ No newline at end of file diff --git a/classes/_octra_utilities.SerializableClass.html b/classes/_octra_utilities.SerializableClass.html index ae522a9bc..0caa5d955 100644 --- a/classes/_octra_utilities.SerializableClass.html +++ b/classes/_octra_utilities.SerializableClass.html @@ -1,3 +1,3 @@ -SerializableClass | Octra libraries - v2.0.0

        Class SerializableClass<S, T>Abstract

        Type Parameters

        • S
        • T

        Constructors

        constructor +SerializableClass | Octra libraries - v2.0.0

        Class SerializableClass<S, T>Abstract

        Type Parameters

        • S
        • T

        Constructors

        constructor

        Methods

        deserializable -

        Constructors

        constructor

        Methods

        Static deserializable

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

        • Type Parameters

          • S
          • T

          Parameters

          • jsonObject: S
          • sampleRate: number

          Returns undefined | T

        Settings

        Member Visibility

        Theme

        On This Page

        constructordeserializable
        \ No newline at end of file +

        Constructors

        constructor

        Methods

        Static deserializable

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

        • Type Parameters

          • S
          • T

          Parameters

          • jsonObject: S
          • sampleRate: number

          Returns undefined | T

        Settings

        Member Visibility

        Theme

        On This Page

        constructordeserializable
        \ No newline at end of file diff --git a/classes/_octra_utilities.SubscriptionManager.html b/classes/_octra_utilities.SubscriptionManager.html index c1f17ca2f..38ee86d57 100644 --- a/classes/_octra_utilities.SubscriptionManager.html +++ b/classes/_octra_utilities.SubscriptionManager.html @@ -1,17 +1,17 @@ -SubscriptionManager | Octra libraries - v2.0.0

        Class SubscriptionManager<T>

        Type Parameters

        • T

        Constructors

        constructor +SubscriptionManager | Octra libraries - v2.0.0

        Class SubscriptionManager<T>

        Type Parameters

        • T

        Constructors

        constructor

        Properties

        counter subscriptions

        Methods

        add destroy removeById removeByTag -

        Constructors

        constructor

        Properties

        Private counter

        counter: number

        Private subscriptions

        subscriptions: {
            id: number;
            subscription: T;
            tag?: string;
        }[]

        Type declaration

        • id: number
        • subscription: T
        • Optional tag?: string

        Methods

        add

        • add(subscription, tag?): number

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

          +

        Constructors

        constructor

        Properties

        Private counter

        counter: number

        Private subscriptions

        subscriptions: {
            id: number;
            subscription: T;
            tag?: string;
        }[]

        Type declaration

        • id: number
        • subscription: T
        • Optional tag?: string

        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

          • Optional tag: 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

        Theme

        On This Page

        constructorcountersubscriptionsadddestroyremoveByIdremoveByTag
        \ No newline at end of file +

        Returns boolean

        Settings

        Member Visibility

        Theme

        On This Page

        constructorcountersubscriptionsadddestroyremoveByIdremoveByTag
        \ No newline at end of file diff --git a/classes/_octra_web_media.AudioChunk.html b/classes/_octra_web_media.AudioChunk.html index fa79a3cbe..97bc43d48 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

        Class AudioChunk

        AUDIOCHUNK begins here

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        _audioManger _id _lastplayedpos @@ -40,7 +40,7 @@ stepBackward stepBackwardTime toggleReplay -

        Constructors

        constructor

        Properties

        Private Readonly _audioManger

        _audioManger: AudioManager

        Private Readonly _id

        _id: number

        Private _lastplayedpos

        _lastplayedpos: SampleUnit

        Private _playposition

        _playposition: SampleUnit

        Private _replay

        _replay: boolean = false

        Private _selection

        _selection: AudioSelection

        Private _status

        _status: PlayBackStatus = PlayBackStatus.PREPARE

        Private _time

        _time: AudioSelection

        Private _volume

        _volume: number = 1

        statuschange

        statuschange: Subject<PlayBackStatus> = ...

        stopPlayback

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

        stops the playback

        -

        Type declaration

          • (): Promise<void>

          • Returns Promise<void>

        Private subscrManager

        subscrManager: SubscriptionManager<Subscription> = ...

        Private Static _counter

        _counter: number = 0

        Accessors

        absolutePlayposition

        audioManager

        id

        isPlayBackStopped

        isPlaybackEnded

        isPlaybackStarted

        isPlaying

        lastplayedpos

        playbackRate

        relativePlayposition

        replay

        sampleRate

        selection

        startpos

        Constructors

        constructor

        Properties

        Private Readonly _audioManger

        _audioManger: AudioManager

        Private Readonly _id

        _id: number

        Private _lastplayedpos

        _lastplayedpos: SampleUnit

        Private _playposition

        _playposition: SampleUnit

        Private _replay

        _replay: boolean = false

        Private _selection

        _selection: AudioSelection

        Private _status

        _status: PlayBackStatus = PlayBackStatus.PREPARE

        Private _time

        _time: AudioSelection

        Private _volume

        _volume: number = 1

        statuschange

        statuschange: Subject<PlayBackStatus> = ...

        stopPlayback

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

        stops the playback

        +

        Type declaration

          • (): Promise<void>

          • Returns Promise<void>

        Private subscrManager

        subscrManager: SubscriptionManager<Subscription> = ...

        Private Static _counter

        _counter: number = 0

        Accessors

        absolutePlayposition

        audioManager

        id

        isPlayBackStopped

        isPlaybackEnded

        isPlaybackStarted

        isPlaying

        lastplayedpos

        playbackRate

        relativePlayposition

        replay

        sampleRate

        selection

        startpos

        status

        time

        volume

        Methods

        Private afterPlaybackPaused

        Private afterPlaybackStopped

        clone

        destroy

        pausePlayback

        Private setState

        startPlayback

        stepBackward

        stepBackwardTime

        toggleReplay

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_audioManger_id_lastplayedpos_playposition_replay_selection_status_time_volumestatuschangestopPlaybacksubscrManager_counterabsolutePlaypositionaudioManageridisPlayBackStoppedisPlaybackEndedisPlaybackStartedisPlayinglastplayedposplaybackRaterelativePlaypositionreplaysampleRateselectionstartposstatustimevolumeafterPlaybackPausedafterPlaybackStoppedclonedestroypausePlaybacksetStatestartPlaybackstepBackwardstepBackwardTimetoggleReplay
        \ No newline at end of file +

        Parameters

        Returns void

        status

        time

        volume

        Methods

        Private afterPlaybackPaused

        Private afterPlaybackStopped

        clone

        destroy

        pausePlayback

        Private setState

        startPlayback

        stepBackward

        stepBackwardTime

        toggleReplay

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_audioManger_id_lastplayedpos_playposition_replay_selection_status_time_volumestatuschangestopPlaybacksubscrManager_counterabsolutePlaypositionaudioManageridisPlayBackStoppedisPlaybackEndedisPlaybackStartedisPlayinglastplayedposplaybackRaterelativePlaypositionreplaysampleRateselectionstartposstatustimevolumeafterPlaybackPausedafterPlaybackStoppedclonedestroypausePlaybacksetStatestartPlaybackstepBackwardstepBackwardTimetoggleReplay
        \ No newline at end of file diff --git a/classes/_octra_web_media.AudioDecoder.html b/classes/_octra_web_media.AudioDecoder.html index 8f9b8a668..9ea2ac4e9 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

        Class AudioDecoder

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

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        afterChannelDataFinished? audioContext audioInfo @@ -25,5 +25,5 @@ insertChannelBuffer minimizeChannelData requeststopDecoding -

        Constructors

        constructor

        Properties

        Private Optional afterChannelDataFinished

        afterChannelDataFinished?: Subject<void>

        Private audioContext

        audioContext: AudioContext

        Private audioInfo

        audioInfo: AudioInfo

        Private Optional channelData

        channelData?: Float32Array

        Private channelDataOffset

        channelDataOffset: number = 0

        Private Readonly format

        format: AudioFormat

        Private joblist

        joblist: {
            duration: number;
            jobId: number;
            start: number;
        }[] = []

        Type declaration

        • duration: number
        • jobId: number
        • start: number

        Private nextWorker

        nextWorker: number = 0

        onChannelDataCalculate

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

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

        -

        Type declaration

        • progress: number
        • Optional result?: Float32Array

        Private parallelJobs

        parallelJobs: number = 2

        started

        started: number = 0

        Private stopDecoding

        stopDecoding: boolean = false

        Private subscriptionManager

        subscriptionManager: SubscriptionManager<unknown> = ...

        Private tsWorkers

        tsWorkers: TsWorker[]

        Private Optional uint8Array

        uint8Array?: Uint8Array

        Private writtenChannel

        writtenChannel: number = 0

        Accessors

        channelDataFactor

        Methods

        Private addJobToWorker

        createOriginalSample

        destroy

        Private getChannelData

        • getChannelData(data, sampleDuration, bitsPerSample): Promise<Float32Array>

        • Parameters

          • data: IntArray
          • sampleDuration: number
          • bitsPerSample: number

          Returns Promise<Float32Array>

        getChunkedChannelData

        Private insertChannelBuffer

        minimizeChannelData

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

        • Parameters

          • channelData: Float32Array
          • factor: number

          Returns Promise<Float32Array>

        requeststopDecoding

        Settings

        Member Visibility

        Theme

        On This Page

        constructorafterChannelDataFinishedaudioContextaudioInfochannelDatachannelDataOffsetformatjoblistnextWorkeronChannelDataCalculateparallelJobsstartedstopDecodingsubscriptionManagertsWorkersuint8ArraywrittenChannelchannelDataFactoraddJobToWorkercreateOriginalSampledestroygetChannelDatagetChunkedChannelDatainsertChannelBufferminimizeChannelDatarequeststopDecoding
        \ No newline at end of file +

        Constructors

        constructor

        Properties

        Private Optional afterChannelDataFinished

        afterChannelDataFinished?: Subject<void>

        Private audioContext

        audioContext: AudioContext

        Private audioInfo

        audioInfo: AudioInfo

        Private Optional channelData

        channelData?: Float32Array

        Private channelDataOffset

        channelDataOffset: number = 0

        Private Readonly format

        format: AudioFormat

        Private joblist

        joblist: {
            duration: number;
            jobId: number;
            start: number;
        }[] = []

        Type declaration

        • duration: number
        • jobId: number
        • start: number

        Private nextWorker

        nextWorker: number = 0

        onChannelDataCalculate

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

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

        +

        Type declaration

        • progress: number
        • Optional result?: Float32Array

        Private parallelJobs

        parallelJobs: number = 2

        started

        started: number = 0

        Private stopDecoding

        stopDecoding: boolean = false

        Private subscriptionManager

        subscriptionManager: SubscriptionManager<unknown> = ...

        Private tsWorkers

        tsWorkers: TsWorker[]

        Private Optional uint8Array

        uint8Array?: Uint8Array

        Private writtenChannel

        writtenChannel: number = 0

        Accessors

        channelDataFactor

        Methods

        Private addJobToWorker

        createOriginalSample

        destroy

        Private getChannelData

        getChunkedChannelData

        Private insertChannelBuffer

        minimizeChannelData

        requeststopDecoding

        Settings

        Member Visibility

        Theme

        On This Page

        constructorafterChannelDataFinishedaudioContextaudioInfochannelDatachannelDataOffsetformatjoblistnextWorkeronChannelDataCalculateparallelJobsstartedstopDecodingsubscriptionManagertsWorkersuint8ArraywrittenChannelchannelDataFactoraddJobToWorkercreateOriginalSampledestroygetChannelDatagetChunkedChannelDatainsertChannelBufferminimizeChannelDatarequeststopDecoding
        \ No newline at end of file diff --git a/classes/_octra_web_media.AudioFormat.html b/classes/_octra_web_media.AudioFormat.html index ebb948266..e101e494e 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

        Class AudioFormatAbstract

        Hierarchy (view full)

        Constructors

        constructor +AudioFormat | Octra libraries - v2.0.0

        Class AudioFormatAbstract

        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

        Abstract isValid

        Protected Abstract setBitsPerSample

        Protected Abstract setByteRate

        Protected Abstract setChannels

        Protected Abstract setDuration

        Protected Abstract setSampleRate

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_bitsPerSample_byteRate_channels_duration_extension_filename_sampleRateformatConstructorbitsPerSamplebyteRatechannelsdurationextensionfilenamesampleRateinitisValidsetBitsPerSamplesetByteRatesetChannelssetDurationsetSampleRate
        \ No newline at end of file +

        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

        Abstract isValid

        Protected Abstract setBitsPerSample

        Protected Abstract setByteRate

        Protected Abstract setChannels

        Protected Abstract setDuration

        Protected Abstract setSampleRate

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_bitsPerSample_byteRate_channels_duration_extension_filename_sampleRateformatConstructorbitsPerSamplebyteRatechannelsdurationextensionfilenamesampleRateinitisValidsetBitsPerSamplesetByteRatesetChannelssetDurationsetSampleRate
        \ No newline at end of file diff --git a/classes/_octra_web_media.AudioInfo.html b/classes/_octra_web_media.AudioInfo.html index e08da701f..a78578ce5 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

        Class AudioInfo

        Hierarchy (view full)

        Constructors

        constructor +AudioInfo | Octra libraries - v2.0.0

        Class AudioInfo

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        _bitrate _channels _duration @@ -39,7 +39,7 @@ getFileFromContent getMimeTypeByExtension renameFile -

        Constructors

        constructor

        Properties

        Private Readonly _bitrate

        _bitrate: number = -1

        Private Readonly _channels

        _channels: number = -1

        Private _duration

        _duration: SampleUnit

        Protected _extension

        _extension: string

        Protected _file

        _file: undefined | File

        Protected Optional _hash

        _hash?: string

        Protected _name

        _name: string

        Private Readonly _sampleRate

        _sampleRate: number

        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

        name

        online

        sampleRate

        size

        type

        url

        Methods

        getBase64

        isMediaFile

        toAny

        updateContentFromURL

        Static escapeFileName

        Static extractFileName

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

        • Parameters

          • fullname: string

          Returns {
              extension: string;
              name: string;
          }

          • extension: string
          • name: string

        Static fromAny

        Static fromFileObject

        Static fromURL

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

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

          -

          Parameters

          • url: string
          • Optional type: string
          • Optional name: string
          • createdAt: number = 0
          • Optional size: number

          Returns FileInfo

        Static getFileContent

        Static getFileFromContent

        Static getMimeTypeByExtension

        • 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"

        Static renameFile

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_bitrate_channels_duration_extension_file_hash_name_sampleRate_size_type_urlattributesavailablebitratechannelscreatedAtdurationextensionfilefullnamehashnameonlinesampleRatesizetypeurlgetBase64isMediaFiletoAnyupdateContentFromURLescapeFileNameextractFileNamefromAnyfromFileObjectfromURLgetFileContentgetFileFromContentgetMimeTypeByExtensionrenameFile
        \ No newline at end of file +

        Constructors

        constructor

        Properties

        Private Readonly _bitrate

        _bitrate: number = -1

        Private Readonly _channels

        _channels: number = -1

        Private _duration

        _duration: SampleUnit

        Protected _extension

        _extension: string

        Protected _file

        _file: undefined | File

        Protected Optional _hash

        _hash?: string

        Protected _name

        _name: string

        Private Readonly _sampleRate

        _sampleRate: number

        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

        name

        online

        sampleRate

        size

        type

        url

        Methods

        getBase64

        isMediaFile

        toAny

        updateContentFromURL

        Static escapeFileName

        Static extractFileName

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

        • Parameters

          • fullname: string

          Returns {
              extension: string;
              name: string;
          }

          • extension: string
          • name: string

        Static fromAny

        Static fromFileObject

        Static fromURL

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

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

          +

          Parameters

          • url: string
          • Optional type: string
          • Optional name: string
          • createdAt: number = 0
          • Optional size: number

          Returns FileInfo

        Static getFileContent

        Static getFileFromContent

        Static getMimeTypeByExtension

        • 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"

        Static renameFile

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_bitrate_channels_duration_extension_file_hash_name_sampleRate_size_type_urlattributesavailablebitratechannelscreatedAtdurationextensionfilefullnamehashnameonlinesampleRatesizetypeurlgetBase64isMediaFiletoAnyupdateContentFromURLescapeFileNameextractFileNamefromAnyfromFileObjectfromURLgetFileContentgetFileFromContentgetMimeTypeByExtensionrenameFile
        \ No newline at end of file diff --git a/classes/_octra_web_media.AudioManager.html b/classes/_octra_web_media.AudioManager.html index cb512aaba..3c8b33e53 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

        Class AudioManager

        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

        _audioMechanism _gainNode? _id @@ -36,17 +36,17 @@ getNumberOfDataParts isValidAudioFileName

        Constructors

        constructor

        Properties

        Private _audioMechanism

        _audioMechanism: AudioMechanism

        Private Optional _gainNode

        _gainNode?: GainNode

        Private _id

        _id: number

        Private _mainchunk

        _mainchunk: AudioChunk

        Private _playOnHover

        _playOnHover: boolean = false

        Private chunks

        chunks: AudioChunk[] = []

        Private subscrManager

        subscrManager: SubscriptionManager<Subscription>

        time

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

        Type declaration

        • end: number
        • start: number

        Private Static counter

        counter: number = 0

        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

        Static create

        • 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
          • Optional url: string
          • audioMechanism: AudioMechanism = ...

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

        Static getFileFormat

        Properties

        Private _audioMechanism

        _audioMechanism: AudioMechanism

        Private Optional _gainNode

        _gainNode?: GainNode

        Private _id

        _id: number

        Private _mainchunk

        _mainchunk: AudioChunk

        Private _playOnHover

        _playOnHover: boolean = false

        Private chunks

        chunks: AudioChunk[] = []

        Private subscrManager

        subscrManager: SubscriptionManager<Subscription>

        time

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

        Type declaration

        • end: number
        • start: number

        Private Static counter

        counter: number = 0

        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

        Static create

        • 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
          • Optional url: string
          • audioMechanism: AudioMechanism = ...

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

        Static getFileFormat

        • 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

        Static getNumberOfDataParts

        • getNumberOfDataParts(fileSize): number

        • returns the number of data parts

          -

          Parameters

          • fileSize: number

          Returns number

        Static isValidAudioFileName

        • 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

        Theme

        On This Page

        constructor_audioMechanism_gainNode_id_mainchunk_playOnHoverchunkssubscrManagertimecounteraudioMechanismchannelchannelDataFactorgainNodeisPlayingmainchunkonChannelDataChangeplayOnHoverplayPositionresourcesampleRatestatestatechangeaddChunkcreateNewAudioChunkcreateSampleUnitdestroypausePlaybackremoveChunkstartPlaybackstopDecodingstopPlaybackcreategetFileFormatgetNumberOfDataPartsisValidAudioFileName
        \ No newline at end of file +

        Returns undefined | AudioFormat

        Static getNumberOfDataParts

        Static isValidAudioFileName

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_audioMechanism_gainNode_id_mainchunk_playOnHoverchunkssubscrManagertimecounteraudioMechanismchannelchannelDataFactorgainNodeisPlayingmainchunkonChannelDataChangeplayOnHoverplayPositionresourcesampleRatestatestatechangeaddChunkcreateNewAudioChunkcreateSampleUnitdestroypausePlaybackremoveChunkstartPlaybackstopDecodingstopPlaybackcreategetFileFormatgetNumberOfDataPartsisValidAudioFileName
        \ No newline at end of file diff --git a/classes/_octra_web_media.AudioResource.html b/classes/_octra_web_media.AudioResource.html index 364c38555..9e1d7c997 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

        Class AudioResource

        Hierarchy

        • MediaResource
          • AudioResource

        Constructors

        constructor +AudioResource | Octra libraries - v2.0.0

        Class AudioResource

        Hierarchy

        • MediaResource
          • AudioResource

        Constructors

        constructor

        Properties

        _info

        Accessors

        arraybuffer extension @@ -7,4 +7,4 @@ size url

        Methods

        getOAudioFile -

        Constructors

        constructor

        Properties

        Private _info

        _info: AudioInfo

        Accessors

        arraybuffer

        • get arraybuffer(): undefined | ArrayBuffer

        • Returns undefined | ArrayBuffer

        • set arraybuffer(value): void

        • Parameters

          • value: undefined | ArrayBuffer

          Returns void

        extension

        info

        name

        size

        • get size(): undefined | number

        • Returns undefined | number

        url

        • get url(): undefined | string

        • Returns undefined | string

        Methods

        getOAudioFile

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_infoarraybufferextensioninfonamesizeurlgetOAudioFile
        \ No newline at end of file +

        Constructors

        constructor

        Properties

        Private _info

        _info: AudioInfo

        Accessors

        arraybuffer

        • get arraybuffer(): undefined | ArrayBuffer

        • Returns undefined | ArrayBuffer

        • set arraybuffer(value): void

        • Parameters

          • value: undefined | ArrayBuffer

          Returns void

        extension

        info

        name

        size

        • get size(): undefined | number

        • Returns undefined | number

        url

        • get url(): undefined | string

        • Returns undefined | string

        Methods

        getOAudioFile

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_infoarraybufferextensioninfonamesizeurlgetOAudioFile
        \ No newline at end of file diff --git a/classes/_octra_web_media.AudioTimeCalculator.html b/classes/_octra_web_media.AudioTimeCalculator.html index c7ca4a45f..6301d05bd 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

        Class AudioTimeCalculator

        Constructors

        constructor +AudioTimeCalculator | Octra libraries - v2.0.0

        Class AudioTimeCalculator

        Constructors

        constructor

        Properties

        _duration audioPxWidth

        Accessors

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

        Constructors

        constructor

        Properties

        _duration

        _duration: SampleUnit

        audioPxWidth

        audioPxWidth: number

        Accessors

        duration

        Methods

        absXChunktoSampleUnit

        absXtoSamples2

        samplesToSeconds

        samplestoAbsX

        secondsToSamples

        Static roundSamples

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_durationaudioPxWidthdurationabsXChunktoSampleUnitabsXtoSamples2samplesToSecondssamplestoAbsXsecondsToSamplesroundSamples
        \ No newline at end of file +

        Constructors

        constructor

        Properties

        _duration

        _duration: SampleUnit

        audioPxWidth

        audioPxWidth: number

        Accessors

        duration

        Methods

        absXChunktoSampleUnit

        absXtoSamples2

        samplesToSeconds

        samplestoAbsX

        secondsToSamples

        Static roundSamples

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_durationaudioPxWidthdurationabsXChunktoSampleUnitabsXtoSamples2samplesToSecondssamplestoAbsXsecondsToSamplesroundSamples
        \ No newline at end of file diff --git a/classes/_octra_web_media.BrowserInfo.html b/classes/_octra_web_media.BrowserInfo.html index eb4f7ddea..e81fbdf9b 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

        Class BrowserInfo

        Constructors

        constructor +BrowserInfo | Octra libraries - v2.0.0

        Class BrowserInfo

        Constructors

        constructor

        Accessors

        browser os platform version

        Constructors

        constructor

        Accessors

        Static browser

        • get browser(): undefined | string

        • returns the browser name

          -

          Returns undefined | string

        Static os

        Static platform

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

        • returns if current system is mac or pc.

          -

          Returns "mac" | "pc"

        Static version

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbrowserosplatformversion
        \ No newline at end of file +

        Returns undefined | string

        Static os

        Static platform

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

        • returns if current system is mac or pc.

          +

          Returns "mac" | "pc"

        Static version

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbrowserosplatformversion
        \ No newline at end of file diff --git a/classes/_octra_web_media.DataInfo.html b/classes/_octra_web_media.DataInfo.html index 01aa12e83..f61744d5a 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

        Class DataInfo

        Hierarchy (view full)

        Constructors

        constructor +DataInfo | Octra libraries - v2.0.0

        Class DataInfo

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        _attributes _hash? _name @@ -9,4 +9,4 @@ name size type -

        Constructors

        constructor

        Properties

        Private _attributes

        _attributes: {} = {}

        Type declaration

          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

          Theme

          On This Page

          constructor_attributes_hash_name_size_typeattributeshashnamesizetype
          \ No newline at end of file +

          Constructors

          constructor

          Properties

          Private _attributes

          _attributes: {} = {}

          Type declaration

            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

            Theme

            On This Page

            constructor_attributes_hash_name_size_typeattributeshashnamesizetype
            \ No newline at end of file diff --git a/classes/_octra_web_media.DirectoryInfo.html b/classes/_octra_web_media.DirectoryInfo.html index 5c3ec24c3..12eae5216 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

            Class DirectoryInfo

            Hierarchy (view full)

            Constructors

            constructor +DirectoryInfo | Octra libraries - v2.0.0

            Class DirectoryInfo

            Hierarchy (view full)

            Constructors

            constructor

            Properties

            _entries _hash? _name @@ -17,4 +17,4 @@ extractFolderName fromFolderObject traverseFileTree -

            Constructors

            constructor

            Properties

            Private _entries

            _entries: (FileInfo | DirectoryInfo)[] = []

            Protected Optional _hash

            _hash?: string

            Protected _name

            _name: string

            Private Readonly _path

            _path: string

            Protected _size

            _size: number

            Protected _type

            _type: string

            Accessors

            attributes

            entries

            hash

            name

            path

            size

            type

            Methods

            addEntries

            clone

            Static extractFolderName

            Static fromFolderObject

            Private Static traverseFileTree

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_entries_hash_name_path_size_typeattributesentrieshashnamepathsizetypeaddEntriescloneextractFolderNamefromFolderObjecttraverseFileTree
            \ No newline at end of file +

            Constructors

            constructor

            Properties

            Private _entries

            _entries: (FileInfo | DirectoryInfo)[] = []

            Protected Optional _hash

            _hash?: string

            Protected _name

            _name: string

            Private Readonly _path

            _path: string

            Protected _size

            _size: number

            Protected _type

            _type: string

            Accessors

            attributes

            entries

            hash

            name

            path

            size

            type

            Methods

            addEntries

            clone

            Static extractFolderName

            Static fromFolderObject

            Private Static traverseFileTree

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_entries_hash_name_path_size_typeattributesentrieshashnamepathsizetypeaddEntriescloneextractFolderNamefromFolderObjecttraverseFileTree
            \ No newline at end of file diff --git a/classes/_octra_web_media.FileInfo.html b/classes/_octra_web_media.FileInfo.html index fb8bd67de..24e982cc3 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

            Class FileInfo

            Hierarchy (view full)

            Constructors

            constructor +FileInfo | Octra libraries - v2.0.0

            Class FileInfo

            Hierarchy (view full)

            Constructors

            constructor

            Properties

            _createdAt _extension _file @@ -33,7 +33,7 @@ getFileFromContent getMimeTypeByExtension renameFile -

            Constructors

            constructor

            Properties

            Private Readonly _createdAt

            _createdAt: number = 0

            Protected _extension

            _extension: string

            Protected _file

            _file: undefined | File

            Protected Optional _hash

            _hash?: string

            Protected _name

            _name: string

            Private _online

            _online: boolean = true

            Protected _size

            _size: number

            Protected _type

            _type: string

            Protected Optional _url

            _url?: string

            Accessors

            attributes

            available

            createdAt

            extension

            file

            fullname

            hash

            name

            online

            size

            type

            url

            Methods

            getBase64

            isMediaFile

            toAny

            updateContentFromURL

            Static escapeFileName

            Static extractFileName

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

            • Parameters

              • fullname: string

              Returns {
                  extension: string;
                  name: string;
              }

              • extension: string
              • name: string

            Static fromAny

            Static fromFileObject

            Static fromURL

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

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

              -

              Parameters

              • url: string
              • Optional type: string
              • Optional name: string
              • createdAt: number = 0
              • Optional size: number

              Returns FileInfo

            Static getFileContent

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

            • Parameters

              • file: File
              • Optional encoding: string

              Returns Promise<string>

            Static getFileFromContent

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

            • Parameters

              • content: string
              • filename: string
              • Optional type: string

              Returns File

            Static getMimeTypeByExtension

            • 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"

            Static renameFile

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

            • Parameters

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

              Returns Promise<File>

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_createdAt_extension_file_hash_name_online_size_type_urlattributesavailablecreatedAtextensionfilefullnamehashnameonlinesizetypeurlgetBase64isMediaFiletoAnyupdateContentFromURLescapeFileNameextractFileNamefromAnyfromFileObjectfromURLgetFileContentgetFileFromContentgetMimeTypeByExtensionrenameFile
            \ No newline at end of file +

            Constructors

            constructor

            Properties

            Private Readonly _createdAt

            _createdAt: number = 0

            Protected _extension

            _extension: string

            Protected _file

            _file: undefined | File

            Protected Optional _hash

            _hash?: string

            Protected _name

            _name: string

            Private _online

            _online: boolean = true

            Protected _size

            _size: number

            Protected _type

            _type: string

            Protected Optional _url

            _url?: string

            Accessors

            attributes

            available

            createdAt

            extension

            file

            fullname

            hash

            name

            online

            size

            type

            url

            Methods

            getBase64

            isMediaFile

            toAny

            updateContentFromURL

            Static escapeFileName

            Static extractFileName

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

            • Parameters

              • fullname: string

              Returns {
                  extension: string;
                  name: string;
              }

              • extension: string
              • name: string

            Static fromAny

            Static fromFileObject

            Static fromURL

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

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

              +

              Parameters

              • url: string
              • Optional type: string
              • Optional name: string
              • createdAt: number = 0
              • Optional size: number

              Returns FileInfo

            Static getFileContent

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

            • Parameters

              • file: File
              • Optional encoding: string

              Returns Promise<string>

            Static getFileFromContent

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

            • Parameters

              • content: string
              • filename: string
              • Optional type: string

              Returns File

            Static getMimeTypeByExtension

            • 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"

            Static renameFile

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

            • Parameters

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

              Returns Promise<File>

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_createdAt_extension_file_hash_name_online_size_type_urlattributesavailablecreatedAtextensionfilefullnamehashnameonlinesizetypeurlgetBase64isMediaFiletoAnyupdateContentFromURLescapeFileNameextractFileNamefromAnyfromFileObjectfromURLgetFileContentgetFileFromContentgetMimeTypeByExtensionrenameFile
            \ No newline at end of file diff --git a/classes/_octra_web_media.OggFormat.html b/classes/_octra_web_media.OggFormat.html index 8e6a6b0bf..377fadcc2 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

            Class OggFormat

            Hierarchy (view full)

            Constructors

            constructor +OggFormat | Octra libraries - v2.0.0

            Class OggFormat

            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

            Protected setBitsPerSample

            Protected setByteRate

            Protected setChannels

            Protected setDuration

            Protected setSampleRate

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_bitsPerSample_byteRate_channels_duration_extension_filename_sampleRatebitStreamLengthformatConstructorgranulePositionheaderTypeversionbitsPerSamplebyteRatechannelsdurationextensionfilenamesampleRateinitisValidsetBitsPerSamplesetByteRatesetChannelssetDurationsetSampleRate
            \ No newline at end of file +

            headerType

            headerType: number

            version

            version: number

            Accessors

            bitsPerSample

            byteRate

            channels

            duration

            extension

            filename

            sampleRate

            Methods

            init

            isValid

            Protected setBitsPerSample

            Protected setByteRate

            Protected setChannels

            Protected setDuration

            Protected setSampleRate

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_bitsPerSample_byteRate_channels_duration_extension_filename_sampleRatebitStreamLengthformatConstructorgranulePositionheaderTypeversionbitsPerSamplebyteRatechannelsdurationextensionfilenamesampleRateinitisValidsetBitsPerSamplesetByteRatesetChannelssetDurationsetSampleRate
            \ No newline at end of file diff --git a/classes/_octra_web_media.ShortcutManager.html b/classes/_octra_web_media.ShortcutManager.html index ed61867b4..da5396327 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

            Class ShortcutManager

            manages all supported shortcuts

            -

            Constructors

            constructor +

            Constructors

            constructor

            Properties

            _pressedKeys _shortcuts generalShortcuts @@ -24,5 +24,5 @@ resetPressedKeys unregisterItemFromGroup unregisterShortcutGroup -

            Constructors

            constructor

            Properties

            Private _pressedKeys

            _pressedKeys: {
                alt: boolean;
                cmd: boolean;
                ctrl: boolean;
                other: number;
                shift: boolean;
            } = ...

            Type declaration

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

            Private _shortcuts

            _shortcuts: ShortcutGroup[]

            generalShortcuts

            generalShortcuts: ShortcutGroup = ...

            Private keyMappingTable

            keyMappingTable: KeyMappingEntry[] = ...

            Private protectedShortcuts

            protectedShortcuts: string[] = ...

            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

            Private checkPressedKey

            clearShortcuts

            disableShortcutGroup

            enableShortcutGroup

            Private getCommand

            • getCommand(shortcut, platform): undefined | {
                  groupName: string;
                  shortcut: Shortcut;
              }

            • Parameters

              • shortcut: string
              • platform: "mac" | "pc"

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

            getCommandByEvent

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

            • Parameters

              • event: KeyboardEvent

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

            Private getKeyCode

            Private getNameByEvent

            • getNameByEvent(event): string

            • gets the name of a special Key by number

              -

              Parameters

              • event: KeyboardEvent

              Returns string

            getShorcutCombination

            getShortcutGroup

            Private isProtectedShortcut

            • isProtectedShortcut(shortcutCombination): boolean

            • Parameters

              • shortcutCombination: string

              Returns boolean

            registerShortcutGroup

            resetPressedKeys

            unregisterItemFromGroup

            • unregisterItemFromGroup(groupName, itemName): void

            • Parameters

              • groupName: string
              • itemName: string

              Returns void

            unregisterShortcutGroup

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_pressedKeys_shortcutsgeneralShortcutskeyMappingTableprotectedShortcutsshortcutsEnabledpressedKeysshortcutscheckKeyEventcheckPressedKeyclearShortcutsdisableShortcutGroupenableShortcutGroupgetCommandgetCommandByEventgetKeyCodegetNameByEventgetShorcutCombinationgetShortcutGroupisProtectedShortcutregisterShortcutGroupresetPressedKeysunregisterItemFromGroupunregisterShortcutGroup
            \ No newline at end of file +

            Constructors

            constructor

            Properties

            Private _pressedKeys

            _pressedKeys: {
                alt: boolean;
                cmd: boolean;
                ctrl: boolean;
                other: number;
                shift: boolean;
            } = ...

            Type declaration

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

            Private _shortcuts

            _shortcuts: ShortcutGroup[]

            generalShortcuts

            generalShortcuts: ShortcutGroup = ...

            Private keyMappingTable

            keyMappingTable: KeyMappingEntry[] = ...

            Private protectedShortcuts

            protectedShortcuts: string[] = ...

            shortcutsEnabled

            shortcutsEnabled: boolean = true

            Accessors

            pressedKeys

            shortcuts

            Methods

            checkKeyEvent

            Private checkPressedKey

            clearShortcuts

            disableShortcutGroup

            enableShortcutGroup

            Private getCommand

            getCommandByEvent

            Private getKeyCode

            Private getNameByEvent

            getShorcutCombination

            getShortcutGroup

            Private isProtectedShortcut

            registerShortcutGroup

            resetPressedKeys

            unregisterItemFromGroup

            unregisterShortcutGroup

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_pressedKeys_shortcutsgeneralShortcutskeyMappingTableprotectedShortcutsshortcutsEnabledpressedKeysshortcutscheckKeyEventcheckPressedKeyclearShortcutsdisableShortcutGroupenableShortcutGroupgetCommandgetCommandByEventgetKeyCodegetNameByEventgetShorcutCombinationgetShortcutGroupisProtectedShortcutregisterShortcutGroupresetPressedKeysunregisterItemFromGroupunregisterShortcutGroup
            \ No newline at end of file diff --git a/classes/_octra_web_media.TsWorker.html b/classes/_octra_web_media.TsWorker.html index ef304a3a3..74361d0f4 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

            Class TsWorker

            Inline web worker that runs jobs asynchronously.

            -

            Constructors

            constructor +

            Constructors

            constructor

            Properties

            _id _jobstatuschange _queue @@ -20,19 +20,19 @@ run convertJobToObj getWorkerScript -

            Constructors

            constructor

            Properties

            Private Readonly _id

            _id: number

            Private _jobstatuschange

            _jobstatuschange: Subject<TsWorkerJob> = ...

            Private _queue

            _queue: TsWorkerJob[] = []

            Private Readonly blobURL

            blobURL: string

            Private status

            status: TsWorkerStatus = TsWorkerStatus.INITIALIZED

            Private worker

            worker: Worker

            Private Static workerID

            workerID: number = 1

            Accessors

            id

            jobstatuschange

            queue

            Methods

            addJob

            • addJob(job): void

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

              +

            Constructors

            constructor

            Properties

            Private Readonly _id

            _id: number

            Private _jobstatuschange

            _jobstatuschange: Subject<TsWorkerJob> = ...

            Private _queue

            _queue: TsWorkerJob[] = []

            Private Readonly blobURL

            blobURL: string

            Private status

            status: TsWorkerStatus = TsWorkerStatus.INITIALIZED

            Private worker

            worker: Worker

            Private Static workerID

            workerID: number = 1

            Accessors

            id

            jobstatuschange

            queue

            Methods

            addJob

            checkBeforeStart

            destroy

            getFirstFreeJob

            getRunningJobID

            hasJob

            • hasJob(job): boolean

            • checks if job is already in the queue

              +

            Returns void

            checkBeforeStart

            destroy

            getFirstFreeJob

            getRunningJobID

            hasJob

            removeJobByID

            Returns boolean

            removeJobByID

            Private run

            Returns void

            Private run

            Private Static convertJobToObj

            Private Static getWorkerScript

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_id_jobstatuschange_queueblobURLstatusworkerworkerIDidjobstatuschangequeueaddJobcheckBeforeStartdestroygetFirstFreeJobgetRunningJobIDhasJobremoveJobByIDrunconvertJobToObjgetWorkerScript
            \ No newline at end of file +

            Returns Promise<any>

            Private Static convertJobToObj

            Private Static getWorkerScript

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_id_jobstatuschange_queueblobURLstatusworkerworkerIDidjobstatuschangequeueaddJobcheckBeforeStartdestroygetFirstFreeJobgetRunningJobIDhasJobremoveJobByIDrunconvertJobToObjgetWorkerScript
            \ No newline at end of file diff --git a/classes/_octra_web_media.TsWorkerJob.html b/classes/_octra_web_media.TsWorkerJob.html index 91afe3d33..5223c1126 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

            Class TsWorkerJob

            This class defines a task with given function and parameters.

            -

            Constructors

            constructor +

            Constructors

            constructor

            Properties

            _id _result _statistics @@ -12,13 +12,13 @@ statistics status

            Methods

            changeStatus -

            Constructors

            constructor

            Properties

            Private Readonly _id

            _id: number

            Private _result

            _result: any

            Private _statistics

            _statistics: {
                ended: number;
                started: number;
            } = ...

            Type declaration

            • ended: number
            • started: number

            Private _status

            _status: TsWorkerStatus = TsWorkerStatus.INITIALIZED

            args

            args: any[] = []

            doFunction

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

            this function will be run in the web worker

            -

            Type declaration

              • (args): Promise<any>

              • Parameters

                • args: any[]

                Returns Promise<any>

            Private Static jobIDCounter

            jobIDCounter: number = 0

            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

            Private Readonly _id

            _id: number

            Private _result

            _result: any

            Private _statistics

            _statistics: {
                ended: number;
                started: number;
            } = ...

            Type declaration

            • ended: number
            • started: number

            Private _status

            _status: TsWorkerStatus = TsWorkerStatus.INITIALIZED

            args

            args: any[] = []

            doFunction

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

            this function will be run in the web worker

            +

            Type declaration

              • (args): Promise<any>

              • Parameters

                • args: any[]

                Returns Promise<any>

            Private Static jobIDCounter

            jobIDCounter: number = 0

            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

            Theme

            On This Page

            constructor_id_result_statistics_statusargsdoFunctionjobIDCounteridresultstatisticsstatuschangeStatus
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_id_result_statistics_statusargsdoFunctionjobIDCounteridresultstatisticsstatuschangeStatus
            \ No newline at end of file diff --git a/classes/_octra_web_media.WavFormat.html b/classes/_octra_web_media.WavFormat.html index 69b8edd45..e84132ddd 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

            Class WavFormat

            Hierarchy (view full)

            Constructors

            constructor +WavFormat | Octra libraries - v2.0.0

            Class WavFormat

            Hierarchy (view full)

            Constructors

            constructor

            Properties

            _bitsPerSample _blockAlign _byteRate @@ -40,16 +40,16 @@ splitChannelsToFiles stopAudioSplitting writeString -

            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

            Protected dataStart

            dataStart: number = -1

            formatConstructor

            formatConstructor: Uint8ArrayConstructor | Int16ArrayConstructor | Int32ArrayConstructor

            onaudiocut

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

            Type declaration

            • fileName: string
            • finishedSegments: number
            • intArray: IntArray

            Private status

            status: "running" | "stopRequested" | "stopped" = 'stopped'

            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

            Protected dataStart

            dataStart: number = -1

            formatConstructor

            formatConstructor: Uint8ArrayConstructor | Int16ArrayConstructor | Int32ArrayConstructor

            onaudiocut

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

            Type declaration

            • fileName: string
            • finishedSegments: number
            • intArray: IntArray

            Private status

            status: "running" | "stopRequested" | "stopped" = 'stopped'

            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

            Protected getDataChunk

            Protected getDataChunkSize

            getFileDataView

            Private getFileFromBufferPart

            Private getFileFromBufferPartArrayBuffer

            getNewFileName

            init

            isValid

            Returns Promise<IntArray>

            Protected getDataChunk

            Protected getDataChunkSize

            getFileDataView

            Private getFileFromBufferPart

            Private getFileFromBufferPartArrayBuffer

            getNewFileName

            init

            isValid

            Protected setBitsPerSample

            Protected setBlockAlign

            Protected setByteRate

            Protected setChannels

            Private setDataStart

            Protected setDuration

            Protected setSampleRate

            splitChannelsToFiles

            stopAudioSplitting

            Private Static writeString

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_bitsPerSample_blockAlign_byteRate_channels_duration_extension_filename_sampleRatedataStartformatConstructoronaudiocutstatusbitsPerSampleblockAlignbyteRatechannelsdurationextensionfilenamesampleRatecutAudioFilecutAudioFileSequentiallyextractDataFromArraygetDataChunkgetDataChunkSizegetFileDataViewgetFileFromBufferPartgetFileFromBufferPartArrayBuffergetNewFileNameinitisValidsetBitsPerSamplesetBlockAlignsetByteRatesetChannelssetDataStartsetDurationsetSampleRatesplitChannelsToFilesstopAudioSplittingwriteString
            \ No newline at end of file +

            Returns boolean

            Protected setBitsPerSample

            Protected setBlockAlign

            Protected setByteRate

            Protected setChannels

            Private setDataStart

            Protected setDuration

            Protected setSampleRate

            splitChannelsToFiles

            stopAudioSplitting

            Private Static writeString

            Settings

            Member Visibility

            Theme

            On This Page

            constructor_bitsPerSample_blockAlign_byteRate_channels_duration_extension_filename_sampleRatedataStartformatConstructoronaudiocutstatusbitsPerSampleblockAlignbyteRatechannelsdurationextensionfilenamesampleRatecutAudioFilecutAudioFileSequentiallyextractDataFromArraygetDataChunkgetDataChunkSizegetFileDataViewgetFileFromBufferPartgetFileFromBufferPartArrayBuffergetNewFileNameinitisValidsetBitsPerSamplesetBlockAlignsetByteRatesetChannelssetDataStartsetDurationsetSampleRatesplitChannelsToFilesstopAudioSplittingwriteString
            \ No newline at end of file diff --git a/enums/_octra_annotation.ASRQueueItemType.html b/enums/_octra_annotation.ASRQueueItemType.html index 2be3d33ed..5cab1af79 100644 --- a/enums/_octra_annotation.ASRQueueItemType.html +++ b/enums/_octra_annotation.ASRQueueItemType.html @@ -1,4 +1,4 @@ -ASRQueueItemType | Octra libraries - v2.0.0

            Enumeration ASRQueueItemType

            Enumeration Members

            ASR +ASRQueueItemType | Octra libraries - v2.0.0

            Enumeration ASRQueueItemType

            Enumeration Members

            ASR ASRMAUS MAUS -

            Enumeration Members

            ASR

            ASR: "ASR"

            ASRMAUS

            ASRMAUS: "ASRMAUS"

            MAUS

            MAUS: "MAUS"

            Settings

            Member Visibility

            Theme

            On This Page

            ASRASRMAUSMAUS
            \ No newline at end of file +

            Enumeration Members

            ASR

            ASR: "ASR"

            ASRMAUS

            ASRMAUS: "ASRMAUS"

            MAUS

            MAUS: "MAUS"

            Settings

            Member Visibility

            Theme

            On This Page

            ASRASRMAUSMAUS
            \ No newline at end of file diff --git a/enums/_octra_annotation.AnnotationLevelType.html b/enums/_octra_annotation.AnnotationLevelType.html index 5c997409b..57109b280 100644 --- a/enums/_octra_annotation.AnnotationLevelType.html +++ b/enums/_octra_annotation.AnnotationLevelType.html @@ -1,4 +1,4 @@ -AnnotationLevelType | Octra libraries - v2.0.0

            Enumeration AnnotationLevelType

            Enumeration Members

            EVENT +AnnotationLevelType | Octra libraries - v2.0.0

            Enumeration AnnotationLevelType

            Enumeration Members

            EVENT ITEM SEGMENT -

            Enumeration Members

            EVENT

            EVENT: "EVENT"

            ITEM

            ITEM: "ITEM"

            SEGMENT

            SEGMENT: "SEGMENT"

            Settings

            Member Visibility

            Theme

            On This Page

            EVENTITEMSEGMENT
            \ No newline at end of file +

            Enumeration Members

            EVENT

            EVENT: "EVENT"

            ITEM

            ITEM: "ITEM"

            SEGMENT

            SEGMENT: "SEGMENT"

            Settings

            Member Visibility

            Theme

            On This Page

            EVENTITEMSEGMENT
            \ No newline at end of file diff --git a/enums/_octra_media.PlayBackStatus.html b/enums/_octra_media.PlayBackStatus.html index df4640e98..97c2147f0 100644 --- a/enums/_octra_media.PlayBackStatus.html +++ b/enums/_octra_media.PlayBackStatus.html @@ -1,8 +1,8 @@ -PlayBackStatus | Octra libraries - v2.0.0

            Enumeration PlayBackStatusConst

            Enumeration Members

            ENDED +PlayBackStatus | Octra libraries - v2.0.0

            Enumeration PlayBackStatusConst

            Enumeration Members

            ENDED INITIALIZED PAUSED PLAYING PREPARE STARTED STOPPED -

            Enumeration Members

            ENDED

            ENDED: "ENDED"

            INITIALIZED

            INITIALIZED: "INITIALIZED"

            PAUSED

            PAUSED: "PAUSED"

            PLAYING

            PLAYING: "PLAYING"

            PREPARE

            PREPARE: "PREPARE"

            STARTED

            STARTED: "STARTED"

            STOPPED

            STOPPED: "STOPPED"

            Settings

            Member Visibility

            Theme

            On This Page

            ENDEDINITIALIZEDPAUSEDPLAYINGPREPARESTARTEDSTOPPED
            \ No newline at end of file +

            Enumeration Members

            ENDED

            ENDED: "ENDED"

            INITIALIZED

            INITIALIZED: "INITIALIZED"

            PAUSED

            PAUSED: "PAUSED"

            PLAYING

            PLAYING: "PLAYING"

            PREPARE

            PREPARE: "PREPARE"

            STARTED

            STARTED: "STARTED"

            STOPPED

            STOPPED: "STOPPED"

            Settings

            Member Visibility

            Theme

            On This Page

            ENDEDINITIALIZEDPAUSEDPLAYINGPREPARESTARTEDSTOPPED
            \ No newline at end of file diff --git a/enums/_octra_web_media.TsWorkerStatus.html b/enums/_octra_web_media.TsWorkerStatus.html index 29391d461..3fea465bd 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

            Enumeration TsWorkerStatus

            Enumeration Members

            FAILED +TsWorkerStatus | Octra libraries - v2.0.0

            Enumeration TsWorkerStatus

            Enumeration Members

            FAILED FINISHED INITIALIZED RUNNING STOPPED -

            Enumeration Members

            FAILED

            FAILED: "failed"

            FINISHED

            FINISHED: "finished"

            INITIALIZED

            INITIALIZED: "initialized"

            RUNNING

            RUNNING: "running"

            STOPPED

            STOPPED: "stopped"

            Settings

            Member Visibility

            Theme

            On This Page

            FAILEDFINISHEDINITIALIZEDRUNNINGSTOPPED
            \ No newline at end of file +

            Enumeration Members

            FAILED

            FAILED: "failed"

            FINISHED

            FINISHED: "finished"

            INITIALIZED

            INITIALIZED: "initialized"

            RUNNING

            RUNNING: "running"

            STOPPED

            STOPPED: "stopped"

            Settings

            Member Visibility

            Theme

            On This Page

            FAILEDFINISHEDINITIALIZEDRUNNINGSTOPPED
            \ No newline at end of file diff --git a/functions/_octra_annotation.addSegment.html b/functions/_octra_annotation.addSegment.html index c2e48511e..f9f2a9245 100644 --- a/functions/_octra_annotation.addSegment.html +++ b/functions/_octra_annotation.addSegment.html @@ -1,2 +1,2 @@ addSegment | Octra libraries - v2.0.0

            Function addSegment

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.betweenWhichSegment.html b/functions/_octra_annotation.betweenWhichSegment.html index 84f8388e9..128f39ec8 100644 --- a/functions/_octra_annotation.betweenWhichSegment.html +++ b/functions/_octra_annotation.betweenWhichSegment.html @@ -1 +1 @@ -betweenWhichSegment | Octra libraries - v2.0.0

            Function betweenWhichSegment

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +betweenWhichSegment | Octra libraries - v2.0.0

            Function betweenWhichSegment

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.cleanup.html b/functions/_octra_annotation.cleanup.html index 6c03e17f3..41f1aa8af 100644 --- a/functions/_octra_annotation.cleanup.html +++ b/functions/_octra_annotation.cleanup.html @@ -1 +1 @@ -cleanup | Octra libraries - v2.0.0

            Function cleanup

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +cleanup | Octra libraries - v2.0.0

            Function cleanup

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.combineSegments.html b/functions/_octra_annotation.combineSegments.html index 8ad0d29f4..3499d9a45 100644 --- a/functions/_octra_annotation.combineSegments.html +++ b/functions/_octra_annotation.combineSegments.html @@ -1 +1 @@ -combineSegments | Octra libraries - v2.0.0

            Function combineSegments

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +combineSegments | Octra libraries - v2.0.0

            Function combineSegments

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.contains.html b/functions/_octra_annotation.contains.html index 1be2468e7..53e4f6445 100644 --- a/functions/_octra_annotation.contains.html +++ b/functions/_octra_annotation.contains.html @@ -1,4 +1,4 @@ contains | Octra libraries - v2.0.0

            Function contains

            • 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

            Theme

            \ No newline at end of file +

            Returns boolean

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.convertFromSupportedConverters.html b/functions/_octra_annotation.convertFromSupportedConverters.html index ed846178f..2d2633ba5 100644 --- a/functions/_octra_annotation.convertFromSupportedConverters.html +++ b/functions/_octra_annotation.convertFromSupportedConverters.html @@ -1 +1 @@ -convertFromSupportedConverters | Octra libraries - v2.0.0

            Function convertFromSupportedConverters

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +convertFromSupportedConverters | Octra libraries - v2.0.0

            Function convertFromSupportedConverters

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.convertOSegmentsToSegments.html b/functions/_octra_annotation.convertOSegmentsToSegments.html index c31a23c89..ac8ddfbaa 100644 --- a/functions/_octra_annotation.convertOSegmentsToSegments.html +++ b/functions/_octra_annotation.convertOSegmentsToSegments.html @@ -1 +1 @@ -convertOSegmentsToSegments | Octra libraries - v2.0.0

            Function convertOSegmentsToSegments

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +convertOSegmentsToSegments | Octra libraries - v2.0.0

            Function convertOSegmentsToSegments

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.convertSegmentsToOSegments.html b/functions/_octra_annotation.convertSegmentsToOSegments.html index c2b63ccdc..fbd617474 100644 --- a/functions/_octra_annotation.convertSegmentsToOSegments.html +++ b/functions/_octra_annotation.convertSegmentsToOSegments.html @@ -1,2 +1,2 @@ convertSegmentsToOSegments | Octra libraries - v2.0.0

            Function convertSegmentsToOSegments

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns OSegment[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.getSegmentBySamplePosition.html b/functions/_octra_annotation.getSegmentBySamplePosition.html index ba1d26e2b..3ee6e929f 100644 --- a/functions/_octra_annotation.getSegmentBySamplePosition.html +++ b/functions/_octra_annotation.getSegmentBySamplePosition.html @@ -1,2 +1,2 @@ getSegmentBySamplePosition | Octra libraries - v2.0.0

            Function getSegmentBySamplePosition

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns number

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.getSegmentsOfRange.html b/functions/_octra_annotation.getSegmentsOfRange.html index e493c3d4c..5f8404e77 100644 --- a/functions/_octra_annotation.getSegmentsOfRange.html +++ b/functions/_octra_annotation.getSegmentsOfRange.html @@ -1 +1 @@ -getSegmentsOfRange | Octra libraries - v2.0.0

            Function getSegmentsOfRange

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +getSegmentsOfRange | Octra libraries - v2.0.0

            Function getSegmentsOfRange

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.getStartTimeBySegmentID.html b/functions/_octra_annotation.getStartTimeBySegmentID.html index 0311b7920..fb9804b18 100644 --- a/functions/_octra_annotation.getStartTimeBySegmentID.html +++ b/functions/_octra_annotation.getStartTimeBySegmentID.html @@ -1 +1 @@ -getStartTimeBySegmentID | Octra libraries - v2.0.0

            Function getStartTimeBySegmentID

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +getStartTimeBySegmentID | Octra libraries - v2.0.0

            Function getStartTimeBySegmentID

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.removeBySamples.html b/functions/_octra_annotation.removeBySamples.html index 33ed55aa8..ada887fa1 100644 --- a/functions/_octra_annotation.removeBySamples.html +++ b/functions/_octra_annotation.removeBySamples.html @@ -1,2 +1,2 @@ removeBySamples | Octra libraries - v2.0.0

            Function removeBySamples

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns OctraAnnotationSegment<ASRContext>[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.removeSegmentByIndex.html b/functions/_octra_annotation.removeSegmentByIndex.html index 8cbd4c150..11fce8b1f 100644 --- a/functions/_octra_annotation.removeSegmentByIndex.html +++ b/functions/_octra_annotation.removeSegmentByIndex.html @@ -1,4 +1,4 @@ removeSegmentByIndex | Octra libraries - v2.0.0

            Function removeSegmentByIndex

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +
          • mergeTranscripts: boolean = true

            • Returns OctraAnnotationSegment<ASRContext>[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_annotation.sort.html b/functions/_octra_annotation.sort.html index bca5416c0..d3ffb4bfd 100644 --- a/functions/_octra_annotation.sort.html +++ b/functions/_octra_annotation.sort.html @@ -1,2 +1,2 @@ sort | Octra libraries - v2.0.0

            Function sort

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns OctraAnnotationSegment<ASRContext>[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_ngx_utilities.downloadFile.html b/functions/_octra_ngx_utilities.downloadFile.html index 0ce0547cc..73c2f9148 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

            Theme

            \ No newline at end of file +

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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_ngx_utilities.navigateTo.html b/functions/_octra_ngx_utilities.navigateTo.html index 0a347b62e..56e93e848 100644 --- a/functions/_octra_ngx_utilities.navigateTo.html +++ b/functions/_octra_ngx_utilities.navigateTo.html @@ -1 +1 @@ -navigateTo | Octra libraries - v2.0.0

            Function navigateTo

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

            • Parameters

              • router: Router
              • commands: any[]
              • Optional navigationExtras: NavigationExtras

              Returns Promise<boolean>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +navigateTo | Octra libraries - v2.0.0

            Function navigateTo

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

            • Parameters

              • router: Router
              • commands: any[]
              • Optional navigationExtras: NavigationExtras

              Returns Promise<boolean>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_ngx_utilities.uniqueHTTPRequest.html b/functions/_octra_ngx_utilities.uniqueHTTPRequest.html index 49d913763..cd41b4ca0 100644 --- a/functions/_octra_ngx_utilities.uniqueHTTPRequest.html +++ b/functions/_octra_ngx_utilities.uniqueHTTPRequest.html @@ -1 +1 @@ -uniqueHTTPRequest | Octra libraries - v2.0.0

            Function uniqueHTTPRequest

            • 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

            Theme

            \ No newline at end of file +uniqueHTTPRequest | Octra libraries - v2.0.0

            Function uniqueHTTPRequest

            • 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

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.base64ToArrayBuffer.html b/functions/_octra_utilities.base64ToArrayBuffer.html index 01a88386a..c3a7027ec 100644 --- a/functions/_octra_utilities.base64ToArrayBuffer.html +++ b/functions/_octra_utilities.base64ToArrayBuffer.html @@ -1,2 +1,2 @@ base64ToArrayBuffer | Octra libraries - v2.0.0

            Function base64ToArrayBuffer

            • base64ToArrayBuffer(base64String): any

            • converts base64 to ArrayBuffer

              -

              Parameters

              • base64String: string

              Returns any

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns any

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.contains.html b/functions/_octra_utilities.contains.html index 2b72b31e0..b5a216b61 100644 --- a/functions/_octra_utilities.contains.html +++ b/functions/_octra_utilities.contains.html @@ -1,4 +1,4 @@ contains | Octra libraries - v2.0.0

            Function contains

            • 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

            Theme

            \ No newline at end of file +

            Returns boolean

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.convertDurationToUnix.html b/functions/_octra_utilities.convertDurationToUnix.html index 1e48bb784..7b8dc4b32 100644 --- a/functions/_octra_utilities.convertDurationToUnix.html +++ b/functions/_octra_utilities.convertDurationToUnix.html @@ -1,3 +1,3 @@ convertDurationToUnix | Octra libraries - v2.0.0

            Function convertDurationToUnix

            • 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

            Theme

            \ No newline at end of file +

            Returns undefined | number

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.equalProperties.html b/functions/_octra_utilities.equalProperties.html index aa01efdf5..b1ba289bf 100644 --- a/functions/_octra_utilities.equalProperties.html +++ b/functions/_octra_utilities.equalProperties.html @@ -1 +1 @@ -equalProperties | Octra libraries - v2.0.0

            Function equalProperties

            • equalProperties(elem, elem2): boolean

            • Parameters

              • elem: any
              • elem2: any

              Returns boolean

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +equalProperties | Octra libraries - v2.0.0

            Function equalProperties

            • equalProperties(elem, elem2): boolean

            • Parameters

              • elem: any
              • elem2: any

              Returns boolean

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.escapeHtml.html b/functions/_octra_utilities.escapeHtml.html index 53db31f32..56bccc7e8 100644 --- a/functions/_octra_utilities.escapeHtml.html +++ b/functions/_octra_utilities.escapeHtml.html @@ -1 +1 @@ -escapeHtml | Octra libraries - v2.0.0

            Function escapeHtml

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +escapeHtml | Octra libraries - v2.0.0

            Function escapeHtml

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.escapeRegex.html b/functions/_octra_utilities.escapeRegex.html index 616a7c68d..c5d4945df 100644 --- a/functions/_octra_utilities.escapeRegex.html +++ b/functions/_octra_utilities.escapeRegex.html @@ -1 +1 @@ -escapeRegex | Octra libraries - v2.0.0

            Function escapeRegex

            • escapeRegex(regexStr): string

            • Parameters

              • regexStr: string

              Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +escapeRegex | Octra libraries - v2.0.0

            Function escapeRegex

            • escapeRegex(regexStr): string

            • Parameters

              • regexStr: string

              Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.extractFileNameFromURL.html b/functions/_octra_utilities.extractFileNameFromURL.html index 9cbdf9beb..66d3aa5be 100644 --- a/functions/_octra_utilities.extractFileNameFromURL.html +++ b/functions/_octra_utilities.extractFileNameFromURL.html @@ -1,2 +1,2 @@ extractFileNameFromURL | Octra libraries - v2.0.0

            Function extractFileNameFromURL

            • 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

            Theme

            \ No newline at end of file +

            Parameters

            Returns {
                extension: string;
                name: string;
            }

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.flatten.html b/functions/_octra_utilities.flatten.html index f0d312536..5a3d122e2 100644 --- a/functions/_octra_utilities.flatten.html +++ b/functions/_octra_utilities.flatten.html @@ -1 +1 @@ -flatten | Octra libraries - v2.0.0

            Function flatten

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +flatten | Octra libraries - v2.0.0

            Function flatten

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.getBaseHrefURL.html b/functions/_octra_utilities.getBaseHrefURL.html index c98c23d66..8c62fa30e 100644 --- a/functions/_octra_utilities.getBaseHrefURL.html +++ b/functions/_octra_utilities.getBaseHrefURL.html @@ -1,2 +1,2 @@ getBaseHrefURL | Octra libraries - v2.0.0

            Function getBaseHrefURL

            • getBaseHrefURL(): string

            • returns the base URL path to the application

              -

              Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.getFileSize.html b/functions/_octra_utilities.getFileSize.html index 4c55f41e1..d080cf935 100644 --- a/functions/_octra_utilities.getFileSize.html +++ b/functions/_octra_utilities.getFileSize.html @@ -1 +1 @@ -getFileSize | Octra libraries - v2.0.0

            Function getFileSize

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +getFileSize | Octra libraries - v2.0.0

            Function getFileSize

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.getProperties.html b/functions/_octra_utilities.getProperties.html index 71516ad7d..2f818759b 100644 --- a/functions/_octra_utilities.getProperties.html +++ b/functions/_octra_utilities.getProperties.html @@ -1 +1 @@ -getProperties | Octra libraries - v2.0.0

            Function getProperties

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

            • Parameters

              • obj: any

              Returns [string, any][]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +getProperties | Octra libraries - v2.0.0

            Function getProperties

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

            • Parameters

              • obj: any

              Returns [string, any][]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.getTranscriptFromIO.html b/functions/_octra_utilities.getTranscriptFromIO.html index fd5911e24..3c41a5a07 100644 --- a/functions/_octra_utilities.getTranscriptFromIO.html +++ b/functions/_octra_utilities.getTranscriptFromIO.html @@ -1 +1 @@ -getTranscriptFromIO | Octra libraries - v2.0.0

            Function getTranscriptFromIO

            • getTranscriptFromIO(io): any | undefined

            • Parameters

              • io: any[]

              Returns any | undefined

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +getTranscriptFromIO | Octra libraries - v2.0.0

            Function getTranscriptFromIO

            • getTranscriptFromIO(io): any | undefined

            • Parameters

              • io: any[]

              Returns any | undefined

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.hasProperty.html b/functions/_octra_utilities.hasProperty.html index 2182607e6..668e4372f 100644 --- a/functions/_octra_utilities.hasProperty.html +++ b/functions/_octra_utilities.hasProperty.html @@ -1 +1 @@ -hasProperty | Octra libraries - v2.0.0

            Function hasProperty

            • hasProperty(obj, attribute): boolean

            • Parameters

              • obj: unknown
              • attribute: string

              Returns boolean

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +hasProperty | Octra libraries - v2.0.0

            Function hasProperty

            • hasProperty(obj, attribute): boolean

            • Parameters

              • obj: unknown
              • attribute: string

              Returns boolean

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.hasPropertyTree.html b/functions/_octra_utilities.hasPropertyTree.html index bc57bebf4..d570c0e76 100644 --- a/functions/_octra_utilities.hasPropertyTree.html +++ b/functions/_octra_utilities.hasPropertyTree.html @@ -1,2 +1,2 @@ hasPropertyTree | Octra libraries - v2.0.0

            Function hasPropertyTree

            • 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

            Theme

            \ No newline at end of file +

            Parameters

            Returns boolean

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.insertString.html b/functions/_octra_utilities.insertString.html index 599486b7f..ab95d0e9c 100644 --- a/functions/_octra_utilities.insertString.html +++ b/functions/_octra_utilities.insertString.html @@ -1 +1 @@ -insertString | Octra libraries - v2.0.0

            Function insertString

            • insertString(input, pos, insertion): string

            • Parameters

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

              Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +insertString | Octra libraries - v2.0.0

            Function insertString

            • insertString(input, pos, insertion): string

            • Parameters

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

              Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.isEmpty.html b/functions/_octra_utilities.isEmpty.html index b63382d03..4709f0ffb 100644 --- a/functions/_octra_utilities.isEmpty.html +++ b/functions/_octra_utilities.isEmpty.html @@ -1 +1 @@ -isEmpty | Octra libraries - v2.0.0

            Function isEmpty

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +isEmpty | Octra libraries - v2.0.0

            Function isEmpty

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.isFunction.html b/functions/_octra_utilities.isFunction.html index 1f924bd6f..0a430838f 100644 --- a/functions/_octra_utilities.isFunction.html +++ b/functions/_octra_utilities.isFunction.html @@ -1,2 +1,2 @@ isFunction | Octra libraries - v2.0.0

            Function isFunction

            • isFunction(value): boolean

            • checks if value is a function

              -

              Parameters

              • value: any

              Returns boolean

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns boolean

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.isNumber.html b/functions/_octra_utilities.isNumber.html index b2b7f069b..a3ddc243f 100644 --- a/functions/_octra_utilities.isNumber.html +++ b/functions/_octra_utilities.isNumber.html @@ -1 +1 @@ -isNumber | Octra libraries - v2.0.0

            Function isNumber

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +isNumber | Octra libraries - v2.0.0

            Function isNumber

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.joinURL.html b/functions/_octra_utilities.joinURL.html index 5edc6c47e..694805839 100644 --- a/functions/_octra_utilities.joinURL.html +++ b/functions/_octra_utilities.joinURL.html @@ -1,2 +1,2 @@ joinURL | Octra libraries - v2.0.0

            Function joinURL

            • joinURL(...args): string

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

              -

              Parameters

              • Rest ...args: string[]

              Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.last.html b/functions/_octra_utilities.last.html index 664e53694..71e53073e 100644 --- a/functions/_octra_utilities.last.html +++ b/functions/_octra_utilities.last.html @@ -1,3 +1,3 @@ last | Octra libraries - v2.0.0

            Function last

            • 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

            Theme

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.mapFnOnObject.html b/functions/_octra_utilities.mapFnOnObject.html index f5d29d321..60661d5d9 100644 --- a/functions/_octra_utilities.mapFnOnObject.html +++ b/functions/_octra_utilities.mapFnOnObject.html @@ -1,2 +1,2 @@ mapFnOnObject | Octra libraries - v2.0.0

            Function mapFnOnObject

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

            • maps a function fn on all property values.

              -

              Parameters

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

                  • Parameters

                    • key: string
                    • value: any

                    Returns any

              Returns Record<string, any>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns Record<string, any>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.popupCenter.html b/functions/_octra_utilities.popupCenter.html index 4fd46ec9b..e66bb9fc1 100644 --- a/functions/_octra_utilities.popupCenter.html +++ b/functions/_octra_utilities.popupCenter.html @@ -1 +1 @@ -popupCenter | Octra libraries - v2.0.0

            Function popupCenter

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

            • Parameters

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

              Returns void

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +popupCenter | Octra libraries - v2.0.0

            Function popupCenter

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

            • Parameters

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

              Returns void

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.range.html b/functions/_octra_utilities.range.html index ca8f34530..d97c71816 100644 --- a/functions/_octra_utilities.range.html +++ b/functions/_octra_utilities.range.html @@ -1,2 +1,2 @@ range | Octra libraries - v2.0.0

            Function range

            • range(start, end): number[]

            • creates a range with start and end number.

              -

              Parameters

              • start: number
              • end: number

              Returns number[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns number[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.removeEmptyProperties.html b/functions/_octra_utilities.removeEmptyProperties.html index 36c4adc95..f82f75bdd 100644 --- a/functions/_octra_utilities.removeEmptyProperties.html +++ b/functions/_octra_utilities.removeEmptyProperties.html @@ -1,2 +1,2 @@ removeEmptyProperties | Octra libraries - v2.0.0

            Function removeEmptyProperties

            • 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;
                } = ...
                • Optional removeEmptyStrings?: boolean
                • Optional removeNull?: boolean
                • Optional removeUndefined?: boolean

              Returns T

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Type Parameters

            Parameters

            Returns T

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.unEscapeHtml.html b/functions/_octra_utilities.unEscapeHtml.html index f1788bd2b..054e1c870 100644 --- a/functions/_octra_utilities.unEscapeHtml.html +++ b/functions/_octra_utilities.unEscapeHtml.html @@ -1 +1 @@ -unEscapeHtml | Octra libraries - v2.0.0

            Function unEscapeHtml

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +unEscapeHtml | Octra libraries - v2.0.0

            Function unEscapeHtml

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_utilities.waitTillResultRetrieved.html b/functions/_octra_utilities.waitTillResultRetrieved.html index 0e6d394b5..918a7d95e 100644 --- a/functions/_octra_utilities.waitTillResultRetrieved.html +++ b/functions/_octra_utilities.waitTillResultRetrieved.html @@ -1 +1 @@ -waitTillResultRetrieved | Octra libraries - v2.0.0

            Function waitTillResultRetrieved

            • 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

            Theme

            \ No newline at end of file +waitTillResultRetrieved | Octra libraries - v2.0.0

            Function waitTillResultRetrieved

            • 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

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.downloadFile.html b/functions/_octra_web_media.downloadFile.html index 4fc3938b0..1aa2fbd5e 100644 --- a/functions/_octra_web_media.downloadFile.html +++ b/functions/_octra_web_media.downloadFile.html @@ -1 +1 @@ -downloadFile | Octra libraries - v2.0.0

            Function downloadFile

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

            • Parameters

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

              Returns Promise<File>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +downloadFile | Octra libraries - v2.0.0

            Function downloadFile

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

            • Parameters

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

              Returns Promise<File>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.fileListToArray.html b/functions/_octra_web_media.fileListToArray.html index ab4c7a870..e999d3386 100644 --- a/functions/_octra_web_media.fileListToArray.html +++ b/functions/_octra_web_media.fileListToArray.html @@ -1 +1 @@ -fileListToArray | Octra libraries - v2.0.0

            Function fileListToArray

            • fileListToArray(fileList): File[]

            • Parameters

              • fileList: FileList

              Returns File[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +fileListToArray | Octra libraries - v2.0.0

            Function fileListToArray

            • fileListToArray(fileList): File[]

            • Parameters

              • fileList: FileList

              Returns File[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.findElements.html b/functions/_octra_web_media.findElements.html index 46d30f173..c38310661 100644 --- a/functions/_octra_web_media.findElements.html +++ b/functions/_octra_web_media.findElements.html @@ -1 +1 @@ -findElements | Octra libraries - v2.0.0

            Function findElements

            • findElements(parent, selector): HTMLElement[]

            • Parameters

              • parent: HTMLElement
              • selector: string

              Returns HTMLElement[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +findElements | Octra libraries - v2.0.0

            Function findElements

            • findElements(parent, selector): HTMLElement[]

            • Parameters

              • parent: HTMLElement
              • selector: string

              Returns HTMLElement[]

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.getAttr.html b/functions/_octra_web_media.getAttr.html index 79e3c3938..115462cc4 100644 --- a/functions/_octra_web_media.getAttr.html +++ b/functions/_octra_web_media.getAttr.html @@ -1 +1 @@ -getAttr | Octra libraries - v2.0.0

            Function getAttr

            • getAttr(elem, attribute): undefined | string

            • Parameters

              • elem: HTMLElement
              • attribute: string

              Returns undefined | string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +getAttr | Octra libraries - v2.0.0

            Function getAttr

            • getAttr(elem, attribute): undefined | string

            • Parameters

              • elem: HTMLElement
              • attribute: string

              Returns undefined | string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.getAudioInfo.html b/functions/_octra_web_media.getAudioInfo.html index 10c837f0f..7e2ed92db 100644 --- a/functions/_octra_web_media.getAudioInfo.html +++ b/functions/_octra_web_media.getAudioInfo.html @@ -1 +1 @@ -getAudioInfo | Octra libraries - v2.0.0

            Function getAudioInfo

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +getAudioInfo | Octra libraries - v2.0.0

            Function getAudioInfo

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.getBaseHrefURL.html b/functions/_octra_web_media.getBaseHrefURL.html index d9b9ba51f..9a2369716 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

            Function getBaseHrefURL

            • getBaseHrefURL(): string

            • returns the base URL path to the application

              -

              Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.getFileContent.html b/functions/_octra_web_media.getFileContent.html index 93bbac96f..3846a292d 100644 --- a/functions/_octra_web_media.getFileContent.html +++ b/functions/_octra_web_media.getFileContent.html @@ -1 +1 @@ -getFileContent | Octra libraries - v2.0.0

            Function getFileContent

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

            • Parameters

              • file: File
              • Optional encoding: string

              Returns Promise<string>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +getFileContent | Octra libraries - v2.0.0

            Function getFileContent

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

            • Parameters

              • file: File
              • Optional encoding: string

              Returns Promise<string>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.popupCenter.html b/functions/_octra_web_media.popupCenter.html index c1f134807..54f841eeb 100644 --- a/functions/_octra_web_media.popupCenter.html +++ b/functions/_octra_web_media.popupCenter.html @@ -1 +1 @@ -popupCenter | Octra libraries - v2.0.0

            Function popupCenter

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

            • Parameters

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

              Returns void

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +popupCenter | Octra libraries - v2.0.0

            Function popupCenter

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

            • Parameters

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

              Returns void

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.readFileContents.html b/functions/_octra_web_media.readFileContents.html index 664ffb5f7..42514d850 100644 --- a/functions/_octra_web_media.readFileContents.html +++ b/functions/_octra_web_media.readFileContents.html @@ -1 +1 @@ -readFileContents | Octra libraries - v2.0.0

            Function readFileContents

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

            • Type Parameters

              • T

              Parameters

              • file: File
              • method: "text" | "binary" | "arraybuffer"
              • Optional encoding: string

              Returns Promise<T>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +readFileContents | Octra libraries - v2.0.0

            Function readFileContents

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

            • Type Parameters

              • T

              Parameters

              • file: File
              • method: "text" | "binary" | "arraybuffer"
              • Optional encoding: string

              Returns Promise<T>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.renameFile.html b/functions/_octra_web_media.renameFile.html index 55609c808..2903fd0bb 100644 --- a/functions/_octra_web_media.renameFile.html +++ b/functions/_octra_web_media.renameFile.html @@ -1 +1 @@ -renameFile | Octra libraries - v2.0.0

            Function renameFile

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

            • Parameters

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

              Returns Promise<File>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +renameFile | Octra libraries - v2.0.0

            Function renameFile

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

            • Parameters

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

              Returns Promise<File>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/functions/_octra_web_media.setStyle.html b/functions/_octra_web_media.setStyle.html index 09c90da44..61dea2843 100644 --- a/functions/_octra_web_media.setStyle.html +++ b/functions/_octra_web_media.setStyle.html @@ -1 +1 @@ -setStyle | Octra libraries - v2.0.0

            Function setStyle

            • setStyle(elem, styleObj): void

            • Parameters

              • elem: HTMLElement
              • styleObj: any

              Returns void

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +setStyle | Octra libraries - v2.0.0

            Function setStyle

            • setStyle(elem, styleObj): void

            • Parameters

              • elem: HTMLElement
              • styleObj: any

              Returns void

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/interfaces/_octra_annotation.ASRContext.html b/interfaces/_octra_annotation.ASRContext.html index 55503d6c8..30cb7ea56 100644 --- a/interfaces/_octra_annotation.ASRContext.html +++ b/interfaces/_octra_annotation.ASRContext.html @@ -1,2 +1,2 @@ -ASRContext | Octra libraries - v2.0.0

            Interface ASRContext

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

            Properties

            asr? -

            Properties

            Optional asr

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

            Type declaration

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

            Settings

            Member Visibility

            Theme

            On This Page

            asr
            \ No newline at end of file +ASRContext | Octra libraries - v2.0.0

            Interface ASRContext

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

            Properties

            asr? +

            Properties

            Optional asr

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

            Type declaration

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

            Settings

            Member Visibility

            Theme

            On This Page

            asr
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.Bundle.html b/interfaces/_octra_annotation.Bundle.html index e04232e53..40f361020 100644 --- a/interfaces/_octra_annotation.Bundle.html +++ b/interfaces/_octra_annotation.Bundle.html @@ -1,4 +1,4 @@ -Bundle | Octra libraries - v2.0.0

            Interface Bundle

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

            Properties

            annotation +Bundle | Octra libraries - v2.0.0

            Interface Bundle

            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;
            }

            Type declaration

            • data: string
            • encoding: string

            ssffFiles

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

            Type declaration

            • data: string
            • encoding: string
            • fileExtension: string

            Settings

            Member Visibility

            Theme

            On This Page

            annotationmediaFilessffFiles
            \ No newline at end of file +

            Properties

            annotation

            annotation: IAnnotJSON

            mediaFile

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

            Type declaration

            • data: string
            • encoding: string

            ssffFiles

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

            Type declaration

            • data: string
            • encoding: string
            • fileExtension: string

            Settings

            Member Visibility

            Theme

            On This Page

            annotationmediaFilessffFiles
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.ELAN30Object.html b/interfaces/_octra_annotation.ELAN30Object.html index 1f51e1355..bddaeda30 100644 --- a/interfaces/_octra_annotation.ELAN30Object.html +++ b/interfaces/_octra_annotation.ELAN30Object.html @@ -1,2 +1,2 @@ -ELAN30Object | Octra libraries - v2.0.0

            Interface ELAN30Object

            interface ELAN30Object {
                ANNOTATION_DOCUMENT: {
                    CONSTRAINT: {
                        _DESCRIPTION?: string;
                        _STEREOTYPE: string;
                    }[];
                    CONTROLLED_VOCABULARY?: {
                        CV_ENTRY_ML?: {
                            CVE_VALUE: {
                                _DESCRIPTION?: string;
                                _LANG_REF: string;
                                _text: string;
                            };
                            _CVE_ID: string;
                            _EXT_REF?: string;
                        };
                        DESCRIPTION?: {
                            _LANG_REF: string;
                            _text: string;
                        };
                        _CV_ID: string;
                        _EXT_REF?: string;
                    };
                    EXTERNAL_REF?: {
                        _EXT_REF_ID: string;
                        _TYPE: string;
                        _VALUE: string;
                    };
                    HEADER: {
                        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;
                        }[];
                        _MEDIA_FILE?: string;
                        _TIME_UNITS?: "milliseconds" | "NTSC-frames" | "PAL-frames";
                    };
                    LANGUAGE?: {
                        _LANG_DEF?: string;
                        _LANG_ID: string;
                        _LANG_LABEL?: string;
                    };
                    LEXICON_REF?: {
                        _DATCAT_ID?: string;
                        _DATCAT_NAME?: string;
                        _LEXICON_ID: string;
                        _LEXICON_NAME: string;
                        _LEX_REF_ID: 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: {
                        ANNOTATION: {
                            ALIGNABLE_ANNOTATION?: {
                                ANNOTATION_VALUE: string;
                                _ANNOTATION_ID: string;
                                _SVG_REF?: string;
                                _TIME_SLOT_REF1: string;
                                _TIME_SLOT_REF2: string;
                            };
                            REF_ANNOTATION?: {
                                ANNOTATION_VALUE: string;
                                _ANNOTATION_ID: string;
                                _ANNOTATION_REF: string;
                                _CVE_REF: string;
                                _EXT_REF?: string;
                                _LANG_REF: string;
                                _PREVIOUS_ANNOTATION?: string;
                            };
                        }[];
                        _ANNOTATOR?: string;
                        _DEFAULT_LOCALE?: string;
                        _EXT_REF?: string;
                        _LANG_REF?: string;
                        _LINGUISTIC_TYPE_REF: string;
                        _PARENT_REF?: string;
                        _PARTICIPANT?: string;
                        _TIER_ID: string;
                    }[];
                    TIME_ORDER: {
                        TIME_SLOT?: {
                            _TIME_SLOT_ID: string;
                            _TIME_VALUE?: number;
                        }[];
                    };
                    _AUTHOR: string;
                    _DATE: string;
                    _FORMAT?: string;
                    _VERSION: string;
                    _xmlns:xsi: string;
                    _xsi:noNamespaceSchemaLocation: string;
                };
            }

            Properties

            ANNOTATION_DOCUMENT -

            Properties

            ANNOTATION_DOCUMENT

            ANNOTATION_DOCUMENT: {
                CONSTRAINT: {
                    _DESCRIPTION?: string;
                    _STEREOTYPE: string;
                }[];
                CONTROLLED_VOCABULARY?: {
                    CV_ENTRY_ML?: {
                        CVE_VALUE: {
                            _DESCRIPTION?: string;
                            _LANG_REF: string;
                            _text: string;
                        };
                        _CVE_ID: string;
                        _EXT_REF?: string;
                    };
                    DESCRIPTION?: {
                        _LANG_REF: string;
                        _text: string;
                    };
                    _CV_ID: string;
                    _EXT_REF?: string;
                };
                EXTERNAL_REF?: {
                    _EXT_REF_ID: string;
                    _TYPE: string;
                    _VALUE: string;
                };
                HEADER: {
                    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;
                    }[];
                    _MEDIA_FILE?: string;
                    _TIME_UNITS?: "milliseconds" | "NTSC-frames" | "PAL-frames";
                };
                LANGUAGE?: {
                    _LANG_DEF?: string;
                    _LANG_ID: string;
                    _LANG_LABEL?: string;
                };
                LEXICON_REF?: {
                    _DATCAT_ID?: string;
                    _DATCAT_NAME?: string;
                    _LEXICON_ID: string;
                    _LEXICON_NAME: string;
                    _LEX_REF_ID: 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: {
                    ANNOTATION: {
                        ALIGNABLE_ANNOTATION?: {
                            ANNOTATION_VALUE: string;
                            _ANNOTATION_ID: string;
                            _SVG_REF?: string;
                            _TIME_SLOT_REF1: string;
                            _TIME_SLOT_REF2: string;
                        };
                        REF_ANNOTATION?: {
                            ANNOTATION_VALUE: string;
                            _ANNOTATION_ID: string;
                            _ANNOTATION_REF: string;
                            _CVE_REF: string;
                            _EXT_REF?: string;
                            _LANG_REF: string;
                            _PREVIOUS_ANNOTATION?: string;
                        };
                    }[];
                    _ANNOTATOR?: string;
                    _DEFAULT_LOCALE?: string;
                    _EXT_REF?: string;
                    _LANG_REF?: string;
                    _LINGUISTIC_TYPE_REF: string;
                    _PARENT_REF?: string;
                    _PARTICIPANT?: string;
                    _TIER_ID: string;
                }[];
                TIME_ORDER: {
                    TIME_SLOT?: {
                        _TIME_SLOT_ID: string;
                        _TIME_VALUE?: number;
                    }[];
                };
                _AUTHOR: string;
                _DATE: string;
                _FORMAT?: string;
                _VERSION: string;
                _xmlns:xsi: string;
                _xsi:noNamespaceSchemaLocation: string;
            }

            Type declaration

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

            Settings

            Member Visibility

            Theme

            On This Page

            ANNOTATION_DOCUMENT
            \ No newline at end of file +ELAN30Object | Octra libraries - v2.0.0

            Interface ELAN30Object

            interface ELAN30Object {
                ANNOTATION_DOCUMENT: {
                    CONSTRAINT: {
                        _DESCRIPTION?: string;
                        _STEREOTYPE: string;
                    }[];
                    CONTROLLED_VOCABULARY?: {
                        CV_ENTRY_ML?: {
                            CVE_VALUE: {
                                _DESCRIPTION?: string;
                                _LANG_REF: string;
                                _text: string;
                            };
                            _CVE_ID: string;
                            _EXT_REF?: string;
                        };
                        DESCRIPTION?: {
                            _LANG_REF: string;
                            _text: string;
                        };
                        _CV_ID: string;
                        _EXT_REF?: string;
                    };
                    EXTERNAL_REF?: {
                        _EXT_REF_ID: string;
                        _TYPE: string;
                        _VALUE: string;
                    };
                    HEADER: {
                        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;
                        }[];
                        _MEDIA_FILE?: string;
                        _TIME_UNITS?: "milliseconds" | "NTSC-frames" | "PAL-frames";
                    };
                    LANGUAGE?: {
                        _LANG_DEF?: string;
                        _LANG_ID: string;
                        _LANG_LABEL?: string;
                    };
                    LEXICON_REF?: {
                        _DATCAT_ID?: string;
                        _DATCAT_NAME?: string;
                        _LEXICON_ID: string;
                        _LEXICON_NAME: string;
                        _LEX_REF_ID: 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: {
                        ANNOTATION: {
                            ALIGNABLE_ANNOTATION?: {
                                ANNOTATION_VALUE: string;
                                _ANNOTATION_ID: string;
                                _SVG_REF?: string;
                                _TIME_SLOT_REF1: string;
                                _TIME_SLOT_REF2: string;
                            };
                            REF_ANNOTATION?: {
                                ANNOTATION_VALUE: string;
                                _ANNOTATION_ID: string;
                                _ANNOTATION_REF: string;
                                _CVE_REF: string;
                                _EXT_REF?: string;
                                _LANG_REF: string;
                                _PREVIOUS_ANNOTATION?: string;
                            };
                        }[];
                        _ANNOTATOR?: string;
                        _DEFAULT_LOCALE?: string;
                        _EXT_REF?: string;
                        _LANG_REF?: string;
                        _LINGUISTIC_TYPE_REF: string;
                        _PARENT_REF?: string;
                        _PARTICIPANT?: string;
                        _TIER_ID: string;
                    }[];
                    TIME_ORDER: {
                        TIME_SLOT?: {
                            _TIME_SLOT_ID: string;
                            _TIME_VALUE?: number;
                        }[];
                    };
                    _AUTHOR: string;
                    _DATE: string;
                    _FORMAT?: string;
                    _VERSION: string;
                    _xmlns:xsi: string;
                    _xsi:noNamespaceSchemaLocation: string;
                };
            }

            Properties

            ANNOTATION_DOCUMENT +

            Properties

            ANNOTATION_DOCUMENT

            ANNOTATION_DOCUMENT: {
                CONSTRAINT: {
                    _DESCRIPTION?: string;
                    _STEREOTYPE: string;
                }[];
                CONTROLLED_VOCABULARY?: {
                    CV_ENTRY_ML?: {
                        CVE_VALUE: {
                            _DESCRIPTION?: string;
                            _LANG_REF: string;
                            _text: string;
                        };
                        _CVE_ID: string;
                        _EXT_REF?: string;
                    };
                    DESCRIPTION?: {
                        _LANG_REF: string;
                        _text: string;
                    };
                    _CV_ID: string;
                    _EXT_REF?: string;
                };
                EXTERNAL_REF?: {
                    _EXT_REF_ID: string;
                    _TYPE: string;
                    _VALUE: string;
                };
                HEADER: {
                    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;
                    }[];
                    _MEDIA_FILE?: string;
                    _TIME_UNITS?: "milliseconds" | "NTSC-frames" | "PAL-frames";
                };
                LANGUAGE?: {
                    _LANG_DEF?: string;
                    _LANG_ID: string;
                    _LANG_LABEL?: string;
                };
                LEXICON_REF?: {
                    _DATCAT_ID?: string;
                    _DATCAT_NAME?: string;
                    _LEXICON_ID: string;
                    _LEXICON_NAME: string;
                    _LEX_REF_ID: 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: {
                    ANNOTATION: {
                        ALIGNABLE_ANNOTATION?: {
                            ANNOTATION_VALUE: string;
                            _ANNOTATION_ID: string;
                            _SVG_REF?: string;
                            _TIME_SLOT_REF1: string;
                            _TIME_SLOT_REF2: string;
                        };
                        REF_ANNOTATION?: {
                            ANNOTATION_VALUE: string;
                            _ANNOTATION_ID: string;
                            _ANNOTATION_REF: string;
                            _CVE_REF: string;
                            _EXT_REF?: string;
                            _LANG_REF: string;
                            _PREVIOUS_ANNOTATION?: string;
                        };
                    }[];
                    _ANNOTATOR?: string;
                    _DEFAULT_LOCALE?: string;
                    _EXT_REF?: string;
                    _LANG_REF?: string;
                    _LINGUISTIC_TYPE_REF: string;
                    _PARENT_REF?: string;
                    _PARTICIPANT?: string;
                    _TIER_ID: string;
                }[];
                TIME_ORDER: {
                    TIME_SLOT?: {
                        _TIME_SLOT_ID: string;
                        _TIME_VALUE?: number;
                    }[];
                };
                _AUTHOR: string;
                _DATE: string;
                _FORMAT?: string;
                _VERSION: string;
                _xmlns:xsi: string;
                _xsi:noNamespaceSchemaLocation: string;
            }

            Type declaration

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

            Settings

            Member Visibility

            Theme

            On This Page

            ANNOTATION_DOCUMENT
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.ExportResult.html b/interfaces/_octra_annotation.ExportResult.html index 6f009fb31..f7cc56010 100644 --- a/interfaces/_octra_annotation.ExportResult.html +++ b/interfaces/_octra_annotation.ExportResult.html @@ -1,3 +1,3 @@ -ExportResult | Octra libraries - v2.0.0

            Interface ExportResult

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

            Properties

            error? +ExportResult | Octra libraries - v2.0.0

            Interface ExportResult

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

            Properties

            error? file? -

            Properties

            Optional error

            error?: string

            Optional file

            file?: IFile

            Settings

            Member Visibility

            Theme

            On This Page

            errorfile
            \ No newline at end of file +

            Properties

            Optional error

            error?: string

            Optional file

            file?: IFile

            Settings

            Member Visibility

            Theme

            On This Page

            errorfile
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.IAnnotJSON.html b/interfaces/_octra_annotation.IAnnotJSON.html index 5a4c9dd3f..68aeb5343 100644 --- a/interfaces/_octra_annotation.IAnnotJSON.html +++ b/interfaces/_octra_annotation.IAnnotJSON.html @@ -1,6 +1,6 @@ -IAnnotJSON | Octra libraries - v2.0.0

            Interface IAnnotJSON

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

            Implemented by

            Properties

            annotates +IAnnotJSON | Octra libraries - v2.0.0

            Interface IAnnotJSON

            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

            Theme

            On This Page

            annotateslevelslinksnamesampleRate
            \ No newline at end of file +

            Properties

            annotates

            annotates: string

            levels

            levels: ILevel[]

            links

            links: ILink[]

            name

            name: string

            sampleRate

            sampleRate: number

            Settings

            Member Visibility

            Theme

            On This Page

            annotateslevelslinksnamesampleRate
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.IAudioFile.html b/interfaces/_octra_annotation.IAudioFile.html index f3b40e2f3..1bec3a5f6 100644 --- a/interfaces/_octra_annotation.IAudioFile.html +++ b/interfaces/_octra_annotation.IAudioFile.html @@ -1,8 +1,8 @@ -IAudioFile | Octra libraries - v2.0.0

            Interface IAudioFile

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

            Properties

            arraybuffer? +IAudioFile | Octra libraries - v2.0.0

            Interface IAudioFile

            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

            Optional arraybuffer

            arraybuffer?: ArrayBuffer

            Optional duration

            duration?: number

            name

            name: string

            sampleRate

            sampleRate: number

            Optional size

            size?: number

            Optional type

            type?: string

            Optional url

            url?: string

            Settings

            Member Visibility

            Theme

            On This Page

            arraybufferdurationnamesampleRatesizetypeurl
            \ No newline at end of file +

            Properties

            Optional arraybuffer

            arraybuffer?: ArrayBuffer

            Optional duration

            duration?: number

            name

            name: string

            sampleRate

            sampleRate: number

            Optional size

            size?: number

            Optional type

            type?: string

            Optional url

            url?: string

            Settings

            Member Visibility

            Theme

            On This Page

            arraybufferdurationnamesampleRatesizetypeurl
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.IEvent.html b/interfaces/_octra_annotation.IEvent.html index 8d35b02dc..ef4a32f5d 100644 --- a/interfaces/_octra_annotation.IEvent.html +++ b/interfaces/_octra_annotation.IEvent.html @@ -1,4 +1,4 @@ -IEvent | Octra libraries - v2.0.0

            Interface IEvent

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

            Hierarchy (view full)

            Properties

            id +IEvent | Octra libraries - v2.0.0

            Interface IEvent

            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

            Theme

            On This Page

            idlabelssamplePoint
            \ No newline at end of file +

            Properties

            id

            id: number

            labels

            labels: ILabel[]

            samplePoint

            samplePoint: number

            Settings

            Member Visibility

            Theme

            On This Page

            idlabelssamplePoint
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.IEventLevel.html b/interfaces/_octra_annotation.IEventLevel.html index b3730f3e7..b8e553aa9 100644 --- a/interfaces/_octra_annotation.IEventLevel.html +++ b/interfaces/_octra_annotation.IEventLevel.html @@ -1,4 +1,4 @@ -IEventLevel | Octra libraries - v2.0.0

            Interface IEventLevel

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

            Hierarchy (view full)

            Implemented by

            Properties

            items +IEventLevel | Octra libraries - v2.0.0

            Interface IEventLevel

            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

            Theme

            On This Page

            itemsnametype
            \ No newline at end of file +

            Properties

            items

            items: IEvent[]

            name

            name: string

            type

            type: AnnotationLevelType

            Settings

            Member Visibility

            Theme

            On This Page

            itemsnametype
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.IFile.html b/interfaces/_octra_annotation.IFile.html index 17b1e7e54..74dd15481 100644 --- a/interfaces/_octra_annotation.IFile.html +++ b/interfaces/_octra_annotation.IFile.html @@ -1,5 +1,5 @@ -IFile | Octra libraries - v2.0.0

            Interface IFile

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

            Properties

            content +IFile | Octra libraries - v2.0.0

            Interface IFile

            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

            Theme

            On This Page

            contentencodingnametype
            \ No newline at end of file +

            Properties

            content

            content: string

            encoding

            encoding: string

            name

            name: string

            type

            type: string

            Settings

            Member Visibility

            Theme

            On This Page

            contentencodingnametype
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.IItem.html b/interfaces/_octra_annotation.IItem.html index 487eea156..d89dfc63b 100644 --- a/interfaces/_octra_annotation.IItem.html +++ b/interfaces/_octra_annotation.IItem.html @@ -1,3 +1,3 @@ -IItem | Octra libraries - v2.0.0

            Interface IItem

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

            Hierarchy (view full)

            Implemented by

            Properties

            id +IItem | Octra libraries - v2.0.0

            Interface IItem

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

            Hierarchy (view full)

            Implemented by

            Properties

            id labels -

            Properties

            id

            id: number

            labels

            labels: ILabel[]

            Settings

            Member Visibility

            Theme

            On This Page

            idlabels
            \ No newline at end of file +

            Properties

            id

            id: number

            labels

            labels: ILabel[]

            Settings

            Member Visibility

            Theme

            On This Page

            idlabels
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.IItemLevel.html b/interfaces/_octra_annotation.IItemLevel.html index 2594901d8..1d354fd23 100644 --- a/interfaces/_octra_annotation.IItemLevel.html +++ b/interfaces/_octra_annotation.IItemLevel.html @@ -1,4 +1,4 @@ -IItemLevel | Octra libraries - v2.0.0

            Interface IItemLevel

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

            Hierarchy (view full)

            Implemented by

            Properties

            items +IItemLevel | Octra libraries - v2.0.0

            Interface IItemLevel

            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

            Theme

            On This Page

            itemsnametype
            \ No newline at end of file +

            Properties

            items

            items: IItem[]

            name

            name: string

            type

            type: AnnotationLevelType

            Settings

            Member Visibility

            Theme

            On This Page

            itemsnametype
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.ILabel.html b/interfaces/_octra_annotation.ILabel.html index a02b1fed4..2636d05a9 100644 --- a/interfaces/_octra_annotation.ILabel.html +++ b/interfaces/_octra_annotation.ILabel.html @@ -1,3 +1,3 @@ -ILabel | Octra libraries - v2.0.0

            Interface ILabel

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

            Implemented by

            Properties

            name +ILabel | Octra libraries - v2.0.0

            Interface ILabel

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

            Implemented by

            Properties

            name value -

            Properties

            name

            name: string

            value

            value: string

            Settings

            Member Visibility

            Theme

            On This Page

            namevalue
            \ No newline at end of file +

            Properties

            name

            name: string

            value

            value: string

            Settings

            Member Visibility

            Theme

            On This Page

            namevalue
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.ILevel.html b/interfaces/_octra_annotation.ILevel.html index 05b407225..92508a8c6 100644 --- a/interfaces/_octra_annotation.ILevel.html +++ b/interfaces/_octra_annotation.ILevel.html @@ -1,3 +1,3 @@ -ILevel | Octra libraries - v2.0.0

            Interface ILevel

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

            Hierarchy (view full)

            Implemented by

            Properties

            name +ILevel | Octra libraries - v2.0.0

            Interface ILevel

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

            Hierarchy (view full)

            Implemented by

            Properties

            name type -

            Properties

            name

            name: string

            type

            type: AnnotationLevelType

            Settings

            Member Visibility

            Theme

            On This Page

            nametype
            \ No newline at end of file +

            Properties

            name

            name: string

            type

            type: AnnotationLevelType

            Settings

            Member Visibility

            Theme

            On This Page

            nametype
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.ILink.html b/interfaces/_octra_annotation.ILink.html index cafee6d5b..892f465aa 100644 --- a/interfaces/_octra_annotation.ILink.html +++ b/interfaces/_octra_annotation.ILink.html @@ -1,3 +1,3 @@ -ILink | Octra libraries - v2.0.0

            Interface ILink

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

            Implemented by

            Properties

            fromID +ILink | Octra libraries - v2.0.0

            Interface ILink

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

            Implemented by

            Properties

            fromID toID -

            Properties

            fromID

            fromID: number

            toID

            toID: number

            Settings

            Member Visibility

            Theme

            On This Page

            fromIDtoID
            \ No newline at end of file +

            Properties

            fromID

            fromID: number

            toID

            toID: number

            Settings

            Member Visibility

            Theme

            On This Page

            fromIDtoID
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.ISegment.html b/interfaces/_octra_annotation.ISegment.html index 3ee096981..ccef63374 100644 --- a/interfaces/_octra_annotation.ISegment.html +++ b/interfaces/_octra_annotation.ISegment.html @@ -1,5 +1,5 @@ -ISegment | Octra libraries - v2.0.0

            Interface ISegment

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

            Hierarchy (view full)

            Properties

            id +ISegment | Octra libraries - v2.0.0

            Interface ISegment

            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

            Theme

            On This Page

            idlabelssampleDursampleStart
            \ No newline at end of file +

            Properties

            id

            id: number

            labels

            labels: ILabel[]

            sampleDur

            sampleDur: number

            sampleStart

            sampleStart: number

            Settings

            Member Visibility

            Theme

            On This Page

            idlabelssampleDursampleStart
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.ISegmentLevel.html b/interfaces/_octra_annotation.ISegmentLevel.html index dbaada2bf..b4dd3b48e 100644 --- a/interfaces/_octra_annotation.ISegmentLevel.html +++ b/interfaces/_octra_annotation.ISegmentLevel.html @@ -1,4 +1,4 @@ -ISegmentLevel | Octra libraries - v2.0.0

            Interface ISegmentLevel

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

            Hierarchy (view full)

            Implemented by

            Properties

            items +ISegmentLevel | Octra libraries - v2.0.0

            Interface ISegmentLevel

            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

            Theme

            On This Page

            itemsnametype
            \ No newline at end of file +

            Properties

            items

            items: ISegment[]

            name

            name: string

            type

            type: AnnotationLevelType

            Settings

            Member Visibility

            Theme

            On This Page

            itemsnametype
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.ImportResult.html b/interfaces/_octra_annotation.ImportResult.html index 022bad3e4..3bb3df8ad 100644 --- a/interfaces/_octra_annotation.ImportResult.html +++ b/interfaces/_octra_annotation.ImportResult.html @@ -1,4 +1,4 @@ -ImportResult | Octra libraries - v2.0.0

            Interface ImportResult

            interface ImportResult {
                annotjson?: OAnnotJSON;
                audiofile?: OAudiofile;
                error?: string;
            }

            Properties

            annotjson? +ImportResult | Octra libraries - v2.0.0

            Interface ImportResult

            interface ImportResult {
                annotjson?: OAnnotJSON;
                audiofile?: OAudiofile;
                error?: string;
            }

            Properties

            annotjson? audiofile? error? -

            Properties

            Optional annotjson

            annotjson?: OAnnotJSON

            Optional audiofile

            audiofile?: OAudiofile

            Optional error

            error?: string

            Settings

            Member Visibility

            Theme

            On This Page

            annotjsonaudiofileerror
            \ No newline at end of file +

            Properties

            Optional annotjson

            annotjson?: OAnnotJSON

            Optional audiofile

            audiofile?: OAudiofile

            Optional error

            error?: string

            Settings

            Member Visibility

            Theme

            On This Page

            annotjsonaudiofileerror
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.SegmentWithContext.html b/interfaces/_octra_annotation.SegmentWithContext.html index 7c840865c..ad708d3a2 100644 --- a/interfaces/_octra_annotation.SegmentWithContext.html +++ b/interfaces/_octra_annotation.SegmentWithContext.html @@ -1,5 +1,5 @@ -SegmentWithContext | Octra libraries - v2.0.0

            Interface SegmentWithContext<T>

            interface SegmentWithContext<T> {
                context?: T;
                id: number;
                labels: OLabel[];
                time: SampleUnit;
            }

            Type Parameters

            Implemented by

            Properties

            context? +SegmentWithContext | Octra libraries - v2.0.0

            Interface SegmentWithContext<T>

            interface SegmentWithContext<T> {
                context?: T;
                id: number;
                labels: OLabel[];
                time: SampleUnit;
            }

            Type Parameters

            Implemented by

            Properties

            context? id labels time -

            Properties

            Optional context

            context?: T

            id

            id: number

            labels

            labels: OLabel[]

            time

            time: SampleUnit

            Settings

            Member Visibility

            Theme

            On This Page

            contextidlabelstime
            \ No newline at end of file +

            Properties

            Optional context

            context?: T

            id

            id: number

            labels

            labels: OLabel[]

            time

            time: SampleUnit

            Settings

            Member Visibility

            Theme

            On This Page

            contextidlabelstime
            \ No newline at end of file diff --git a/interfaces/_octra_annotation.WhisperJSONWord.html b/interfaces/_octra_annotation.WhisperJSONWord.html index 4479d5910..1ac2751c9 100644 --- a/interfaces/_octra_annotation.WhisperJSONWord.html +++ b/interfaces/_octra_annotation.WhisperJSONWord.html @@ -1,7 +1,7 @@ -WhisperJSONWord | Octra libraries - v2.0.0

            Interface WhisperJSONWord

            interface WhisperJSONWord {
                end: number;
                probability?: number;
                score?: number;
                speaker?: string;
                start: number;
                word: string;
            }

            Properties

            end +WhisperJSONWord | Octra libraries - v2.0.0

            Interface WhisperJSONWord

            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

            Optional probability

            probability?: number

            Optional score

            score?: number

            Optional speaker

            speaker?: string

            start

            start: number

            word

            word: string

            Settings

            Member Visibility

            Theme

            On This Page

            endprobabilityscorespeakerstartword
            \ No newline at end of file +

            Properties

            end

            end: number

            Optional probability

            probability?: number

            Optional score

            score?: number

            Optional speaker

            speaker?: string

            start

            start: number

            word

            word: string

            Settings

            Member Visibility

            Theme

            On This Page

            endprobabilityscorespeakerstartword
            \ No newline at end of file diff --git a/interfaces/_octra_assets.OctraGuidelines.html b/interfaces/_octra_assets.OctraGuidelines.html index a83218abc..acf58cd57 100644 --- a/interfaces/_octra_assets.OctraGuidelines.html +++ b/interfaces/_octra_assets.OctraGuidelines.html @@ -1,4 +1,4 @@ -OctraGuidelines | Octra libraries - v2.0.0

            Interface OctraGuidelines

            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

            Interface OctraGuidelines

            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;
            }[]

            Type declaration

            • 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;
            }[]

            Type declaration

            • 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;
            }

            Type declaration

            • authors: string
            • date: string
            • encoding: string
            • object_language: string
            • pdf: {
                  url: string;
              }
              • url: string
            • project: string
            • validation_url: string
            • version: string

            Settings

            Member Visibility

            Theme

            On This Page

            instructionsmarkersmeta
            \ No newline at end of file +

            Properties

            instructions

            instructions: {
                entries: {
                    code: string;
                    description: string;
                    examples: {
                        annotation: string;
                        url: string;
                    }[];
                    priority: string;
                    title: string;
                }[];
                group: string;
            }[]

            Type declaration

            • 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;
            }[]

            Type declaration

            • 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;
            }

            Type declaration

            • authors: string
            • date: string
            • encoding: string
            • object_language: string
            • pdf: {
                  url: string;
              }
              • url: string
            • project: string
            • validation_url: string
            • version: string

            Settings

            Member Visibility

            Theme

            On This Page

            instructionsmarkersmeta
            \ No newline at end of file diff --git a/interfaces/_octra_json_sets.AudioFileMetaData.html b/interfaces/_octra_json_sets.AudioFileMetaData.html index 7a6593922..cac52292a 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

            Interface AudioFileMetaData

            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

            Interface AudioFileMetaData

            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

            Optional bitRate

            bitRate?: number

            Optional codec

            codec?: string

            Optional container

            container?: string

            Optional duration

            duration?: {
                samples: number;
                seconds: number;
            }

            Type declaration

            • samples: number
            • seconds: number

            Optional lossless

            lossless?: boolean

            Optional numberOfChannels

            numberOfChannels?: number

            Optional sampleRate

            sampleRate?: number

            Settings

            Member Visibility

            Theme

            On This Page

            bitRatecodeccontainerdurationlosslessnumberOfChannelssampleRate
            \ No newline at end of file +

            Properties

            Optional bitRate

            bitRate?: number

            Optional codec

            codec?: string

            Optional container

            container?: string

            Optional duration

            duration?: {
                samples: number;
                seconds: number;
            }

            Type declaration

            • samples: number
            • seconds: number

            Optional lossless

            lossless?: boolean

            Optional numberOfChannels

            numberOfChannels?: number

            Optional sampleRate

            sampleRate?: number

            Settings

            Member Visibility

            Theme

            On This Page

            bitRatecodeccontainerdurationlosslessnumberOfChannelssampleRate
            \ No newline at end of file diff --git a/interfaces/_octra_media.IAudioFile.html b/interfaces/_octra_media.IAudioFile.html index d6d5f0ee0..e62b169dd 100644 --- a/interfaces/_octra_media.IAudioFile.html +++ b/interfaces/_octra_media.IAudioFile.html @@ -1,7 +1,7 @@ -IAudioFile | Octra libraries - v2.0.0

            Interface IAudioFile

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

            Implemented by

            Properties

            duration +IAudioFile | Octra libraries - v2.0.0

            Interface IAudioFile

            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

            Optional url

            url?: string

            Settings

            Member Visibility

            Theme

            On This Page

            durationnamesampleRatesizetypeurl
            \ No newline at end of file +

            Properties

            duration

            duration: number

            name

            name: string

            sampleRate

            sampleRate: number

            size

            size: number

            type

            type: string

            Optional url

            url?: string

            Settings

            Member Visibility

            Theme

            On This Page

            durationnamesampleRatesizetypeurl
            \ No newline at end of file diff --git a/interfaces/_octra_media.NumeratedSegment.html b/interfaces/_octra_media.NumeratedSegment.html index f04813f7f..941773b78 100644 --- a/interfaces/_octra_media.NumeratedSegment.html +++ b/interfaces/_octra_media.NumeratedSegment.html @@ -1,4 +1,4 @@ -NumeratedSegment | Octra libraries - v2.0.0

            Interface NumeratedSegment

            interface NumeratedSegment {
                number: number;
                sampleDur: number;
                sampleStart: number;
            }

            Properties

            number +NumeratedSegment | Octra libraries - v2.0.0

            Interface NumeratedSegment

            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

            Theme

            On This Page

            numbersampleDursampleStart
            \ No newline at end of file +

            Properties

            number

            number: number

            sampleDur

            sampleDur: number

            sampleStart

            sampleStart: number

            Settings

            Member Visibility

            Theme

            On This Page

            numbersampleDursampleStart
            \ No newline at end of file diff --git a/interfaces/_octra_media.SampleTimeValues.html b/interfaces/_octra_media.SampleTimeValues.html index e589808ae..1df2375e5 100644 --- a/interfaces/_octra_media.SampleTimeValues.html +++ b/interfaces/_octra_media.SampleTimeValues.html @@ -1,4 +1,4 @@ SampleTimeValues | Octra libraries - v2.0.0

            Interface SampleTimeValues

            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

            Theme

            On This Page

            secondsunix
            \ No newline at end of file +

            Properties

            seconds

            seconds: number

            unix

            unix: number

            Settings

            Member Visibility

            Theme

            On This Page

            secondsunix
            \ No newline at end of file diff --git a/interfaces/_octra_ngx_components.AudioViewerShortcutEvent.html b/interfaces/_octra_ngx_components.AudioViewerShortcutEvent.html index 047ef1401..8fa9f1fff 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

            Interface AudioViewerShortcutEvent

            interface AudioViewerShortcutEvent {
                selection?: AudioSelection;
                shortcut: string;
                shortcutName: string;
                timePosition?: SampleUnit;
                timestamp: number;
                type: string;
                value?: string;
            }

            Properties

            selection? +AudioViewerShortcutEvent | Octra libraries - v2.0.0

            Interface AudioViewerShortcutEvent

            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

            Optional selection

            selection?: AudioSelection

            shortcut

            shortcut: string

            shortcutName

            shortcutName: string

            Optional timePosition

            timePosition?: SampleUnit

            timestamp

            timestamp: number

            type

            type: string

            Optional value

            value?: string

            Settings

            Member Visibility

            Theme

            On This Page

            selectionshortcutshortcutNametimePositiontimestamptypevalue
            \ No newline at end of file +

            Properties

            Optional selection

            selection?: AudioSelection

            shortcut

            shortcut: string

            shortcutName

            shortcutName: string

            Optional timePosition

            timePosition?: SampleUnit

            timestamp

            timestamp: number

            type

            type: string

            Optional value

            value?: string

            Settings

            Member Visibility

            Theme

            On This Page

            selectionshortcutshortcutNametimePositiontimestamptypevalue
            \ No newline at end of file diff --git a/interfaces/_octra_ngx_components.CurrentLevelChangeEvent.html b/interfaces/_octra_ngx_components.CurrentLevelChangeEvent.html index 1f74a73ca..f531da575 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

            Interface CurrentLevelChangeEvent

            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

            Interface CurrentLevelChangeEvent

            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;
            }[]

            Type declaration

            Optional removeOptions

            removeOptions?: {
                mergeTranscripts: boolean;
                silenceCode: undefined | string;
            }

            Type declaration

            • mergeTranscripts: boolean
            • silenceCode: undefined | string

            type

            type: "change" | "add" | "remove"

            Settings

            Member Visibility

            Theme

            On This Page

            itemsremoveOptionstype
            \ No newline at end of file +

            Properties

            items

            items: {
                id?: number;
                index?: number;
                instance?: AnnotationAnySegment;
            }[]

            Type declaration

            Optional removeOptions

            removeOptions?: {
                mergeTranscripts: boolean;
                silenceCode: undefined | string;
            }

            Type declaration

            • mergeTranscripts: boolean
            • silenceCode: undefined | string

            type

            type: "change" | "add" | "remove"

            Settings

            Member Visibility

            Theme

            On This Page

            itemsremoveOptionstype
            \ No newline at end of file diff --git a/interfaces/_octra_ngx_components.ICircle.html b/interfaces/_octra_ngx_components.ICircle.html index 7a7f05d0b..5f623fa73 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

            Interface ICircle

            interface ICircle {
                position: IPosition;
                radius: number;
            }

            Properties

            position +ICircle | Octra libraries - v2.0.0

            Interface ICircle

            interface ICircle {
                position: IPosition;
                radius: number;
            }

            Properties

            position radius -

            Properties

            position

            position: IPosition

            radius

            radius: number

            Settings

            Member Visibility

            Theme

            On This Page

            positionradius
            \ No newline at end of file +

            Properties

            position

            position: IPosition

            radius

            radius: number

            Settings

            Member Visibility

            Theme

            On This Page

            positionradius
            \ No newline at end of file diff --git a/interfaces/_octra_ngx_components.IInterval.html b/interfaces/_octra_ngx_components.IInterval.html index cef9941f7..2873ac662 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

            Interface IInterval

            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

            Theme

            On This Page

            endstart
            \ No newline at end of file +

            Properties

            end

            end: number

            start

            start: number

            Settings

            Member Visibility

            Theme

            On This Page

            endstart
            \ No newline at end of file diff --git a/interfaces/_octra_ngx_components.IMargin.html b/interfaces/_octra_ngx_components.IMargin.html index 77052bf6a..89d267177 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

            Interface IMargin

            interface IMargin {
                bottom: number;
                left: number;
                right: number;
                top: number;
            }

            Implemented by

            Properties

            bottom +IMargin | Octra libraries - v2.0.0

            Interface IMargin

            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

            Theme

            On This Page

            bottomleftrighttop
            \ No newline at end of file +

            Properties

            bottom

            bottom: number

            left

            left: number

            right

            right: number

            top

            top: number

            Settings

            Member Visibility

            Theme

            On This Page

            bottomleftrighttop
            \ No newline at end of file diff --git a/interfaces/_octra_ngx_components.IPosition.html b/interfaces/_octra_ngx_components.IPosition.html index 587ff7ef4..494dbf3b2 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

            Interface IPosition

            interface IPosition {
                x: number;
                y: number;
            }

            Properties

            x +IPosition | Octra libraries - v2.0.0

            Interface IPosition

            interface IPosition {
                x: number;
                y: number;
            }

            Properties

            x y -

            Properties

            x

            x: number

            y

            y: number

            Settings

            Member Visibility

            Theme

            On This Page

            xy
            \ No newline at end of file +

            Properties

            x

            x: number

            y

            y: number

            Settings

            Member Visibility

            Theme

            On This Page

            xy
            \ No newline at end of file diff --git a/interfaces/_octra_ngx_components.IRectangle.html b/interfaces/_octra_ngx_components.IRectangle.html index 54ad00c69..fdb5428dd 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

            Interface IRectangle

            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

            Theme

            On This Page

            positionsize
            \ No newline at end of file +

            Properties

            position

            position: IPosition

            size

            size: ISize

            Settings

            Member Visibility

            Theme

            On This Page

            positionsize
            \ No newline at end of file diff --git a/interfaces/_octra_ngx_components.ISize.html b/interfaces/_octra_ngx_components.ISize.html index d7d99ec7d..385f0d90f 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

            Interface ISize

            interface ISize {
                height: number;
                width: number;
            }

            Implemented by

            Properties

            height +ISize | Octra libraries - v2.0.0

            Interface ISize

            interface ISize {
                height: number;
                width: number;
            }

            Implemented by

            Properties

            height width -

            Properties

            height

            height: number

            width

            width: number

            Settings

            Member Visibility

            Theme

            On This Page

            heightwidth
            \ No newline at end of file +

            Properties

            height

            height: number

            width

            width: number

            Settings

            Member Visibility

            Theme

            On This Page

            heightwidth
            \ No newline at end of file diff --git a/interfaces/_octra_utilities.FileSize.html b/interfaces/_octra_utilities.FileSize.html index f1b671bf5..da96703de 100644 --- a/interfaces/_octra_utilities.FileSize.html +++ b/interfaces/_octra_utilities.FileSize.html @@ -1,4 +1,4 @@ FileSize | Octra libraries - v2.0.0

            Interface FileSize

            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

            Theme

            On This Page

            labelsize
            \ No newline at end of file +

            Properties

            label

            label: string

            size

            size: number

            Settings

            Member Visibility

            Theme

            On This Page

            labelsize
            \ No newline at end of file diff --git a/interfaces/_octra_utilities.Serializable.html b/interfaces/_octra_utilities.Serializable.html index 43277aabb..d611f1123 100644 --- a/interfaces/_octra_utilities.Serializable.html +++ b/interfaces/_octra_utilities.Serializable.html @@ -1,3 +1,3 @@ -Serializable | Octra libraries - v2.0.0

            Interface Serializable<S, T>

            interface Serializable<S, T> {
                deserialize(jsonObject, sampleRate): undefined | T;
                serialize(): S;
            }

            Type Parameters

            • S
            • T

            Implemented by

              Methods

              deserialize +Serializable | Octra libraries - v2.0.0

              Interface Serializable<S, T>

              interface Serializable<S, T> {
                  deserialize(jsonObject, sampleRate): 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

                Theme

                On This Page

                deserializeserialize
                \ No newline at end of file +

                Methods

                deserialize

                • deserialize(jsonObject, sampleRate): undefined | T

                • Parameters

                  • jsonObject: S
                  • sampleRate: number

                  Returns undefined | T

                serialize

                Settings

                Member Visibility

                Theme

                On This Page

                deserializeserialize
                \ No newline at end of file diff --git a/interfaces/_octra_web_media.KeyMappingEntry.html b/interfaces/_octra_web_media.KeyMappingEntry.html index de976d257..cc02e5970 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

                Interface KeyMappingEntry

                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

                Theme

                On This Page

                keyCodename
                \ No newline at end of file +

                Properties

                keyCode

                keyCode: number

                name

                name: string

                Settings

                Member Visibility

                Theme

                On This Page

                keyCodename
                \ No newline at end of file diff --git a/interfaces/_octra_web_media.SegmentToDecode.html b/interfaces/_octra_web_media.SegmentToDecode.html index 4cc05bf3f..844129962 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

                Interface SegmentToDecode

                interface SegmentToDecode {
                    number: number;
                    sampleDur: SampleUnit;
                    sampleStart: SampleUnit;
                }

                Properties

                number +SegmentToDecode | Octra libraries - v2.0.0

                Interface SegmentToDecode

                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

                Theme

                On This Page

                numbersampleDursampleStart
                \ No newline at end of file +

                Properties

                number

                number: number

                sampleDur

                sampleDur: SampleUnit

                sampleStart

                sampleStart: SampleUnit

                Settings

                Member Visibility

                Theme

                On This Page

                numbersampleDursampleStart
                \ No newline at end of file diff --git a/interfaces/_octra_web_media.Shortcut.html b/interfaces/_octra_web_media.Shortcut.html index a90e7c03c..7a1898bb4 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

                Interface Shortcut

                shortcut definition

                -
                interface Shortcut {
                    callback?: ((keyboardEvent, shortcut, hotkeyEvent, shortcutGroup) => void);
                    focusonly?: boolean;
                    keys: {
                        mac?: string;
                        pc?: string;
                    };
                    label?: string;
                    name: string;
                    title: string;
                }

                Properties

                callback? +
                interface Shortcut {
                    callback?: ((keyboardEvent, shortcut, hotkeyEvent, shortcutGroup) => void);
                    focusonly?: boolean;
                    keys: {
                        mac?: string;
                        pc?: string;
                    };
                    label?: string;
                    name: string;
                    title: string;
                }

                Properties

                callback? focusonly? keys label? name title -

                Properties

                Optional callback

                callback?: ((keyboardEvent, shortcut, hotkeyEvent, shortcutGroup) => void)

                Type declaration

                  • (keyboardEvent, shortcut, hotkeyEvent, shortcutGroup): void

                  • Parameters

                    Returns void

                Optional focusonly

                focusonly?: boolean

                keys

                keys: {
                    mac?: string;
                    pc?: string;
                }

                Type declaration

                • Optional mac?: string
                • Optional pc?: string

                Optional label

                label?: string

                name

                name: string

                title

                title: string

                Settings

                Member Visibility

                Theme

                On This Page

                callbackfocusonlykeyslabelnametitle
                \ No newline at end of file +

                Properties

                Optional callback

                callback?: ((keyboardEvent, shortcut, hotkeyEvent, shortcutGroup) => void)

                Type declaration

                  • (keyboardEvent, shortcut, hotkeyEvent, shortcutGroup): void

                  • Parameters

                    Returns void

                Optional focusonly

                focusonly?: boolean

                keys

                keys: {
                    mac?: string;
                    pc?: string;
                }

                Type declaration

                • Optional mac?: string
                • Optional pc?: string

                Optional label

                label?: string

                name

                name: string

                title

                title: string

                Settings

                Member Visibility

                Theme

                On This Page

                callbackfocusonlykeyslabelnametitle
                \ No newline at end of file diff --git a/interfaces/_octra_web_media.ShortcutEvent.html b/interfaces/_octra_web_media.ShortcutEvent.html index 7cd5b0cf0..95329da88 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

                Interface ShortcutEvent

                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

                Optional onFocusOnly

                onFocusOnly?: boolean

                platform

                platform: string

                shortcut

                shortcut: string

                shortcutGroupName

                shortcutGroupName: string

                shortcutName

                shortcutName: string

                timestamp

                timestamp: number

                Settings

                Member Visibility

                Theme

                On This Page

                eventonFocusOnlyplatformshortcutshortcutGroupNameshortcutNametimestamp
                \ No newline at end of file +

                Properties

                event

                event: KeyboardEvent

                Optional onFocusOnly

                onFocusOnly?: boolean

                platform

                platform: string

                shortcut

                shortcut: string

                shortcutGroupName

                shortcutGroupName: string

                shortcutName

                shortcutName: string

                timestamp

                timestamp: number

                Settings

                Member Visibility

                Theme

                On This Page

                eventonFocusOnlyplatformshortcutshortcutGroupNameshortcutNametimestamp
                \ No newline at end of file diff --git a/interfaces/_octra_web_media.ShortcutGroup.html b/interfaces/_octra_web_media.ShortcutGroup.html index c05a4b5b6..a834f43b8 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

                Interface ShortcutGroup

                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

                Theme

                On This Page

                enableditemsname
                \ No newline at end of file +

                Properties

                enabled

                enabled: boolean

                items

                items: Shortcut[]

                name

                name: string

                Settings

                Member Visibility

                Theme

                On This Page

                enableditemsname
                \ No newline at end of file diff --git a/modules/_octra_annotation.html b/modules/_octra_annotation.html index 22be1ae73..245ced813 100644 --- a/modules/_octra_annotation.html +++ b/modules/_octra_annotation.html @@ -1,4 +1,4 @@ -@octra/annotation - v0.1.13 | Octra libraries - v2.0.0

                Module @octra/annotation - v0.1.13

                @octra/annotation npm

                This library offers all annotation related classes and functions used by Octra. It uses AnnotJSON file format as base +@octra/annotation - v0.1.14 | Octra libraries - v2.0.0

                Module @octra/annotation - v0.1.14

                @octra/annotation npm

                This library offers all annotation related classes and functions used by Octra. It uses AnnotJSON file format as base model. Here you can also find all Annotation converters used by Octra.

                Installation

                ESM, CJS, TS definitions & UMD (optional)

                npm install --save @octra/annotation
                diff --git a/types/_octra_annotation.AnnotationAnySegment.html b/types/_octra_annotation.AnnotationAnySegment.html index 48b75bb7e..eb209e280 100644 --- a/types/_octra_annotation.AnnotationAnySegment.html +++ b/types/_octra_annotation.AnnotationAnySegment.html @@ -1 +1 @@ -AnnotationAnySegment | Octra libraries - v2.0.0

                Type alias AnnotationAnySegment

                AnnotationAnySegment: OctraAnnotationSegment<ASRContext> | OItem | OctraAnnotationEvent

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +AnnotationAnySegment | Octra libraries - v2.0.0

                Type alias AnnotationAnySegment

                AnnotationAnySegment: OctraAnnotationSegment<ASRContext> | OItem | OctraAnnotationEvent

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/types/_octra_annotation.IAnyLevel.html b/types/_octra_annotation.IAnyLevel.html index cedbfc3c7..1743681b7 100644 --- a/types/_octra_annotation.IAnyLevel.html +++ b/types/_octra_annotation.IAnyLevel.html @@ -1 +1 @@ -IAnyLevel | Octra libraries - v2.0.0

                Type alias IAnyLevel

                IAnyLevel: ISegmentLevel | IItemLevel | IEventLevel

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +IAnyLevel | Octra libraries - v2.0.0

                Type alias IAnyLevel

                IAnyLevel: ISegmentLevel | IItemLevel | IEventLevel

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/types/_octra_annotation.OAnyLevel.html b/types/_octra_annotation.OAnyLevel.html index 85326d0e6..b9bf781f3 100644 --- a/types/_octra_annotation.OAnyLevel.html +++ b/types/_octra_annotation.OAnyLevel.html @@ -1 +1 @@ -OAnyLevel | Octra libraries - v2.0.0

                Type alias OAnyLevel<T>

                OAnyLevel<T>: OSegmentLevel<T> | OItemLevel | OEventLevel

                Type Parameters

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +OAnyLevel | Octra libraries - v2.0.0

                Type alias OAnyLevel<T>

                OAnyLevel<T>: OSegmentLevel<T> | OItemLevel | OEventLevel

                Type Parameters

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/types/_octra_annotation.OctraAnnotationAnyLevel.html b/types/_octra_annotation.OctraAnnotationAnyLevel.html index 3ae4712fe..fc07a33a4 100644 --- a/types/_octra_annotation.OctraAnnotationAnyLevel.html +++ b/types/_octra_annotation.OctraAnnotationAnyLevel.html @@ -1 +1 @@ -OctraAnnotationAnyLevel | Octra libraries - v2.0.0

                Type alias OctraAnnotationAnyLevel<T>

                OctraAnnotationAnyLevel<T>: OctraAnnotationSegmentLevel<T> | OctraAnnotationItemLevel | OctraAnnotationEventLevel

                Type Parameters

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +OctraAnnotationAnyLevel | Octra libraries - v2.0.0

                Type alias OctraAnnotationAnyLevel<T>

                OctraAnnotationAnyLevel<T>: OctraAnnotationSegmentLevel<T> | OctraAnnotationItemLevel | OctraAnnotationEventLevel

                Type Parameters

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/types/_octra_annotation.OctraAnnotationFormatType.html b/types/_octra_annotation.OctraAnnotationFormatType.html index ff0973336..4ff892eb6 100644 --- a/types/_octra_annotation.OctraAnnotationFormatType.html +++ b/types/_octra_annotation.OctraAnnotationFormatType.html @@ -1 +1 @@ -OctraAnnotationFormatType | Octra libraries - v2.0.0

                Type alias OctraAnnotationFormatType

                OctraAnnotationFormatType: "AnnotJSON" | "BundleJSON" | "CTM" | "ELAN" | "BASPartitur" | "PraatTextTable" | "SRT" | "PlainText" | "TextGrid" | "WhisperJSON" | "WebVTT"

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +OctraAnnotationFormatType | Octra libraries - v2.0.0

                Type alias OctraAnnotationFormatType

                OctraAnnotationFormatType: "AnnotJSON" | "BundleJSON" | "CTM" | "ELAN" | "BASPartitur" | "PraatTextTable" | "SRT" | "PlainText" | "TextGrid" | "WhisperJSON" | "WebVTT"

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/types/_octra_json_sets.JSONSetExpression.html b/types/_octra_json_sets.JSONSetExpression.html index ad2cb42ee..2a517f285 100644 --- a/types/_octra_json_sets.JSONSetExpression.html +++ b/types/_octra_json_sets.JSONSetExpression.html @@ -1 +1 @@ -JSONSetExpression | Octra libraries - v2.0.0

                Type alias JSONSetExpression<U>

                JSONSetExpression<U>: JSONSetStatement<U> | JSONSet<U>

                Type Parameters

                • U

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +JSONSetExpression | Octra libraries - v2.0.0

                Type alias JSONSetExpression<U>

                JSONSetExpression<U>: JSONSetStatement<U> | JSONSet<U>

                Type Parameters

                • U

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/types/_octra_web_media.IntArray.html b/types/_octra_web_media.IntArray.html index c0d86b408..3bc569625 100644 --- a/types/_octra_web_media.IntArray.html +++ b/types/_octra_web_media.IntArray.html @@ -1 +1 @@ -IntArray | Octra libraries - v2.0.0

                Type alias IntArray

                IntArray: Uint8Array | Int16Array | Int32Array

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +IntArray | Octra libraries - v2.0.0

                Type alias IntArray

                IntArray: Uint8Array | Int16Array | Int32Array

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/variables/_octra_assets.IO_SETS.html b/variables/_octra_assets.IO_SETS.html index 009718774..9a25718ce 100644 --- a/variables/_octra_assets.IO_SETS.html +++ b/variables/_octra_assets.IO_SETS.html @@ -1 +1 @@ -IO_SETS | Octra libraries - v2.0.0

                Variable IO_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;
                    };
                } = ...

                Type declaration

                • 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;
                  }
                  • 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;
                    }
                    • 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;
                  }
                  • combine: {
                        expressions: {
                            description: string;
                            name: string;
                            select: string;
                            with: {
                                content: string;
                                extension: string[];
                                mimeType: string[];
                            };
                        }[];
                        type: string;
                    }
                    • expressions: {
                          description: string;
                          name: string;
                          select: string;
                          with: {
                              content: string;
                              extension: string[];
                              mimeType: string[];
                          };
                      }[]
                    • type: string
                  • description: string
                  • name: string

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +IO_SETS | Octra libraries - v2.0.0

                Variable IO_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;
                    };
                } = ...

                Type declaration

                • 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;
                  }
                  • 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;
                    }
                    • 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;
                  }
                  • combine: {
                        expressions: {
                            description: string;
                            name: string;
                            select: string;
                            with: {
                                content: string;
                                extension: string[];
                                mimeType: string[];
                            };
                        }[];
                        type: string;
                    }
                    • expressions: {
                          description: string;
                          name: string;
                          select: string;
                          with: {
                              content: string;
                              extension: string[];
                              mimeType: string[];
                          };
                      }[]
                    • type: string
                  • description: string
                  • name: string

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/variables/_octra_assets.OctraGuidelinesJSONSchema.html b/variables/_octra_assets.OctraGuidelinesJSONSchema.html index edb7ebf56..f22abea51 100644 --- a/variables/_octra_assets.OctraGuidelinesJSONSchema.html +++ b/variables/_octra_assets.OctraGuidelinesJSONSchema.html @@ -1 +1 @@ -OctraGuidelinesJSONSchema | Octra libraries - v2.0.0

                Variable OctraGuidelinesJSONSchemaConst

                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;
                } = ...

                Type declaration

                • 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;
                      };
                  }
                  • 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;
                    }
                    • 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;
                      }
                      • 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;
                            };
                        }
                        • 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;
                          }
                          • items: {
                                properties: {
                                    code: {
                                        type: string;
                                    };
                                    description: {
                                        type: string;
                                    };
                                    examples: {
                                        items: {
                                            properties: {
                                                annotation: ...;
                                                url: ...;
                                            };
                                            type: string;
                                        };
                                        type: string;
                                    };
                                    priority: {
                                        type: string;
                                    };
                                    title: {
                                        type: string;
                                    };
                                };
                            }
                            • properties: {
                                  code: {
                                      type: string;
                                  };
                                  description: {
                                      type: string;
                                  };
                                  examples: {
                                      items: {
                                          properties: {
                                              annotation: ...;
                                              url: ...;
                                          };
                                          type: string;
                                      };
                                      type: string;
                                  };
                                  priority: {
                                      type: string;
                                  };
                                  title: {
                                      type: string;
                                  };
                              }
                              • code: {
                                    type: string;
                                }
                                • type: string
                              • description: {
                                    type: string;
                                }
                                • type: string
                              • examples: {
                                    items: {
                                        properties: {
                                            annotation: ...;
                                            url: ...;
                                        };
                                        type: string;
                                    };
                                    type: string;
                                }
                                • items: {
                                      properties: {
                                          annotation: ...;
                                          url: ...;
                                      };
                                      type: string;
                                  }
                                  • properties: {
                                        annotation: ...;
                                        url: ...;
                                    }
                                    • annotation: ...
                                    • url: ...
                                  • type: string
                                • type: string
                              • priority: {
                                    type: string;
                                }
                                • type: string
                              • title: {
                                    type: string;
                                }
                                • type: string
                          • type: string
                        • group: {
                              type: string;
                          }
                          • 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;
                    }
                    • 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;
                      }
                      • 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;
                            };
                        }
                        • button_text: {
                              type: string;
                          }
                          • type: string
                        • code: {
                              type: string;
                          }
                          • type: string
                        • description: {
                              type: string;
                          }
                          • type: string
                        • icon: {
                              type: string;
                          }
                          • type: string
                        • id: {
                              type: string;
                          }
                          • type: string
                        • name: {
                              type: string;
                          }
                          • type: string
                        • shortcut: {
                              properties: {
                                  mac: {
                                      type: string;
                                  };
                                  pc: {
                                      type: string;
                                  };
                              };
                              type: string;
                          }
                          • properties: {
                                mac: {
                                    type: string;
                                };
                                pc: {
                                    type: string;
                                };
                            }
                            • mac: {
                                  type: string;
                              }
                              • type: string
                            • pc: {
                                  type: string;
                              }
                              • type: string
                          • type: string
                        • type: {
                              type: string;
                          }
                          • 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;
                    }
                    • properties: {
                          authors: {
                              type: string;
                          };
                          date: {
                              type: string;
                          };
                          encoding: {
                              type: string;
                          };
                          object_language: {
                              type: string;
                          };
                          project: {
                              type: string;
                          };
                          validation_url: {
                              type: string;
                          };
                          version: {
                              type: string;
                          };
                      }
                      • authors: {
                            type: string;
                        }
                        • type: string
                      • date: {
                            type: string;
                        }
                        • type: string
                      • encoding: {
                            type: string;
                        }
                        • type: string
                      • object_language: {
                            type: string;
                        }
                        • type: string
                      • project: {
                            type: string;
                        }
                        • type: string
                      • validation_url: {
                            type: string;
                        }
                        • type: string
                      • version: {
                            type: string;
                        }
                        • type: string
                    • required: string[]
                    • type: string
                • required: string[]
                • type: string

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +OctraGuidelinesJSONSchema | Octra libraries - v2.0.0

                Variable OctraGuidelinesJSONSchemaConst

                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;
                } = ...

                Type declaration

                • 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;
                      };
                  }
                  • 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;
                    }
                    • 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;
                      }
                      • 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;
                            };
                        }
                        • 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;
                          }
                          • items: {
                                properties: {
                                    code: {
                                        type: string;
                                    };
                                    description: {
                                        type: string;
                                    };
                                    examples: {
                                        items: {
                                            properties: {
                                                annotation: ...;
                                                url: ...;
                                            };
                                            type: string;
                                        };
                                        type: string;
                                    };
                                    priority: {
                                        type: string;
                                    };
                                    title: {
                                        type: string;
                                    };
                                };
                            }
                            • properties: {
                                  code: {
                                      type: string;
                                  };
                                  description: {
                                      type: string;
                                  };
                                  examples: {
                                      items: {
                                          properties: {
                                              annotation: ...;
                                              url: ...;
                                          };
                                          type: string;
                                      };
                                      type: string;
                                  };
                                  priority: {
                                      type: string;
                                  };
                                  title: {
                                      type: string;
                                  };
                              }
                              • code: {
                                    type: string;
                                }
                                • type: string
                              • description: {
                                    type: string;
                                }
                                • type: string
                              • examples: {
                                    items: {
                                        properties: {
                                            annotation: ...;
                                            url: ...;
                                        };
                                        type: string;
                                    };
                                    type: string;
                                }
                                • items: {
                                      properties: {
                                          annotation: ...;
                                          url: ...;
                                      };
                                      type: string;
                                  }
                                  • properties: {
                                        annotation: ...;
                                        url: ...;
                                    }
                                    • annotation: ...
                                    • url: ...
                                  • type: string
                                • type: string
                              • priority: {
                                    type: string;
                                }
                                • type: string
                              • title: {
                                    type: string;
                                }
                                • type: string
                          • type: string
                        • group: {
                              type: string;
                          }
                          • 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;
                    }
                    • 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;
                      }
                      • 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;
                            };
                        }
                        • button_text: {
                              type: string;
                          }
                          • type: string
                        • code: {
                              type: string;
                          }
                          • type: string
                        • description: {
                              type: string;
                          }
                          • type: string
                        • icon: {
                              type: string;
                          }
                          • type: string
                        • id: {
                              type: string;
                          }
                          • type: string
                        • name: {
                              type: string;
                          }
                          • type: string
                        • shortcut: {
                              properties: {
                                  mac: {
                                      type: string;
                                  };
                                  pc: {
                                      type: string;
                                  };
                              };
                              type: string;
                          }
                          • properties: {
                                mac: {
                                    type: string;
                                };
                                pc: {
                                    type: string;
                                };
                            }
                            • mac: {
                                  type: string;
                              }
                              • type: string
                            • pc: {
                                  type: string;
                              }
                              • type: string
                          • type: string
                        • type: {
                              type: string;
                          }
                          • 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;
                    }
                    • properties: {
                          authors: {
                              type: string;
                          };
                          date: {
                              type: string;
                          };
                          encoding: {
                              type: string;
                          };
                          object_language: {
                              type: string;
                          };
                          project: {
                              type: string;
                          };
                          validation_url: {
                              type: string;
                          };
                          version: {
                              type: string;
                          };
                      }
                      • authors: {
                            type: string;
                        }
                        • type: string
                      • date: {
                            type: string;
                        }
                        • type: string
                      • encoding: {
                            type: string;
                        }
                        • type: string
                      • object_language: {
                            type: string;
                        }
                        • type: string
                      • project: {
                            type: string;
                        }
                        • type: string
                      • validation_url: {
                            type: string;
                        }
                        • type: string
                      • version: {
                            type: string;
                        }
                        • type: string
                    • required: string[]
                    • type: string
                • required: string[]
                • type: string

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/variables/_octra_assets.OctraLoggingJSONSchema.html b/variables/_octra_assets.OctraLoggingJSONSchema.html index c9a0c49cb..ea2e54953 100644 --- a/variables/_octra_assets.OctraLoggingJSONSchema.html +++ b/variables/_octra_assets.OctraLoggingJSONSchema.html @@ -1 +1 @@ -OctraLoggingJSONSchema | Octra libraries - v2.0.0

                Variable OctraLoggingJSONSchemaConst

                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;
                        };
                    };
                } = ...

                Type declaration

                • 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;
                      };
                  }
                  • additionalProperties: boolean
                  • encoding: {
                        type: string;
                    }
                    • 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;
                    }
                    • items: {
                          properties: {
                              caretpos: {
                                  type: string;
                              };
                              playpos: {
                                  type: string;
                              };
                              target: {
                                  type: string;
                              };
                              timestamp: {
                                  type: string;
                              };
                              type: {
                                  type: string;
                              };
                              value: {
                                  type: string[];
                              };
                          };
                          type: string;
                      }
                      • properties: {
                            caretpos: {
                                type: string;
                            };
                            playpos: {
                                type: string;
                            };
                            target: {
                                type: string;
                            };
                            timestamp: {
                                type: string;
                            };
                            type: {
                                type: string;
                            };
                            value: {
                                type: string[];
                            };
                        }
                        • caretpos: {
                              type: string;
                          }
                          • type: string
                        • playpos: {
                              type: string;
                          }
                          • type: string
                        • target: {
                              type: string;
                          }
                          • type: string
                        • timestamp: {
                              type: string;
                          }
                          • type: string
                        • type: {
                              type: string;
                          }
                          • type: string
                        • value: {
                              type: string[];
                          }
                          • type: string[]
                      • type: string
                    • type: string
                  • projectname: {
                        type: string;
                    }
                    • type: string
                  • version: {
                        type: string;
                    }
                    • type: string

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +OctraLoggingJSONSchema | Octra libraries - v2.0.0

                Variable OctraLoggingJSONSchemaConst

                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;
                        };
                    };
                } = ...

                Type declaration

                • 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;
                      };
                  }
                  • additionalProperties: boolean
                  • encoding: {
                        type: string;
                    }
                    • 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;
                    }
                    • items: {
                          properties: {
                              caretpos: {
                                  type: string;
                              };
                              playpos: {
                                  type: string;
                              };
                              target: {
                                  type: string;
                              };
                              timestamp: {
                                  type: string;
                              };
                              type: {
                                  type: string;
                              };
                              value: {
                                  type: string[];
                              };
                          };
                          type: string;
                      }
                      • properties: {
                            caretpos: {
                                type: string;
                            };
                            playpos: {
                                type: string;
                            };
                            target: {
                                type: string;
                            };
                            timestamp: {
                                type: string;
                            };
                            type: {
                                type: string;
                            };
                            value: {
                                type: string[];
                            };
                        }
                        • caretpos: {
                              type: string;
                          }
                          • type: string
                        • playpos: {
                              type: string;
                          }
                          • type: string
                        • target: {
                              type: string;
                          }
                          • type: string
                        • timestamp: {
                              type: string;
                          }
                          • type: string
                        • type: {
                              type: string;
                          }
                          • type: string
                        • value: {
                              type: string[];
                          }
                          • type: string[]
                      • type: string
                    • type: string
                  • projectname: {
                        type: string;
                    }
                    • type: string
                  • version: {
                        type: string;
                    }
                    • type: string

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/variables/_octra_assets.OctraProjectConfigJSONSchema.html b/variables/_octra_assets.OctraProjectConfigJSONSchema.html index 8768144af..0bab134f0 100644 --- a/variables/_octra_assets.OctraProjectConfigJSONSchema.html +++ b/variables/_octra_assets.OctraProjectConfigJSONSchema.html @@ -1 +1 @@ -OctraProjectConfigJSONSchema | Octra libraries - v2.0.0

                Variable OctraProjectConfigJSONSchemaConst

                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;
                } = ...

                Type declaration

                • $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;
                      };
                  }
                  • agreement: {
                        properties: {
                            enabled: {
                                type: string;
                            };
                            text: {
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • properties: {
                          enabled: {
                              type: string;
                          };
                          text: {
                              type: string;
                          };
                      }
                      • enabled: {
                            type: string;
                        }
                        • type: string
                      • text: {
                            type: string;
                        }
                        • 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;
                    }
                    • 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;
                      }
                      • 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;
                            };
                        }
                        • 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;
                          }
                          • items: {
                                properties: {
                                    custom: {
                                        type: string;
                                    };
                                    label: {
                                        type: string;
                                    };
                                    name: {
                                        type: string;
                                    };
                                    required: {
                                        type: string;
                                    };
                                    type: {
                                        type: string;
                                    };
                                    value: {
                                        type: string;
                                    };
                                };
                                type: string;
                            }
                            • properties: {
                                  custom: {
                                      type: string;
                                  };
                                  label: {
                                      type: string;
                                  };
                                  name: {
                                      type: string;
                                  };
                                  required: {
                                      type: string;
                                  };
                                  type: {
                                      type: string;
                                  };
                                  value: {
                                      type: string;
                                  };
                              }
                              • custom: {
                                    type: string;
                                }
                                • type: string
                              • label: {
                                    type: string;
                                }
                                • type: string
                              • name: {
                                    type: string;
                                }
                                • type: string
                              • required: {
                                    type: string;
                                }
                                • type: string
                              • type: {
                                    type: string;
                                }
                                • type: string
                              • value: {
                                    type: string;
                                }
                                • type: string
                            • type: string
                          • type: string
                        • title: {
                              type: string;
                          }
                          • type: string
                      • type: string
                    • type: string
                  • interfaces: {
                        items: {
                            type: string;
                        };
                        type: string;
                    }
                    • items: {
                          type: string;
                      }
                      • type: string
                    • type: string
                  • languages: {
                        items: {
                            type: string;
                        };
                        type: string;
                    }
                    • items: {
                          type: string;
                      }
                      • type: string
                    • type: string
                  • navigation: {
                        properties: {
                            export: {
                                type: string;
                            };
                            help_url: {
                                type: string;
                            };
                            interfaces: {
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • properties: {
                          export: {
                              type: string;
                          };
                          help_url: {
                              type: string;
                          };
                          interfaces: {
                              type: string;
                          };
                      }
                      • export: {
                            type: string;
                        }
                        • type: string
                      • help_url: {
                            type: string;
                        }
                        • type: string
                      • interfaces: {
                            type: string;
                        }
                        • 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;
                    }
                    • 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;
                          };
                      }
                      • allowed_browsers: {
                            items: {
                                properties: {
                                    name: {
                                        type: string;
                                    };
                                    version: {
                                        type: string;
                                    };
                                };
                                type: string;
                            };
                            type: string;
                        }
                        • items: {
                              properties: {
                                  name: {
                                      type: string;
                                  };
                                  version: {
                                      type: string;
                                  };
                              };
                              type: string;
                          }
                          • properties: {
                                name: {
                                    type: string;
                                };
                                version: {
                                    type: string;
                                };
                            }
                            • name: {
                                  type: string;
                              }
                              • type: string
                            • version: {
                                  type: string;
                              }
                              • type: string
                          • type: string
                        • type: string
                      • bugreport: {
                            properties: {
                                auth_token: {
                                    type: string;
                                };
                                enabled: {
                                    type: string;
                                };
                                name: {
                                    type: string;
                                };
                                url: {
                                    type: string;
                                };
                            };
                            type: string;
                        }
                        • properties: {
                              auth_token: {
                                  type: string;
                              };
                              enabled: {
                                  type: string;
                              };
                              name: {
                                  type: string;
                              };
                              url: {
                                  type: string;
                              };
                          }
                          • auth_token: {
                                type: string;
                            }
                            • type: string
                          • enabled: {
                                type: string;
                            }
                            • type: string
                          • name: {
                                type: string;
                            }
                            • type: string
                          • url: {
                                type: string;
                            }
                            • type: string
                        • type: string
                      • languages: {
                            items: {
                                type: string;
                            };
                            type: string;
                        }
                        • items: {
                              type: string;
                          }
                          • type: string
                        • type: string
                      • login: {
                            properties: {
                                enabled: {
                                    type: string;
                                };
                            };
                            type: string;
                        }
                        • properties: {
                              enabled: {
                                  type: string;
                              };
                          }
                          • enabled: {
                                type: string;
                            }
                            • type: string
                        • type: string
                      • responsive: {
                            $id: string;
                            properties: {
                                enabled: {
                                    type: string;
                                };
                                fixedwidth: {
                                    type: string;
                                };
                            };
                            type: string;
                        }
                        • $id: string
                        • properties: {
                              enabled: {
                                  type: string;
                              };
                              fixedwidth: {
                                  type: string;
                              };
                          }
                          • enabled: {
                                type: string;
                            }
                            • type: string
                          • fixedwidth: {
                                type: string;
                            }
                            • type: string
                        • type: string
                      • showdetails: {
                            type: string;
                        }
                        • type: string
                      • tools: {
                            items: {
                                enum: string[];
                                type: string;
                            };
                            type: string;
                        }
                        • items: {
                              enum: string[];
                              type: string;
                          }
                          • enum: string[]
                          • type: string
                        • type: string
                    • type: string
                  • plugins: {
                        type: string;
                    }
                    • type: string
                  • responsive: {
                        properties: {
                            enabled: {
                                type: string;
                            };
                            fixedwidth: {
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • properties: {
                          enabled: {
                              type: string;
                          };
                          fixedwidth: {
                              type: string;
                          };
                      }
                      • enabled: {
                            type: string;
                        }
                        • type: string
                      • fixedwidth: {
                            type: string;
                        }
                        • type: string
                    • type: string
                  • version: {
                        readOnly: boolean;
                        type: string;
                    }
                    • readOnly: boolean
                    • type: string
                • required: string[]
                • type: string

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +OctraProjectConfigJSONSchema | Octra libraries - v2.0.0

                Variable OctraProjectConfigJSONSchemaConst

                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;
                } = ...

                Type declaration

                • $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;
                      };
                  }
                  • agreement: {
                        properties: {
                            enabled: {
                                type: string;
                            };
                            text: {
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • properties: {
                          enabled: {
                              type: string;
                          };
                          text: {
                              type: string;
                          };
                      }
                      • enabled: {
                            type: string;
                        }
                        • type: string
                      • text: {
                            type: string;
                        }
                        • 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;
                    }
                    • 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;
                      }
                      • 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;
                            };
                        }
                        • 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;
                          }
                          • items: {
                                properties: {
                                    custom: {
                                        type: string;
                                    };
                                    label: {
                                        type: string;
                                    };
                                    name: {
                                        type: string;
                                    };
                                    required: {
                                        type: string;
                                    };
                                    type: {
                                        type: string;
                                    };
                                    value: {
                                        type: string;
                                    };
                                };
                                type: string;
                            }
                            • properties: {
                                  custom: {
                                      type: string;
                                  };
                                  label: {
                                      type: string;
                                  };
                                  name: {
                                      type: string;
                                  };
                                  required: {
                                      type: string;
                                  };
                                  type: {
                                      type: string;
                                  };
                                  value: {
                                      type: string;
                                  };
                              }
                              • custom: {
                                    type: string;
                                }
                                • type: string
                              • label: {
                                    type: string;
                                }
                                • type: string
                              • name: {
                                    type: string;
                                }
                                • type: string
                              • required: {
                                    type: string;
                                }
                                • type: string
                              • type: {
                                    type: string;
                                }
                                • type: string
                              • value: {
                                    type: string;
                                }
                                • type: string
                            • type: string
                          • type: string
                        • title: {
                              type: string;
                          }
                          • type: string
                      • type: string
                    • type: string
                  • interfaces: {
                        items: {
                            type: string;
                        };
                        type: string;
                    }
                    • items: {
                          type: string;
                      }
                      • type: string
                    • type: string
                  • languages: {
                        items: {
                            type: string;
                        };
                        type: string;
                    }
                    • items: {
                          type: string;
                      }
                      • type: string
                    • type: string
                  • navigation: {
                        properties: {
                            export: {
                                type: string;
                            };
                            help_url: {
                                type: string;
                            };
                            interfaces: {
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • properties: {
                          export: {
                              type: string;
                          };
                          help_url: {
                              type: string;
                          };
                          interfaces: {
                              type: string;
                          };
                      }
                      • export: {
                            type: string;
                        }
                        • type: string
                      • help_url: {
                            type: string;
                        }
                        • type: string
                      • interfaces: {
                            type: string;
                        }
                        • 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;
                    }
                    • 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;
                          };
                      }
                      • allowed_browsers: {
                            items: {
                                properties: {
                                    name: {
                                        type: string;
                                    };
                                    version: {
                                        type: string;
                                    };
                                };
                                type: string;
                            };
                            type: string;
                        }
                        • items: {
                              properties: {
                                  name: {
                                      type: string;
                                  };
                                  version: {
                                      type: string;
                                  };
                              };
                              type: string;
                          }
                          • properties: {
                                name: {
                                    type: string;
                                };
                                version: {
                                    type: string;
                                };
                            }
                            • name: {
                                  type: string;
                              }
                              • type: string
                            • version: {
                                  type: string;
                              }
                              • type: string
                          • type: string
                        • type: string
                      • bugreport: {
                            properties: {
                                auth_token: {
                                    type: string;
                                };
                                enabled: {
                                    type: string;
                                };
                                name: {
                                    type: string;
                                };
                                url: {
                                    type: string;
                                };
                            };
                            type: string;
                        }
                        • properties: {
                              auth_token: {
                                  type: string;
                              };
                              enabled: {
                                  type: string;
                              };
                              name: {
                                  type: string;
                              };
                              url: {
                                  type: string;
                              };
                          }
                          • auth_token: {
                                type: string;
                            }
                            • type: string
                          • enabled: {
                                type: string;
                            }
                            • type: string
                          • name: {
                                type: string;
                            }
                            • type: string
                          • url: {
                                type: string;
                            }
                            • type: string
                        • type: string
                      • languages: {
                            items: {
                                type: string;
                            };
                            type: string;
                        }
                        • items: {
                              type: string;
                          }
                          • type: string
                        • type: string
                      • login: {
                            properties: {
                                enabled: {
                                    type: string;
                                };
                            };
                            type: string;
                        }
                        • properties: {
                              enabled: {
                                  type: string;
                              };
                          }
                          • enabled: {
                                type: string;
                            }
                            • type: string
                        • type: string
                      • responsive: {
                            $id: string;
                            properties: {
                                enabled: {
                                    type: string;
                                };
                                fixedwidth: {
                                    type: string;
                                };
                            };
                            type: string;
                        }
                        • $id: string
                        • properties: {
                              enabled: {
                                  type: string;
                              };
                              fixedwidth: {
                                  type: string;
                              };
                          }
                          • enabled: {
                                type: string;
                            }
                            • type: string
                          • fixedwidth: {
                                type: string;
                            }
                            • type: string
                        • type: string
                      • showdetails: {
                            type: string;
                        }
                        • type: string
                      • tools: {
                            items: {
                                enum: string[];
                                type: string;
                            };
                            type: string;
                        }
                        • items: {
                              enum: string[];
                              type: string;
                          }
                          • enum: string[]
                          • type: string
                        • type: string
                    • type: string
                  • plugins: {
                        type: string;
                    }
                    • type: string
                  • responsive: {
                        properties: {
                            enabled: {
                                type: string;
                            };
                            fixedwidth: {
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • properties: {
                          enabled: {
                              type: string;
                          };
                          fixedwidth: {
                              type: string;
                          };
                      }
                      • enabled: {
                            type: string;
                        }
                        • type: string
                      • fixedwidth: {
                            type: string;
                        }
                        • type: string
                    • type: string
                  • version: {
                        readOnly: boolean;
                        type: string;
                    }
                    • readOnly: boolean
                    • type: string
                • required: string[]
                • type: string

                Settings

                Member Visibility

                Theme

                \ No newline at end of file