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

Public Member Functions

byte[] GetImageBytes ()

Public Attributes

ICollection< Long > AddedIdentifiers
ICollection< Long > RemovedIdentifiers
ICollection< Long > UpdatedIdentifiers
IDictionary< Long, TrackedBarcode > TrackedCodes
IScanSession ScanSession
int Width
int Height

Detailed Description

An extended abstraction of a frame that is being processed by the MatrixScan.

The Frame holds basic information like raw GetImageBytes(), as well as more advanced data prepared by the MatrixScan, e.g. AddedIdentifiers, ScanSession, etc.

All the class members are public to allow easy access to the data carried by the Frame.


Member Function Documentation

byte [] GetImageBytes ( )

Raw frame data.

A byte array.

Member Data Documentation

ICollection<Long> AddedIdentifiers

A set of tracked barcodes' identifiers that have been added while processing this Frame.

ICollection<Long> RemovedIdentifiers

A set of tracked barcodes' identifiers have been removed while processing this Frame.

ICollection<Long> UpdatedIdentifiers

A set of tracked barcodes' identifiers have been updated while processing this Frame.

IDictionary<Long, TrackedBarcode> TrackedCodes

All tracked barcodes as a dictionary.

The entries in the dictionary map barcode's identifier to the tracked barcode itself.

IScanSession ScanSession

Current Scan Session.

This object can be accessed only from the session thread. Accessing it from a different thread may result in a deadlock.

int Width

Frame's width.

int Height

Frame's height.