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

Inherits Object, IProcessFrameListener, IJavaObject, and IDisposable.

Public Member Functions

 MatrixScan (BarcodePicker picker, IMatrixScanListener listener)
 
 MatrixScan (BarcodePicker picker, IMatrixScanListener listener, ICollection< MatrixScanOverlay > overlays)
 
void Beep ()
 
void AddOverlay (MatrixScanOverlay overlay)
 
void RemoveOverlay (MatrixScanOverlay overlay)
 
void RemoveAllAugmentations ()
 
void DidProcess (byte[] imageBuffer, int width, int height, IScanSession session)
 

Public Attributes

bool Enabled
 
bool RecognizedOnly
 
bool BeepOnNewCode
 

Detailed Description

An high-level abstraction of the Scandit Matrix Scan.

This class can be used to track multiple barcodes simultaneously and to draw multiple overlays on top of the detected barcodes.

Since
5.9.0

Constructor & Destructor Documentation

MatrixScan ( BarcodePicker  picker,
IMatrixScanListener  listener 
)

MatrixScan constructor without any overlays.

Parameters
pickerUnderlying BarcodePicker to be used by the MatrixScan.
listenerIMatrixScanListener instance.
Since
5.9.0
MatrixScan ( BarcodePicker  picker,
IMatrixScanListener  listener,
ICollection< MatrixScanOverlay overlays 
)

MatrixScan constructor.

Parameters
pickerUnderlying BarcodePicker to be used by the MatrixScan.
listenerIMatrixScanListener instance.
overlaysA set of MatrixScanOverlay objects.
Since
5.9.0

Member Function Documentation

void Beep ( )

Programmatically trigger a beep sound.

Since
5.9.0
void AddOverlay ( MatrixScanOverlay  overlay)

Add a MatrixScanOverlay to be drawn by the MatrixScan.

Parameters
overlayInstance of MatrixScanOverlay class to be added to the MatrixScan.
Since
5.9.0
void RemoveOverlay ( MatrixScanOverlay  overlay)

Remove the given MatrixScanOverlay.

Parameters
overlayInstance of MatrixScanOverlay class to be removed from the MatrixScan.
Since
5.9.0
void RemoveAllAugmentations ( )

Remove all augmentations of every overlay belonging to the MatrixScan object.

This method will call the MatrixScanOverlay.RemoveAllAugmentations() method on every overlay belonging to the MatrixScan object.

Since
5.9.0
void DidProcess ( byte[]  imageBuffer,
int  width,
int  height,
IScanSession  session 
)
inherited

Invoked every time a frame has been processed by the barcode recognition engine.

In contrast to IOnScanListener.DidScan, the didProcess callback is invoked after every frame, regardless whether a code could be successfully decoded or not. If your are only interested in fully decoded codes, use the IOnScanListener instead.

The didProcess callback is invoked in the thread that runs the recognition engine and blocks further processing. In case codes have been recognized in the same frame, the DidProcess callback is invoked after IOnScanListener.DidScan.

Parameters
imageBufferthe raw image data that was processed in NV21 format
widthwidth of the image buffer in pixels
heightheight of the image buffer in pixels
sessioncontains information on the current recognition process. It is only valid to access the scan session from within the callback. If part of the information is required outside the callback it must be copied first.
Since
4.9.0

Member Data Documentation

bool Enabled

Enable/disable the matrix scan.

Default is true.

Since
5.9.0
bool RecognizedOnly

Select whether all or only recognized barcodes will be tracked by the matrix scan.

Default is true.

Since
5.9.0
bool BeepOnNewCode

Set to true to beep whenever a new code is recognized.

Default is false.

Since
5.9.0