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

MatrixScanOverlay Class Referenceabstract

Inherits FrameLayout.

Inherited by SimpleMatrixScanOverlay, and ViewBasedMatrixScanOverlay.

Public Member Functions

 MatrixScanOverlay (Context context)
 
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 FrameLayout extension that overlays need to further extend so that they could be added to the MatrixScan instance.

MatrixScan's overlays should inherit from this abstract class in order to be added to the MatrixScan object with the MatrixScan.AddOverlay() method. SimpleMatrixScanOverlay and ViewBasedMatrixScanOverlay both inherit from MatrixScanOverlay and in general it should not be necessary to create a custom overlay.

Since
5.9.0

Constructor & Destructor Documentation

◆ MatrixScanOverlay()

MatrixScanOverlay ( Context  context)

MatrixScanOverlay constructor.

Parameters
contextContext.
Since
5.9.0

Member Function Documentation

◆ RemoveAllAugmentations()

abstract void RemoveAllAugmentations ( )
pure virtual

Remove augmentations that are part of the MatrixScanOverlay.

Since
5.9.0

◆ Add()

abstract void Add ( TrackedBarcode  code,
long  id 
)
pure virtual

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

◆ Update()

abstract void Update ( TrackedBarcode  code,
long  id 
)
pure virtual

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

◆ Remove()

abstract void Remove ( long  id)
pure virtual

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

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