Barcode Sequence Settings

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

BarcodeSequenceSettings

class BarcodeSequenceSettings

Added in version 8.0.0

BarcodeSequenceSettings()

BarcodeSequenceSettings()

Added in version 8.0.0

Creates a new barcode sequence settings instance. All symbologies are disabled. Make sure to enable the symbologies required by your app before applying the settings to BarcodeSequence with BarcodeSequence.applySettings().

getSymbologySettings(symbology)

fun getSymbologySettings(symbology: Symbology): SymbologySettings

Added in version 8.0.0

Gets SymbologySettings specific for the given Symbology.

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

enabledSymbologies

val enabledSymbologies: Set<Symbology>

Added in version 8.0.0

Returns the set of enabled symbologies.

enableSymbologies(symbologies)

fun enableSymbologies(symbologies: Set<Symbology>)

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

fun enableSymbology(symbology: Symbology,
        enabled: Boolean)

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

fun setProperty(name: String,
        value: Any)

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

fun getProperty(name: String): Any?

Added in version 8.0.0

Retrieves the value of a previously set property.

filterSettings

var filterSettings: BarcodeFilterSettings

Added in version 8.0.0

Sets and access the barcode filter settings.

shelfSequencingOrientation

var shelfSequencingOrientation: ShelfSequencingOrientation

Added in version 8.5.0

Restricts the device orientations in which Barcode Sequence will sequence shelves. Defaults to ShelfSequencingOrientation.LANDSCAPE_ONLY.

idleTimeout

var idleTimeout: TimeInterval

Added in version 8.1.0

The idle timeout, in seconds: the period without any tracked items after which sequencing is automatically paused due to inactivity, turning off the camera.

A value of 0 or less disables the automatic pause, so sequencing keeps running regardless of inactivity.

Defaults to 10 seconds.

initialOrderOnShelf

var initialOrderOnShelf: Int

Added in version 8.5.1

Order on the shelf assigned to the first tracked tray in the next Barcode Sequence session, using the same 0-based numbering as the orderOnShelf reported for tracked trays. Subsequent trays keep incrementing from this value.

Use together with initialOrderOnTray to resume numbering from where a previous session left off, so on-screen row indicators and session data stay aligned with the physical shelf across multiple sessions. See Resuming a Sequence Session.

Values below 0 are clamped to 0. Read when a session starts; a value applied to an already-running session takes effect only on the next session.

Defaults to 0.

initialOrderOnTray

var initialOrderOnTray: Int

Added in version 8.5.1

Order on the tray assigned to the first barcode inside the first tray of the next Barcode Sequence session, using the same 0-based numbering as the orderOnTray reported for tracked barcodes. Later barcodes in that tray increment from this value; new trays in the same session reset their order on the tray to 0, matching the current behavior.

Values below 0 are clamped to 0. Read at session start; changes mid-session do not affect the running session.

Defaults to 0.

fromJson(jsonData)

fun BarcodeSequenceSettings.fromJson(jsonData: String): BarcodeSequenceSettings

Added in version 8.0.0

Creates a new Barcode Sequence settings instance with the provided JSON serialization.

Resuming a Sequence Session

MatrixScan Sequence numbers orderOnShelf and orderOnTray from 0 at the start of every session (the on-screen indicators render these as 1-based labels). Applications that scan large surfaces in multiple sessions — for example one shelf row per session — can persist the resume point client-side and pass it to the SDK before the next session begins, so that on-screen indicators and session data continue matching the physical layout.

Set BarcodeSequenceSettings.initialOrderOnShelf and BarcodeSequenceSettings.initialOrderOnTray before applying settings, then start or reset the mode. The seeded order on the shelf applies to every tray in that session (the first tray reports the seeded value as its orderOnShelf, subsequent trays continue counting up); the seeded order on the tray applies only to the first barcode of the first tray (later barcodes in that tray increment from it; new trays in the same session reset to 0).