SparkScan Settings

Defined in namespace Scandit.DataCapture.Barcode.Spark.Capture

SparkScanSettings
class SparkScanSettings

Added in version 6.16.0

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

For the settings to take effect, they must be applied to a SparkScan instance using SparkScan.ApplySettingsAsync().

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 SparkScan.

var settings = new SparkScanSettings();
settings.EnableSymbology(Symbology.Code128, enabled: true);
sparkScan.ApplySettingsAsync(settings);
SparkScanSettings()
SparkScanSettings()

Added in version 6.16.0

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

SparkScanSettings()
SparkScanSettings(CapturePreset capturePresets)

Added in version 6.19.0

Constructs new Spark Scan settings based on the provided presets, enabling relevant symbologies and optimizations. See CapturePreset for more information on how to use capture presets.

GetSymbologySettings()
SymbologySettings GetSymbologySettings(Symbology symbology)

Added in version 6.16.0

Get SymbologySettings specific for the given Symbology.

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

SetProperty()
void SetProperty(string name, object value)

Added in version 6.16.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()
object GetProperty(string name)

Added in version 6.16.0

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

GetProperty()
T GetProperty<T>(string name)

Added in version 6.16.0

Retrieves the value of a previously set property. In case the property does not exist, an ArgumentException is thrown.

TryGetProperty()
bool TryGetProperty<T>(string name, out T result)

Added in version 6.16.0

The non-throwing version of the method GetProperty(). It retrieves the value of a previously set property as the second passed argument and returns true. In case the property does not exist, false will be returned.

CodeDuplicateFilter
TimeSpan CodeDuplicateFilter { get;set; }

Added in version 6.16.0

Determines the time interval in which codes with the same symbology/data are filtered out as duplicates. By default set to 700ms. 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.

EnabledSymbologies
ICollection<Symbology> EnabledSymbologies { get; }

Added in version 6.16.0

Returns the set of enabled symbologies.

EnableSymbology()
void EnableSymbology(Symbology symbology, bool enabled)

Added in version 6.16.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()
void EnableSymbologies(ICollection<Symbology> symbologies)

Added in version 6.16.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.

SingleBarcodeAutoDetection
bool SingleBarcodeAutoDetection { get;set; }

Added in version 6.17.0

If true, when a single barcode is tracked, it will be automatically selected. Defaults to true.

Note

This property works only when SparkScan is in target mode.

Deprecated since version 6.18: With the recent improvements introduced in the target mode, selection of barcodes is easier and more reliable. Given that, this method is outdated and not needed anymore.

LocationSelection
ILocationSelection LocationSelection { get;set; }

Added in version 6.17.0

Defines the strategy with which to select one out of many visible barcodes. See Location Selection Guide. By default, this property is null and code selection is disabled.

Deprecated since version 6.19: With the introduction of smart configurations based on the scanning mode enabled by the users, the locationSelection property is not needed anymore and has been deprecated.

BatterySaving
BatterySavingMode BatterySaving { get;set; }

Added in version 6.21.0

The battery saving mode to use with SparkScan. Default to Off, optimized for the fastest scanning experience.