Interface EngineConfiguration

Engine configuration

Hierarchy

  • EngineConfiguration

Properties

duplicateInterval?: number

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

The default behavior is to pass through detections as they are detected and not perform any filtering.

It is recommended to set a low duplicateInterval as scans are metered in non-Enterprise subscriptions.

hysteresisInterval?: number

Hysteresis parameterization for 1D barcodes with weak checksums.

This parameter sets the size of the hysteresis window in milliseconds.

Default

250

hysteresisMinCount?: number

Hysteresis parameterization for 1D barcodes with weak checksums.

This parameter sets the minimum threshold for the number of detections of a barcode in the hysteresis window for it to be accepted.

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

Default

3

invertedCodes?: boolean

Toggle recognition of inverted 2D codes (light on dark background). Currently, this is only supported for 2D codes.

Default

false

minScanlinesNeeded?: number

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

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

2

numScanlines?: number

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

Default

10

symbologies?: SymbologyName[]

The enabled symbologies.

It is highly recommended to configure only the symbologies required by your application.

An empty array or undefined is interpreted as 'all symbologies enabled'.

Default

undefined (all symbologies enabled - NOT RECOMMENDED)

Generated using TypeDoc