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 Android

ViewBasedMatrixScanOverlay Class Reference

Inherits MatrixScanOverlay, and OnClickListener.

Classes

interface  ViewBasedMatrixScanOverlayListener
 

Public Member Functions

 ViewBasedMatrixScanOverlay (Context context, MatrixScan matrixScan, ViewBasedMatrixScanOverlayListener listener)
 
 ViewBasedMatrixScanOverlay (Context context, MatrixScan matrixScan, ViewBasedMatrixScanOverlayListener listener, int viewCenterPoint)
 
void setViewForCode (View view, long barcodeId)
 
void setOffsetForCode (Point offset, long barcodeId)
 

Static Public Attributes

Possible anchor points of the augmentations, relative to the actual tracked

barcode location within the frame.

static final int TOP_EDGE_CENTER
 
static final 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,
ViewBasedMatrixScanOverlayListener  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 ViewBasedMatrixScanOverlayListener class.
Since
5.9.0
ViewBasedMatrixScanOverlay ( Context  context,
MatrixScan  matrixScan,
ViewBasedMatrixScanOverlayListener  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 ViewBasedMatrixScanOverlayListener class.
viewCenterPointAn int representing an anchor point for all augmentations (views). The value has to be one of ViewBasedMatrixScanOverlay.TOP_EDGE_CENTER 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

Member Data Documentation

final int TOP_EDGE_CENTER
static

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

final int CENTER
static

Anchor in the center of the tracked barcode.


The documentation for this class was generated from the following file:
  • ViewBasedMatrixScanOverlay.java