Spark Capture Settings#

Defined under the namespace Scandit.Datacapture.Barcode.Spark

Note

The Spark Capture API is still in beta and may change in future versions of the Scandit Data Capture SDK.

SparkCaptureSettings#
class SparkCaptureSettings

Added in version 6.9.0

Holds all the spark capture settings, such as enabled symbologies and location selection.

For the settings to take effect, they must be applied to a spark capture instance using SparkCapture.applySettings().

By default, all types of barcodes (symbologies) are disabled. To scan barcodes, you need to manually enable all the symbologies you want to scan in your application.

The following lines of code show how to enable Symbology.Code128 and apply the settings to spark capture.

const settings = new Scandit.SparkCaptureSettings();
settings.enableSymbology(Scandit.Symbology.Code128, true);
sparkCapture.applySettings(settings);
constructor()#
constructor()

Added in version 6.9.0

Creates new default settings instance. Symbologies are all disabled. Before passing the settings to the SparkCapture instance, make sure to enable the symbologies required by your application.

settingsForSymbology(symbology)#
settingsForSymbology(symbology: Symbology): SymbologySettings

Added in version 6.9.0

Get SymbologySettings specific for the given Symbology.

Note that modifying the returned object doesn’t automatically apply the changes to SparkCapture. After you made changes to the symbology settings, call SparkCapture.applySettings() with these SparkCaptureSettings to apply them.

setProperty(name, value)#
setProperty(name: string,
        value: any): void

Added in version 6.9.0

Sets a 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): any

Added in version 6.9.0

Retrieves the value of a previously set property. In case the property does not exist, null is returned.

codeDuplicateFilter#
codeDuplicateFilter: number

Added in version 6.9.0

Determines the time interval in which codes with the same symbology/data are filtered out as duplicates. By default, when the same code (data, symbology) is scanned in consecutive frames, it is reported again as a new scan. Use this property to change the interval or completely turn off duplicate filtering:

  • Setting this property to value smaller than zero, means that the same code will not be reported again until the scanning has been stopped.

  • Setting this property to a value of zero means that the same code will be reported every time it is found.

  • Setting this property to a value larger than zero indicates the time that must pass between the same code to be reported again.

The filtering is reset any time the capture mode is disabled (DataCaptureMode.isEnabled is set to false) as this is when the session is cleaned and restarts from zero.

enabledSymbologies#
get enabledSymbologies(): Symbology[]

Added in version 6.9.0

Returns the set of enabled symbologies.

enableSymbology(symbology, enabled)#
enableSymbology(symbology: Symbology,
        enabled: boolean): void

Added in version 6.9.0

Provides a convenient shortcut to enable/disable decoding of a particular symbology without having to go through SymbologySettings.

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.

enableSymbologies(symbologies)#
enableSymbologies(symbologies: Symbology[]): void

Added in version 6.9.0

Provides a convenient shortcut to enable decoding of particular symbologies without having to go through SymbologySettings. By default, all symbologies are turned off and symbologies need to be explicitly enabled.

locationSelection#
locationSelection: LocationSelection | null

Added in version 6.9.0

Defines the strategy with which to select one out of many visible barcodes. See Location Selection Guide. By default, this property is set to centered, 40% of the height and full width.