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 React Native

Scandit.MatrixScanSession Class Reference

Public Member Functions

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

Public Attributes

Barcode[] newlyTrackedCodes
Barcode[] allTrackedCodes

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.

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 [] newlyTrackedCodes

List of barcodes that are newly tracked in the last frame.

Barcode [] allTrackedCodes

Returns the list of barcodes (data, symbology) that are currently tracked.

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