Barcode Count Settings
Defined under the namespace Scandit.Datacapture.Barcode.Count
- BarcodeCountSettings
class BarcodeCountSettingsAdded in version 6.24.0
- constructor(scanPreviewEnabled)
constructor(scanPreviewEnabled?: boolean)
Added in version 6.24.0
Creates a new barcode count settings instance. This initializer allows enabling or disabling the scan preview at construction. When using the default initializer, scan preview is disabled by default.
Scan preview allows you to see the barcodes that are being detected before pressing the shutter button, but these won’t be added to the scanning result yet. Pressing the shutter button will scan the barcodes that are visible in the preview.
When scan preview is enabled, only basic scanning and scanning against a list are supported.
Note
The Barcode Count scan preview API is still in beta and may change in future versions of Scandit Data Capture SDK.
- settingsForSymbology(symbology)
settingsForSymbology(symbology: Symbology): SymbologySettings
Added in version 6.24.0
Get SymbologySettings specific for the given Symbology.
Note that modifying the returned object doesn’t automatically apply the changes to BarcodeCount. After you made changes to the symbology settings, call BarcodeCount.applySettings() with these BarcodeCountSettings to apply them.
- enabledSymbologies
get enabledSymbologies(): Symbology[]
Added in version 6.24.0
Returns the set of enabled symbologies.
- filterSettings
get filterSettings(): BarcodeFilterSettings
Added in version 6.24.0
Returns the current settings for barcode filtering.
- enableSymbologies(symbologies)
enableSymbologies(symbologies: Symbology[]):
voidAdded in version 6.24.0
This function provides a convenient shortcut to enabling decoding of particular symbologies without having to go through SymbologySettings. By default, all symbologies are turned off and symbologies need to be explicitly enabled.
- enableSymbology(symbology, enabled)
enableSymbology(symbology: Symbology, enabled: boolean):
voidAdded in version 6.24.0
This function provides a convenient shortcut to enabling/disabling decoding of a particular symbology without having to go through SymbologySettings.
Note
Some 1d barcode symbologies allow you to encode variable-length data. By default, the Scandit Data Capture SDK only scans barcodes in a certain length range.
If your application requires scanning of one of these symbologies, and the length is falling outside the default range, you may need to adjust the active symbol counts for the symbology in addition to enabling it.
- expectsOnlyUniqueBarcodes
expectsOnlyUniqueBarcodes: boolean
Added in version 6.24.0
Declares whether or not the barcodes to be tracked are expected to be unique. If enabled optimizations can be used to improve Barcode Count.
Note
Do not enable this if you are expecting to scan multiple barcodes with the same content within one batch.
- disableModeWhenCaptureListCompleted
disableModeWhenCaptureListCompleted: boolean
Added in version 8.3.0
Declares whether or not the mode will be disabled automatically when the provided capture list has been completed. If no list has been provided, this has no effect.
Default value is false.
- setProperty(name, value)
setProperty(name: string, value:
any):voidAdded in version 6.24.0
Sets property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may or may not be used or change in a future release.
- getProperty(name)
getProperty(name: string):
anyAdded in version 6.24.0
Retrieves the value of a previously set property. In case the property does not exist, -1 is returned.
- mappingEnabled
mappingEnabled: boolean
Added in version 6.24.0
Use this property to enable barcode mapping.
Default value is false.
Note
The Barcode Count mapping API is still in beta and may change in future versions of Scandit Data Capture SDK.
- clusteringMode
clusteringMode: ClusteringMode
Added in version 8.3.0
Clustering mode allows smart grouping of neighbouring barcodes. Default to ClusteringMode.Disabled.