Create a ScanSettings instance.
Disable recognition of a symbology or list/set of symbologies.
By default no symbologies are enabled.
The single symbology or list/set of symbologies to disable.
The updated ScanSettings object.
Enable recognition of a symbology or list/set of symbologies.
By default no symbologies are enabled.
The single symbology or list/set of symbologies to enable.
The updated ScanSettings object.
Get the code direction hint telling in what direction 1D codes are most likely orientated.
By default left-to-right
is used.
The code direction hint.
Get the code duplicate filter value.
By default duplicate filtering is disabled.
The code duplicate filter value.
Get the descriptive device name to identify the current device when looking at analytics tools.
By default no name is used (the device is identified by its unique ID only).
The device name.
Get the maximum number of barcodes to be recognized every frame.
By default the maximum number of barcodes per frame is 1.
The maximum number of barcodes per frame.
Get a Scandit Data Capture library scanning property.
This function is for internal use only and any functionality that can be accessed through it can and will vanish without public notice from one version to the next. Do not call this function unless you specifically have to.
The property name.
The property value. For properties not previously set, -1 is returned.
Get the recognition mode deciding whether codes and/or text are recognized.
The recognition mode.
Get the area of the image in which barcodes/texts are searched.
By default the whole area is searched.
The search area.
Get the configuration object for a symbology (which can then be modified).
The symbology for which to retrieve the configuration.
The symbology configuration object for the specified symbology.
Get the current text recognition settings.
The text recognition settings.
Get the barcode blurry recognition enabled status.
By default barcode blurry recognition is enabled.
Whether barcode blurry recognition is configured to be enabled ot not.
Get the GPU acceleration enabled status.
By default GPU acceleration is enabled.
Whether GPU acceleration is configured to be enabled ot not.
Get the recognition enabled status for a symbology.
By default no symbologies are enabled.
The symbology for which to retrieve the recognition enabled status.
Whether the symbology enabled for recognition.
Enable or disable barcode blurry recognition.
Allow accurate scanning capabilities for out-of-focus (1D) codes. If enabled, more advanced algorithms are executed (and more resources/time is spent) every frame in order to successfully locate/scan difficult codes.
By default barcode blurry recognition is enabled.
Whether to enable or disable barcode blurry recognition.
The updated ScanSettings object.
Set the code direction hint telling in what direction 1D codes are most likely orientated.
More advanced algorithms are executed (and more resources/time is spent) every frame in order to successfully
locate/scan difficult codes for each of the possible directions resulting by the direction hint. Note that this
results in slow performance for none
hints, average performance for horizontal
and vertical
hints and fast
performance for the remaining hints.
By default left-to-right
is used.
The new code direction hint.
The updated ScanSettings object.
Set the code duplicate filter value.
When the filter is set to -1, each unique code is only scanned once. When set to 0, duplicate filtering is disabled. Otherwise the duplicate filter specifies an interval in milliseconds.
By default duplicate filtering is disabled.
The new value (-1, 0, or positive integer).
The updated ScanSettings object.
Set the descriptive device name to identify the current device when looking at analytics tools.
By default no name is used (the device is identified by its unique ID only).
The new device name.
The updated ScanSettings object.
Enable or disable GPU acceleration.
By default GPU acceleration is enabled.
Provide faster and more accurate barcode localization. The GPU will in any case be used only if the browser also supports the needed technologies (WebGL and OffscreenCanvas).
Whether to enable or disable GPU acceleration.
The updated ScanSettings object.
Set the maximum number of barcodes to be recognized every frame.
By default the maximum number of barcodes per frame is 1.
The new maximum number of barcodes per frame alue (non-zero positive integer).
The updated ScanSettings object.
Set a Scandit Data Capture library scanning property.
This function is for internal use only and any functionality that can be accessed through it can and will vanish without public notice from one version to the next. Do not call this function unless you specifically have to.
The property name.
The property value.
The updated ScanSettings object.
Set the recognition mode deciding whether codes and/or text are recognized.
The new recognition mode.
The updated ScanSettings object.
Set the area of the image in which barcodes/texts are searched.
By default the whole area is searched.
The new search area.
The updated ScanSettings object.
Set the text recognition settings.
Note that modified ScanSettings (due to TextRecognitionSettings changes) need to be applied to a scanner via BarcodePicker.applyScanSettings or Scanner.applyScanSettings to take effect.
The new text recognition settings.
The updated ScanSettings object.
The configuration object as a JSON string.
Generated using TypeDoc
A configuration object for scanning options.
Modified ScanSettings need to be applied to a scanner via BarcodePicker.applyScanSettings or Scanner.applyScanSettings to take effect.