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 Xamarin.Android and Data Capture SDK Documentation for Xamarin.iOS

ScanSession Class Reference

Public Member Functions

void PauseScanning ()
void StopScanning ()
void Clear ()
void RejectCode (Barcode code)


IEnumerable< BarcodeNewlyRecognizedCodes [get]
IEnumerable< BarcodeNewlyLocalizedCodes [get]
IEnumerable< BarcodeAllRecognizedCodes [get]

Detailed Description

Holds recognized and localized codes and allows to control the scanning process.

Member Function Documentation

void PauseScanning ( )

Immediately pause the scanning process.

void StopScanning ( )

Immediately stop the scanning process.

void Clear ( )

Remove all codes from the scan session.

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.

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

For this feature to work, you need to enable code rejection by setting ScanSettings.CodeRejectionEnabled to true.

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 an invoked BarcodePicker.DidScan delegate.

codeThe code to reject

Property Documentation

IEnumerable<Barcode> NewlyRecognizedCodes

Get codes that were recognized in the last processed frame.

The list of codes recognized in the last processed frame.
IEnumerable<Barcode> NewlyLocalizedCodes

Get codes localized but not recognized in the last processed frame.

The list of codes localized but not recognized in the last processed frame. Use NewlyRecognizedCodes for a list of recognized codes in the last frame.
IEnumerable<Barcode> AllRecognizedCodes

Get all recognized codes

This method returns all codes that have been recognized. The exact set of codes returned by this method depends on the

Enumeration of all recognized codes