public class BarCodeReader
extends java.lang.Object
BarCodeReader encapsulates an image which may contain one or several barcodes, it then can perform Read operation to detect barcodes
Detect an code39 barcode with supplement.BarCodeReader reader; reader = new BarCodeReader("/storage/emulated/0/Pictures/test.jpg",DecodeType.CODE_93_STANDARD); while(reader.read()) { System.out.println("BarCode Type: "+reader.getReadType()); System.out.println("BarCode CodeText: " + reader.getCodeText()); } reader.close();
Constructor and Description |
---|
BarCodeReader()
Initializes a new instance of the
BarCodeReader class with default values. |
BarCodeReader(Bitmap image)
Initializes a new instance of the
BarCodeReader class from an image. |
BarCodeReader(Bitmap image,
BaseDecodeType... decodeTypes)
Initializes a new instance of the
BarCodeReader class from an image. |
BarCodeReader(Bitmap image,
BaseDecodeType type)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(Bitmap image,
Rect[] areas,
BaseDecodeType type)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(Bitmap image,
Rect area,
BaseDecodeType... decodeTypes)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(Bitmap image,
Rect area,
BaseDecodeType type) |
Modifier and Type | Method and Description |
---|---|
void |
abort()
Function requests termination of current recognition session from other thread.
|
void |
close()
Closes barcode reader.
|
void |
dispose() |
float |
getAngle()
Gets the angle of the barcode (0-360).
|
BaseDecodeType |
getBarCodeDecodeType() |
java.lang.String |
getCheckSum()
Gets the checksum for 1D barcodes.
|
ChecksumValidation |
getChecksumValidation() |
Code128DataPortion[] |
getCode128DataPortions()
Gets Code128DataPortion instance for recognized Code128 barcode
|
byte[] |
getCodeBytes()
Gets the encoded code bytes.
|
java.lang.String |
getCodeText()
Gets the code text.
|
java.lang.String |
getCodeText(boolean includeCheckSum)
Gets the code text.
|
java.lang.String |
getCodeText(java.nio.charset.Charset encoding)
Gets the code text with encoding.
|
SingleDecodeType |
getCodeType()
Gets the barcode type.
|
java.lang.String |
getCodeTypeName()
Gets the name of the barcode type.
|
CustomerInformationInterpretingType |
getCustomerInformationInterpretingType()
Gets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
|
boolean |
getDetectEncoding()
Gets flag to detect codetext encoding for unicode codesets.
|
java.lang.String |
getFileName()
Gets file name which was assigned by user
|
boolean |
getIsDeniable()
Checks the deniable recognition.
|
java.lang.String |
getMacroPdf417FileID()
Gets the file ID of the barcode, only available with MacroPdf417.
|
int |
getMacroPdf417SegmentID()
Gets the segment ID of the barcode,only available with MacroPdf417.
|
int |
getMacroPdf417SegmentsCount()
Gets macro pdf417 barcode segments count.
|
static ProcessorSettings |
getProcessorSettings()
Gets a settings of using processor cores.
|
int |
getQRStructuredAppendModeBarCodeIndex()
Gets the index of the QR structured append mode barcode.
|
int |
getQRStructuredAppendModeBarCodesQuantity()
Gets the QR structured append mode barcodes quantity.
|
int |
getQRStructuredAppendModeParityData()
Gets the QR structured append mode parity data.
|
QualitySettings |
getQualitySettings()
QualitySettings allows to configure recognition quality and speed manually.
|
float |
getRecognitionQuality()
Gets the recognition quality.
|
BarCodeRegion |
getRegion()
Gets the barcode region.
|
boolean |
getStripFNC()
Strip FNC1, FNC2, FNC3 characters from codetext.
|
int |
getTimeout()
Gets the timeout of recognition process.
|
boolean |
read()
Reads barcode from the image.
|
void |
setBarCodeImage(Bitmap value)
Sets bitmap image for recognition.
|
void |
setBarCodeImage(Bitmap value,
Rect area)
Sets bitmap image and area for recognition.
|
void |
setBarCodeImage(Bitmap value,
Rect[] areas)
Sets bitmap image and areas for recognition.
|
void |
setBarCodeImage(java.io.InputStream stream)
Sets image stream for recognition.
|
void |
setBarCodeReadType(BaseDecodeType type)
Sets BarCodeReadType for recognition.
|
void |
setChecksumValidation(ChecksumValidation value)
Enable checksum validation during recognition for 1D barcodes.
|
void |
setChecksumValidation(int value)
Deprecated.
|
void |
setCustomerInformationInterpretingType(CustomerInformationInterpretingType value)
Sets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
|
void |
setCustomerInformationInterpretingType(int value)
Sets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
|
void |
setDetectEncoding(boolean value)
Sets flag to detect codetext encoding for unicode codesets.
|
void |
setQualitySettings(QualitySettings value)
QualitySettings allows to configure recognition quality and speed manually.
|
void |
setStripFNC(boolean value)
Strip FNC1, FNC2, FNC3 characters from codetext.
|
void |
setTimeout(int value)
Sets the timeout of recognition process.
|
public BarCodeReader()
Initializes a new instance of the BarCodeReader
class with default values.
Requires to set image setBitmapImage() before to call read() method.
public BarCodeReader(Bitmap image)
Initializes a new instance of the BarCodeReader
class from an image.
image
- A Bitmap instance containing the imagepublic BarCodeReader(Bitmap image, BaseDecodeType... decodeTypes)
Initializes a new instance of the BarCodeReader
class from an image.
image
- A Bitmap instance containing the imagepublic BarCodeReader(Bitmap image, BaseDecodeType type)
Initializes a new instance of the BarCodeReader
class.
image
- The image.type
- Decode types.public BarCodeReader(Bitmap image, Rect area, BaseDecodeType... decodeTypes)
Initializes a new instance of the BarCodeReader
class.
image
- The image.area
- The area for recognition.decodeTypes
- Decode types.public BarCodeReader(Bitmap image, Rect[] areas, BaseDecodeType type)
BarCodeReader
class.image
- The image to read.areas
- The array of recognition areas.type
- The decode type applicable for all the areas specified.public BarCodeReader(Bitmap image, Rect area, BaseDecodeType type)
public static ProcessorSettings getProcessorSettings()
public java.lang.String getFileName()
public int getTimeout()
Gets the timeout of recognition process.
public void setTimeout(int value)
Sets the timeout of recognition process.
value
- The timeout.public ChecksumValidation getChecksumValidation()
Enable checksum validation during recognition for 1D barcodes.
Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible.
Checksum never used: Codabar
Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN
Checksum always used: Rest symbologies
public void setChecksumValidation(ChecksumValidation value)
value
- The checksum validation flag.@Deprecated public void setChecksumValidation(int value)
value
- The checksum validation flag.public boolean getStripFNC()
Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.
public void setStripFNC(boolean value)
Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.
public CustomerInformationInterpretingType getCustomerInformationInterpretingType()
Gets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
public void setCustomerInformationInterpretingType(CustomerInformationInterpretingType value)
Sets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
public void setCustomerInformationInterpretingType(int value)
Sets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
public void close()
Closes barcode reader.
public void abort()
Function requests termination of current recognition session from other thread. Abort is unblockable method and returns control just after calling. The method should be used when recognition process is too long.
public boolean read()
Reads barcode from the image.
Detect AllSupportedTypesBarCodeReader reader; reader = new BarCodeReader("/storage/emulated/0/Pictures/test.jpg"); while(reader.read()) { System.out.println("BarCode Type: "+reader.getReadType()); System.out.println("BarCode CodeText: " + reader.getCodeText()); } reader.close();
public final QualitySettings getQualitySettings()
QualitySettings allows to configure recognition quality and speed manually. You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of QualitySettings is NormalQuality.
Value: QualitySettings to configure recognition quality and speed.This sample shows how to use QualitySettings with BarCodeReaderBarCodeReader reader = new BarCodeReader(imagePath); //set high performance mode reader.setQualitySettings(QualitySettings.getHighPerformance()); while (reader.read()) { System.out.println("BarCode CodeText: " + reader.getCodeText()); } BarCodeReader reader = new BarCodeReader(imagePath); //set high performance mode reader.setQualitySettings(QualitySettings.getHighPerformance()); //set separate options reader.getQualitySettings().setAllowMedianSmoothing(true); reader.getQualitySettings().setMedianSmoothingWindowSize(5); while (reader.read()) { System.out.println("BarCode CodeText: " + reader.getCodeText()); } BarCodeReader reader = new BarCodeReader(imagePath); //default mode is NormalQuality //set separate options reader.getQualitySettings().setAllowMedianSmoothing(true); reader.getQualitySettings().setMedianSmoothingWindowSize(5); while (reader.read()) { System.out.println("BarCode CodeText: " + reader.getCodeText()); }
public final void setQualitySettings(QualitySettings value)
QualitySettings allows to configure recognition quality and speed manually. You can quickly set up QualitySettings by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of QualitySettings is NormalQuality.
Value: QualitySettings to configure recognition quality and speed.This sample shows how to use QualitySettings with BarCodeReaderBarCodeReader reader = new BarCodeReader(imagePath); //set high performance mode reader.setQualitySettings(QualitySettings.getHighPerformance()); while (reader.read()) { System.out.println("BarCode CodeText: " + reader.getCodeText()); } BarCodeReader reader = new BarCodeReader(imagePath); //set high performance mode reader.setQualitySettings(QualitySettings.getHighPerformance()); //set separate options reader.getQualitySettings().setAllowMedianSmoothing(true); reader.getQualitySettings().setMedianSmoothingWindowSize(5); while (reader.read()) { System.out.println("BarCode CodeText: " + reader.getCodeText()); } BarCodeReader reader = new BarCodeReader(imagePath); //default mode is NormalQuality //set separate options reader.getQualitySettings().setAllowMedianSmoothing(true); reader.getQualitySettings().setMedianSmoothingWindowSize(5); while (reader.read()) { System.out.println("BarCode CodeText: " + reader.getCodeText()); }
public java.lang.String getCodeText()
Gets the code text. Text will not contain the checksum for 1D barcode types, which support the checksum. Please use GetCodeText(true) method to get result with checksum.
public java.lang.String getCodeText(java.nio.charset.Charset encoding)
Gets the code text with encoding.
encoding
- The encoding for codetext.public java.lang.String getCodeText(boolean includeCheckSum)
includeCheckSum
- true to include CheckSum into result; false to return only CodeText.public java.lang.String getCheckSum()
Gets the checksum for 1D barcodes.
public float getAngle()
Gets the angle of the barcode (0-360). Orientation enum does not included into the calculation.
public byte[] getCodeBytes()
Gets the encoded code bytes.
public java.lang.String getMacroPdf417FileID()
Gets the file ID of the barcode, only available with MacroPdf417.
public int getMacroPdf417SegmentID()
Gets the segment ID of the barcode,only available with MacroPdf417.
public int getMacroPdf417SegmentsCount()
Gets macro pdf417 barcode segments count. Default value is -1.
public Code128DataPortion[] getCode128DataPortions()
Code128DataPortion
objects.public int getQRStructuredAppendModeBarCodesQuantity()
Gets the QR structured append mode barcodes quantity. Default value is -1.
public int getQRStructuredAppendModeBarCodeIndex()
Gets the index of the QR structured append mode barcode. Index starts from 0. Default value is -1.
public int getQRStructuredAppendModeParityData()
Gets the QR structured append mode parity data. Default value is -1.
public boolean getIsDeniable()
Checks the deniable recognition. Such recognition might occur in QualitySettings.MAX_BARCODES mode decoding or use QualitySettings.ALLOW_INCORRECT_BARCODES
public BarCodeRegion getRegion()
Gets the barcode region.
public SingleDecodeType getCodeType()
Gets the barcode type.
public java.lang.String getCodeTypeName()
Gets the name of the barcode type.
public float getRecognitionQuality()
Gets the recognition quality. Works for 1D and postal barcodes.
public boolean getDetectEncoding()
Gets flag to detect codetext encoding for unicode codesets.
public void setDetectEncoding(boolean value)
Sets flag to detect codetext encoding for unicode codesets.
Detection text encoding on the fly if DetectEncoding is enabledInputStream is = new ByteArrayInputStream(new byte[...]); BarCodeBuilder bb = new BarCodeBuilder(); bb.setCodeText(""); bb.setEncodeType(EncdeTypes.QR); bb.setCodeTextEncoding(Encoding.UTF8); bb.save(is, BarCodeImageFormat.Png); BarCodeReader reader = new BarCodeReader(is, BarCodeReadType.QR); reader.setDetectEncoding(true); while(reader.read()) System.out.println("BarCode CodeText: " + reader.GetCodeText()); is.setPosition(0); BarCodeReader reader1 = new BarCodeReader(is, BarCodeReadType.QR); reader1.setDetectEncoding(false); while(reader1.read()) System.out.println("BarCode CodeText: " + reader1.GetCodeText(Encoding.UTF8));
value
- The flag to detect codetext encoding.public final void setBarCodeImage(Bitmap value, Rect[] areas)
Sets bitmap image and areas for recognition. Must be called before Read() method.
value
- The bitmap image for recognition.areas
- areas list for recognitionpublic final void setBarCodeImage(Bitmap value, Rect area)
Sets bitmap image and area for recognition. Must be called before Read() method.
value
- The bitmap image for recognition.area
- area for recognitionpublic final void setBarCodeImage(java.io.InputStream stream)
Sets image stream for recognition. Must be called before Read() method.
stream
- The image stream for recogniton.public void setBarCodeImage(Bitmap value)
Sets bitmap image for recognition. Must be called before Read() method.
value
- The bitmap image for recognition.public void setBarCodeReadType(BaseDecodeType type)
Sets BarCodeReadType for recognition. Must be called before Read() method.
type
- The type of barcode to read.public void dispose()
public BaseDecodeType getBarCodeDecodeType()