Barcode Batch Session

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

BarcodeBatchSession

class BarcodeBatchSession

Added in version 7.0.0

The batch session contains all the currently tracked barcodes and changes that were made specifically in the last processed frame.

Important

The batch session should only be accessed from within onSessionUpdated() to which it is provided as an argument. It is not safe to be accessed from anywhere else since it may be concurrently modified.

Specifically no reference to trackedBarcodes, addedTrackedBarcodes, removedTrackedBarcodes or updatedTrackedBarcodes should be kept and traversed outside of onSessionUpdated(). Instead a copy of the lists should be made to avoid concurrent modification. The individual tracked barcodes can be referenced without copying as they are not further modified.

addedTrackedBarcodes

val addedTrackedBarcodes: List<TrackedBarcode>

Added in version 7.0.0

Newly tracked barcodes.

unscannedTrackedBarcodes

val unscannedTrackedBarcodes: List<TrackedBarcode>

Added in version 7.0.0

Barcodes that could not be scanned.

removedTrackedBarcodes

val removedTrackedBarcodes: List<Int>

Added in version 7.0.0

The identifiers of lost tracked barcodes that were removed.

updatedTrackedBarcodes

val updatedTrackedBarcodes: List<TrackedBarcode>

Added in version 7.0.0

Updated tracked barcodes (new location).

trackedBarcodes

val trackedBarcodes: Map<Int, TrackedBarcode>

Added in version 7.0.0

A map from identifiers to tracked barcodes. It contains all currently tracked barcodes.

frameSequenceId

val frameSequenceId: Long

Added in version 7.0.0

The identifier of the current frame sequence.

Important

As long as there is no interruptions of frames coming from the camera, the frameSequenceId will stay the same.

toJson()

fun toJson(): String

Added in version 7.0.0

Returns the JSON representation of the Barcode Batch session.

reset()

fun reset()

Added in version 7.0.0

Resets the Barcode Batch session, effectively clearing the history of tracked barcodes. This function should only be called inside the listeners’ callback.