Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Cordova

Scandit.ScanSession Class Reference

Public Member Functions

void pauseScanning ()
void stopScanning ()
void rejectCode (Barcode code)

Public Attributes

Barcode[] newlyRecognizedCodes
Barcode[] newlyLocalizedCodes
Barcode[] allRecognizedCodes

Detailed Description

The scan session holds all barcodes that were decoded in the current session.

These codes are available as getAllRecognizedCodes().

Configuring Session Behaviour

The scan session is responsible for determining the list of "relevant" barcodes by filtering out duplicates. Depending on your app, different duplicate removal is required. For some applications, only one barcode is required. The scanning process is stopped as soon as one code is decoded. For other applications, multiple codes are scanned after another. For example, a scanner at the cash desk may need to scan multiple products. To avoid duplicates, the same barcode should not be scanned in short succession. The same barcode (data, symbology) should not count as a duplicate if encountered again after a few seconds.

By default, if a barcode has the same symbology and data as code that was decoded less than 500ms ago, it is filtered out as a duplicate. The exact filtering behaviour can be changed by setting the "code duplicate filter", see ScanSettings.setCodeDuplicateFilter for details.

Session Lifetime

The session is cleared when either BarcodePicker.startScanning or , BarcodePicker.stopScanning is called, or when the user manually clears the session using clear.

See also

Member Function Documentation

void pauseScanning ( )

Immediately Pauses barcode recognition, but keeps camera preview open.

This is useful for briefly pausing the barcode recognition to show the recognized code in an overlay and then resume the scan process to scan more codes.

When only scanning one code and then returning to another part of the application, it is recommended to call stopScanning() instead.

Pausing will not clear the scan session. To remove all codes from the scan session call clear().

See also
void stopScanning ( )

Immediately stops the scanning and clears the scan session.

Calling stop will release the camera, so that other applications can use it.

See also
BarcodePicker.stopScanning(), pauseScanning()
void rejectCode ( Barcode  code)

Prevent beeping/vibrate and highlighting for a particular code.

Use this method to reject a certain code if you have additional methods for verifying the integrity of the code, e.g. with a custom checksum. Rejected codes won't be highlighted in the scan UI. Additionally beep and vibration will be surpressed.

For code rejection to work, you must enabled it by setting code rejection to true.

Rejected codes will be added to allRecognizedCodes like all other codes.

Note that you should only pass codes returned by newlyRecognizedCodes as passing any other code will have no effect. Additionally, you should only calls this method from the scan callback.

codeThe code to reject

Member Data Documentation

Barcode [] newlyRecognizedCodes

List of barcodes that have been successfully recognized in the last frame.

Barcode [] newlyLocalizedCodes

List of barcodes that have been localized in the last frame.

This list does not include barcodes that have been successfully recognized.

Barcode [] allRecognizedCodes

Returns the list of barcodes (data, symbology) that have been recognized in this session.

Depending on the code caching and duplicate filtering behaviour, different sets of codes are returned by this method.

See also
a new copy of the list of barcodes that have been successfully decoded in this session