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
Inherits NativeHandle.
Inherited by TrackedBarcode.
Public Member Functions | |
int | getSymbology () |
String | getSymbologyName () |
boolean | isGs1DataCarrier () |
int | getCompositeFlag () |
boolean | isRecognized () |
byte[] | getRawData () |
String | getData () |
Quadrilateral | getLocation () |
boolean | isColorInverted () |
Static Public Attributes | |
static final int[] | ALL_SYMBOLOGIES |
Symbologies | |
static final int | SYMBOLOGY_UNKNOWN |
static final int | SYMBOLOGY_EAN13 |
static final int | SYMBOLOGY_EAN8 |
static final int | SYMBOLOGY_UPCA |
static final int | SYMBOLOGY_UPCE |
static final int | SYMBOLOGY_CODE128 |
static final int | SYMBOLOGY_CODE11 |
static final int | SYMBOLOGY_CODE25 |
static final int | SYMBOLOGY_CODE39 |
static final int | SYMBOLOGY_CODE93 |
static final int | SYMBOLOGY_INTERLEAVED_2_OF_5 |
static final int | SYMBOLOGY_QR |
static final int | SYMBOLOGY_DATA_MATRIX |
static final int | SYMBOLOGY_PDF417 |
static final int | SYMBOLOGY_MICRO_PDF417 |
static final int | SYMBOLOGY_MSI_PLESSEY |
static final int | SYMBOLOGY_GS1_DATABAR |
static final int | SYMBOLOGY_GS1_DATABAR_EXPANDED |
static final int | SYMBOLOGY_GS1_DATABAR_LIMITED |
static final int | SYMBOLOGY_CODABAR |
static final int | SYMBOLOGY_AZTEC |
static final int | SYMBOLOGY_MAXICODE |
static final int | SYMBOLOGY_TWO_DIGIT_ADD_ON |
static final int | SYMBOLOGY_FIVE_DIGIT_ADD_ON |
static final int | SYMBOLOGY_KIX |
static final int | SYMBOLOGY_RM4SCC |
static final int | SYMBOLOGY_DOTCODE |
CompositeFlags | |
static final int | SC_COMPOSITE_FLAG_NONE |
static final int | SC_COMPOSITE_FLAG_UNKNOWN |
static final int | SC_COMPOSITE_FLAG_LINKED |
static final int | SC_COMPOSITE_FLAG_GS1_A |
static final int | SC_COMPOSITE_FLAG_GS1_B |
static final int | SC_COMPOSITE_FLAG_GS1_C |
Detailed Description
Represents a recognized/localized barcode/2D code.
The Barcode class represents a barcode, or 2D code that has been localized or recognized by the barcode recognition engine.
Member Function Documentation
int getSymbology | ( | ) |
Returns the symbology of a recognized barcode.
- Returns
- Codes for which isRecognized() returns false, SYMBOLOGY_UNKNOWN is returned. For all other codes, the symbology of the recognized code is returned.
String getSymbologyName | ( | ) |
Convenience method to directly get the name of the symbology as a string.
- Returns
- The symbology name as a lower-case string, e.g. ean13, or codabar.
boolean isGs1DataCarrier | ( | ) |
Whether the code is a GS1 data carrier.
- Returns
- True if the code is a GS1 data carrier, false if not. False is returned for codes that have only been localized but not recognized.
int getCompositeFlag | ( | ) |
Whether the code is part of a composite code.
- Returns
- The composite flag of the code. SC_COMPOSITE_FLAG_UNKNOWN is returned for codes that have only been localized but not recognized.
boolean isRecognized | ( | ) |
Whether the code was completely recognized.
This property is true for barcodes that were completely recognized and false for codes that were localized but not recognized. For codes returned by BarcodeScannerSession.getNewlyRecognizedCodes() and BarcodeScannerSession.getAllRecognizedCodes() this method always returns true, for codes returned by BarcodeScannerSession.getNewlyLocalizedCodes() isRecognized() always returns false.
- Returns
- True if the code has been recognized.
byte [] getRawData | ( | ) |
The raw byte data contained in the barcode.
Use this method in case you are encoding binary data in barcodes\2D codes that can not be represented as UTF-8 strings.
- Returns
- The raw byte data.
String getData | ( | ) |
The data contained in the barcode/2D code, e.g.
the 13 digit number of a EAN13 code.
For some types of barcodes/2D codes (for example DATAMATRIX, AZTEC, PDF417), the data string may contain non-printable characters and nul-bytes in the middle of the string. Use getRawData() if your application scans these types of codes and you are expecting binary/non-printable data.
- Returns
- the data contained in the code.
Quadrilateral getLocation | ( | ) |
The location of the code in the image.
The location is returned as a a polygon with 4 corners. The corners are in the coordinate system of the raw preview image. In order to be displayed they must be transformed to the coordinate system of the view. The meaning of the values of topLeft, topRight etc is such that the topLeft point corresponds to the top-left corner of the barcode regardless of how it is oriented in the image.
- Returns
- The location of the code as a quadrilateral.
- See also
- com.scandit.barcodepicker.BarcodePicker::convertPointToPickerCoordinates(Point)
boolean isColorInverted | ( | ) |
Whether the recognized code is color inverted.
- Returns
- True if the code has been recognized and is color-inverted (printed bright on dark). For codes that have been localized but not recognized, this method returns false.
- Since
- 5.5
Member Data Documentation
|
static |
Sentinel value to represent an unknown symbology.
|
static |
EAN-13 1D barcode symbology.
|
static |
EAN-8 1D barcode symbology.
|
static |
UPC-12/UPC-A 1D barcode symbology.
|
static |
UPC-E 1D barcode symbology.
|
static |
Code 128 1D barcode symbology, including GS1-Code128.
Only available in the Professional and Enterprise Packages.
|
static |
Code 11 barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
Code 25 barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
Code 39 barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
Code 93 barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
Interleaved-Two-of-Five (ITF) 1D barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
QR Code 2D barcode symbology.
|
static |
Data Matrix 2D barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
PDF417 barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
MicroPDF417 barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
MSI Plessey 1D barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
GS1 DataBar 14 1D barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
GS1 DataBar Expanded 1D barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
GS1 DataBar Limited 1D barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
Codabar 1D barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
Aztec Code 2D barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
MaxiCode 2D barcode symbology.
Only available in the Professional and Enterprise Packages.
|
static |
Two-digit add-on for UPC and EAN codes.
In order to scan two-digit add-on codes, at least one of these symbologies must be activated as well: SYMBOLOGY_EAN13, SYMBOLOGY_UPCA, SYMBOLOGY_UPCE, or SYMBOLOGY_EAN8 and the maximum number of codes per frame has to be set to at least 2.
Only available in the Professional and Enterprise Packages.
|
static |
Five-digit add-on for UPC and EAN codes.
In order to scan five-digit add-on codes, at least one of these symbologies must be activated as well: SYMBOLOGY_EAN13, SYMBOLOGY_UPCA, SYMBOLOGY_UPCE, or SYMBOLOGY_EAN8 and the maximum number of codes per frame has to be set to at least 2.
Only available in the Professional and Enterprise Packages.
|
static |
Royal Dutch TPG Post KIX.
Only available in Professional and Enterprise Packages
|
static |
Royal Mail 4 State Customer Code (RM4SCC)
Only available in Professional and Enterprise Packages
|
static |
Dot Code.
Only available in Professional and Enterprise Packages
|
static |
Enumerates all symbologies.
|
static |
Code is not part of a composite code.
|
static |
Code could be part of a composite code.
This flag is set by linear (1d) symbologies that have no composite flag support but can be part of a composite code like the EAN/UPC symbology family.
|
static |
Code is the linear component of a composite code.
This flag can be set by GS1 DataBar or GS1-128 (Code 128).
|
static |
Code is a GS1 Composite Code Type A (CC-A).
This flag can be set by MicroPDF417 codes.
|
static |
Code is a GS1 Composite Code Type B (CC-B).
This flag can be set by MicroPDF417 codes.
|
static |
Code is a GS1 Composite Code Type C (CC-C).
This flag can be set by PDF417 codes.
The documentation for this class was generated from the following file:
- Barcode.java