Barcode Tracking Settings

Defined in package com.scandit.datacapture.barcode.tracking.capture

BarcodeTrackingSettings

class BarcodeTrackingSettings

Added in version 6.0.0

forScenario(scenario)

static @NonNull BarcodeTrackingSettings forScenario(
        BarcodeTrackingScenario scenario)

Added in version 6.5.0

Creates a new barcode tracking settings instance with the provided scenario.

Check Barcode Tracking Scenarios to know which scenario is best for a given use case.

BarcodeTrackingSettings()

BarcodeTrackingSettings()

Added in version 6.0.0

Creates a new barcode tracking settings instance. All symbologies are disabled. Make sure to enable the symbologies required by your app before applying the settings to BarcodeTracking with

BarcodeTracking.applySettings().

fromJson(jsonData)

static @NonNull BarcodeTrackingSettings fromJson(@NonNull String jsonData)

Added in version 6.0.0

Creates a new barcode tracking settings instance with the provided JSON serialization. See Serialization for details.

updateFromJson(jsonData)

void updateFromJson(@NonNull String jsonData)

Added in version 6.0.0

Updates the settings according to a JSON serialization. See Serialization for details.

getSymbologySettings(symbology)

@NonNull SymbologySettings getSymbologySettings(Symbology symbology)

Added in version 6.0.0

Get SymbologySettings specific for the given Symbology.

Note that modifying the returned object doesn’t automatically apply the changes to BarcodeTracking. After you made changes to the symbology settings,

call BarcodeTracking.applySettings()

with these BarcodeTrackingSettings to apply them.

enabledSymbologies

@NonNull Set<Symbology> getEnabledSymbologies()

Added in version 6.0.0

Returns the set of enabled symbologies.

enableSymbologies(symbologies)

void enableSymbologies(@NonNull Set<Symbology> symbologies)

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

void enableSymbology(Symbology symbology,
        boolean enabled)

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

setProperty(name, value)

void setProperty(@NonNull String name,
        @NonNull Object value)

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

@NonNull Object getProperty(@NonNull String name)

Added in version 6.0.0

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

setArucoDictionary(dictionary)

void setArucoDictionary(@NonNull ArucoDictionary dictionary)

Added in version 6.19.0

Sets the ArucoDictionary to be used while scanning ArUco codes. When the symbology is enabled the dictionary ArucoDictionaryPreset.ARUCO_DICTIONARY_PRESET_5X5_1000 is loaded as default.