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

ViewBasedMatrixScanOverlay Class Referenceabstract

Inherits MatrixScanOverlay.

Classes

interface  IViewBasedMatrixScanOverlayListener
 

Public Member Functions

 ViewBasedMatrixScanOverlay (Context context, MatrixScan matrixScan, IViewBasedMatrixScanOverlayListener listener)
 
 ViewBasedMatrixScanOverlay (Context context, MatrixScan matrixScan, IViewBasedMatrixScanOverlayListener listener, int viewCenterPoint)
 
void SetViewForCode (View view, long barcodeId)
 
void SetOffsetForCode (Point offset, long barcodeId)
 
abstract void RemoveAllAugmentations ()
 
abstract void Add (TrackedBarcode code, long id)
 
abstract void Update (TrackedBarcode code, long id)
 
abstract void Remove (long id)
 

Public Attributes

Possible anchor points of the augmentations, relative to the actual tracked barcode location within the frame.
const int TopEdgeCenter
 
const int Center
 

Detailed Description

An implementation of the abstract MatrixScanOverlay class, that uses View class instances as augmentations for all of the tracked barcodes.

Since
5.9.0

Constructor & Destructor Documentation

ViewBasedMatrixScanOverlay ( Context  context,
MatrixScan  matrixScan,
IViewBasedMatrixScanOverlayListener  listener 
)

A ViewBasedMatrixScanOverlay constructor.

All augmentations drawn by this overlay will be attached to the center of the top edge of the detected barcode.

Parameters
contextContext.
matrixScanA reference to a MatrixScan instance that the overlay will be added to.
listenerInstance of the IViewBasedMatrixScanOverlayListener class.
Since
5.9.0
ViewBasedMatrixScanOverlay ( Context  context,
MatrixScan  matrixScan,
IViewBasedMatrixScanOverlayListener  listener,
int  viewCenterPoint 
)

A ViewBasedMatrixScanOverlay constructor.

The last argument of the constructor defines whether the augmentations drawn by this overlay should be attached either to the center of the top edge of the detected barcode or to the actual center of the barcode.

Parameters
contextContext.
matrixScanA reference to a MatrixScan instance that the overlay will be added to.
listenerInstance of the IViewBasedMatrixScanOverlayListener class.
viewCenterPointAn int representing an anchor point for all augmentations (views). The value has to be one of ViewBasedMatrixScanOverlay.TopEdgeCenter or ViewBasedMatrixScanOverlay.Center
Since
5.9.0

Member Function Documentation

void SetViewForCode ( View  view,
long  barcodeId 
)

Set a View augmentation for the barcode with the given id.

Parameters
viewView instance, to be used as an augmentation.
barcodeIdBarcode identifier.
Since
5.9.0
void SetOffsetForCode ( Point  offset,
long  barcodeId 
)

Set an offset (from the anchor point) of the augmentation drawn for the barcode with the given id.

Parameters
offsetPoint instance, representing an offset.
barcodeIdBarcode identifier.
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

Member Data Documentation

const int TopEdgeCenter

Anchor in the middle of the top edge of the tracked barcode.

const int Center

Anchor in the center of the tracked barcode.