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

SimpleMatrixScanOverlay Class Referenceabstract

Inherits MatrixScanOverlay.

Classes

interface  ISimpleMatrixScanOverlayListener
 

Public Member Functions

 SimpleMatrixScanOverlay (Context context, MatrixScan matrixScan, ISimpleMatrixScanOverlayListener listener)
 
void SetColor (int color, long barcodeId)
 
void SetAllAugmentationColors (int color)
 
abstract void RemoveAllAugmentations ()
 
abstract void Add (TrackedBarcode code, long id)
 
abstract void Update (TrackedBarcode code, long id)
 
abstract void Remove (long id)
 

Detailed Description

A simple implementation of the abstract MatrixScanOverlay class, that draws colorful, rectangle overlays on top of tracked barcodes.

Since
5.9.0

Constructor & Destructor Documentation

SimpleMatrixScanOverlay ( Context  context,
MatrixScan  matrixScan,
ISimpleMatrixScanOverlayListener  listener 
)

A SimpleMatrixScanOverlay constructor.

Parameters
contextContext.
matrixScanA reference to a MatrixScan instance that the overlay will be added to.
listenerInstance of the ISimpleMatrixScanOverlayListener class.
Since
5.9.0

Member Function Documentation

void SetColor ( int  color,
long  barcodeId 
)

Change the color of the augmentation corresponding to the given identifier.

Parameters
colorColor for the augmentation.
barcodeIdBarcode identifier.
Since
5.9.0
void SetAllAugmentationColors ( int  color)

Change the color of all augmentations.

Parameters
colorColor for the augmentations.
Since
5.9.0
abstract void RemoveAllAugmentations ( )
pure virtualinherited

Remove augmentations that are part of the MatrixScanOverlay.

Since
5.9.0
abstract void Add ( TrackedBarcode  code,
long  id 
)
pure virtualinherited

Add a new augmentation to the MatrixScanOverlay for the given code.

The new augmentation should have an identifier equal to the given id.

Parameters
codeTrackedBarcode to be used to generate the new augmentation.
idIdentifier for the new augmentation.
Since
5.9.0
abstract void Update ( TrackedBarcode  code,
long  id 
)
pure virtualinherited

Update (recreate) an existing augmentation with given id for the given code.

Parameters
codeTrackedBarcode to be used to recreate the augmentation.
idIdentifier of an augmentation that should be updated.
Since
5.9.0
abstract void Remove ( long  id)
pure virtualinherited

Remove an existing augmentation with the given id from the MatrixScanOverlay.

Parameters
idIdentifier of an augmentation that should be removed.
Since
5.9.0