Interface EngineConfiguration

Engine configuration

interface EngineConfiguration {
    duplicateInterval?: number;
    hysteresisInterval?: number;
    hysteresisMinCount?: number;
    invertedCodes?: boolean;
    minScanlinesNeeded?: number;
    numScanlines?: number;
    symbologies?: (SymbologyName | SymbologySpec)[];
}

Properties

duplicateInterval? hysteresisInterval? hysteresisMinCount? invertedCodes? minScanlinesNeeded? numScanlines? symbologies?

Properties

Optional duplicateInterval

duplicateInterval?: number

Time interval in milliseconds during which multiple detections of the same code are not repeated.

Remarks

It is recommended to set a duplicateInterval as scans are metered except in Enterprise subscriptions.

Default Value

750

Optional hysteresisInterval

hysteresisInterval?: number

Set the duration of the hysteresis window in milliseconds.

Default Value

350

Optional hysteresisMinCount

hysteresisMinCount?: number

Set the minimum occurrence count for 1D barcodes with weak checksums in a given time window for it be accepted.

Remarks

Setting this parameter to 0 disables hysteresis (default behavior for versions up to 1.1.0)

Default Value

2

Optional invertedCodes

invertedCodes?: boolean

Toggle recognition of inverted barcodes (light print on dark background).

Remarks

This should only be enabled if you need to detect these barcodes, as additional processing will take place.

Default Value

false

Optional minScanlinesNeeded

minScanlinesNeeded?: number

The number of scanlines that need to decoded successfully for a valid decode.

Remarks

Increasing this parameter reduces the possibility of a misread, but makes it more likely for degraded codes to not be read at all.

The default value is two scanlines and usually should not be changed.

Default Value

2

Optional numScanlines

numScanlines?: number

The number of scanlines to run over a located barcode candidate.

Default Value

10

Optional symbologies

symbologies?: (SymbologyName | SymbologySpec)[]

The enabled symbologies.

Remarks

It is highly recommended to configure only the symbologies required by your application. An empty array or undefined is interpreted as 'all symbologies enabled'.

Example

['qr', 'code128']

Default Value

undefined (all symbologies enabled - NOT RECOMMENDED)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc