public class BarCodeReader
extends java.lang.Object
BarCodeReader encapsulates an image which may contain one or several barcodes, it then can perform ReadBarCodes operation to detect barcodes
Detect an code39 barcode with supplement.BarCodeReader reader = new BarCodeReader("test.jpg"); for(BarCodeResult result : reader.readBarCodes(), DecodeType.CODE_39_STANDARD) { System.out.println("BarCode Type: " + result.getCodeTypeName()); System.out.println("BarCode CodeText: " + result.getCodeText()); }
Constructor and Description |
---|
BarCodeReader()
Initializes a new instance of the
BarCodeReader class with default values. |
BarCodeReader(android.graphics.Bitmap image)
Initializes a new instance of the
BarCodeReader class from an image. |
BarCodeReader(android.graphics.Bitmap image,
BaseDecodeType... decodeTypes)
Initializes a new instance of the
BarCodeReader class from an image. |
BarCodeReader(android.graphics.Bitmap image,
BaseDecodeType type)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(android.graphics.Bitmap image,
android.graphics.Rect[] areas,
BaseDecodeType type)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(android.graphics.Bitmap image,
android.graphics.Rect area,
BaseDecodeType... decodeTypes)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(android.graphics.Bitmap image,
android.graphics.Rect area,
BaseDecodeType type) |
BarCodeReader(java.io.InputStream stream)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(java.io.InputStream stream,
BaseDecodeType... decodeTypes)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(java.io.InputStream stream,
BaseDecodeType type)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(java.lang.String filename)
Initializes a new instance of the
BarCodeReader class from file. |
BarCodeReader(java.lang.String filename,
BaseDecodeType... decodeTypes)
Initializes a new instance of the
BarCodeReader class. |
BarCodeReader(java.lang.String filename,
BaseDecodeType type)
Initializes a new instance of the
BarCodeReader class. |
Modifier and Type | Method and Description |
---|---|
void |
abort()
Function requests termination of current recognition session from other thread.
|
void |
close()
Deprecated.
|
void |
dispose() |
float |
getAngle()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Region.Angle instead.
|
BaseDecodeType |
getBarCodeDecodeType() |
java.lang.String |
getCheckSum()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Extended.OneD.CheckSum instead.
|
ChecksumValidation |
getChecksumValidation() |
Code128DataPortion[] |
getCode128DataPortions()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Extended.Code128.Code128DataPortions instead.
|
byte[] |
getCodeBytes()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].CodeBytes instead.
|
java.lang.String |
getCodeText()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].CodeText instead.
|
java.lang.String |
getCodeText(boolean includeCheckSum)
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].CodeText instead.
|
java.lang.String |
getCodeText(java.nio.charset.Charset encoding)
Deprecated.
This method is obsolete. Call BarCodeReader.FoundBarCodes[].GetCodeText() instead.
|
SingleDecodeType |
getCodeType()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].CodeType instead.
|
java.lang.String |
getCodeTypeName()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].CodeTypeName instead.
|
CustomerInformationInterpretingType |
getCustomerInformationInterpretingType()
Gets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
|
boolean |
getDetectEncoding()
Deprecated.
|
BarCodeResult[] |
getFoundBarCodes()
Gets recognized
BarCodeResult s array |
int |
getFoundCount()
Gets recognized barcodes count
|
boolean |
getIsDeniable()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Confidence instead.
|
java.lang.String |
getMacroPdf417FileID()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Extended.Pdf417.MacroPdf417FileID instead.
|
int |
getMacroPdf417SegmentID()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Extended.Pdf417.MacroPdf417SegmentID instead.
|
int |
getMacroPdf417SegmentsCount()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Extended.Pdf417.MacroPdf417SegmentsCount instead.
|
static ProcessorSettings |
getProcessorSettings()
Gets a settings of using processor cores.
|
int |
getQRStructuredAppendModeBarCodeIndex()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Extended.QR.QRStructuredAppendModeBarCodeIndex instead.
|
int |
getQRStructuredAppendModeBarCodesQuantity()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Extended.QR.QRStructuredAppendModeBarCodesQuantity instead.
|
int |
getQRStructuredAppendModeParityData()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Extended.QR.QRStructuredAppendModeParityData instead.
|
QualitySettings |
getQualitySettings()
QualitySettings allows to configure recognition quality and speed manually.
|
float |
getRecognitionQuality()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].ReadingQuality instead.
|
BarCodeRegion |
getRegion()
Deprecated.
This method is obsolete. Use BarCodeReader.FoundBarCodes[].Region instead.
|
boolean |
getStripFNC()
Strip FNC1, FNC2, FNC3 characters from codetext.
|
int |
getTimeout()
Gets the timeout of recognition process.
|
boolean |
read()
Deprecated.
This method is obsolete. Call BarCodeReader.ReadBarCodes() instead.
|
BarCodeResult[] |
readBarCodes()
Reads
BarCodeResult s from the image. |
void |
setBarCodeImage(android.graphics.Bitmap value)
Sets bitmap image for recognition.
|
void |
setBarCodeImage(android.graphics.Bitmap value,
android.graphics.Rect area)
Sets bitmap image and area for recognition.
|
void |
setBarCodeImage(android.graphics.Bitmap value,
android.graphics.Rect[] areas)
Sets bitmap image and areas for recognition.
|
void |
setBarCodeImage(java.io.InputStream stream)
Sets image stream for recognition.
|
void |
setBarCodeImage(java.lang.String filename)
Sets image file for recogniton.
|
void |
setBarCodeReadType(BaseDecodeType type)
Sets BarCodeReadType for recognition.
|
void |
setBarCodeReadType(SingleDecodeType... barcodeTypes)
Sets
SingleDecodeType type array 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)
Deprecated.
|
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(android.graphics.Bitmap image)
Initializes a new instance of the BarCodeReader
class from an image.
image
- A Bitmap instance containing the imagepublic BarCodeReader(android.graphics.Bitmap image, BaseDecodeType... decodeTypes)
Initializes a new instance of the BarCodeReader
class from an image.
image
- A Bitmap instance containing the imagepublic BarCodeReader(android.graphics.Bitmap image, BaseDecodeType type)
Initializes a new instance of the BarCodeReader
class.
image
- The image.type
- Decode types.public BarCodeReader(android.graphics.Bitmap image, android.graphics.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(android.graphics.Bitmap image, android.graphics.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(android.graphics.Bitmap image, android.graphics.Rect area, BaseDecodeType type)
public BarCodeReader(java.lang.String filename)
Initializes a new instance of the BarCodeReader
class from file.
filename
- The filename.public BarCodeReader(java.lang.String filename, BaseDecodeType type)
Initializes a new instance of the BarCodeReader
class.
filename
- The filename.type
- The BarCodeReadType.public BarCodeReader(java.lang.String filename, BaseDecodeType... decodeTypes)
Initializes a new instance of the BarCodeReader
class.
filename
- The filename.decodeTypes
- Decode types.public BarCodeReader(java.io.InputStream stream)
Initializes a new instance of the BarCodeReader
class.
stream
- The stream.public BarCodeReader(java.io.InputStream stream, BaseDecodeType type)
Initializes a new instance of the BarCodeReader
class.
stream
- The stream.type
- The decode type.public BarCodeReader(java.io.InputStream stream, BaseDecodeType... decodeTypes)
Initializes a new instance of the BarCodeReader
class.
stream
- The stream.decodeTypes
- Decode types.public static ProcessorSettings getProcessorSettings()
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.
@Deprecated 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.
@Deprecated public boolean read()
Reads barcode from the image.
Detect AllSupportedTypesBarCodeReader reader; reader = new BarCodeReader("test.jpg"); while(reader.read()) { System.out.println("BarCode Type: "+reader.getReadType()); System.out.println("BarCode CodeText: " + reader.getCodeText()); } reader.close();
public BarCodeResult[] getFoundBarCodes()
Gets recognized BarCodeResult
s array
Value: The recognizedThis sample shows how to access to read with BarCodeReader barcodesBarCodeReader reader = new BarCodeReader("test.jpg"); reader.readBarCodes(); for(int i = 0; reader.getFoundCount() > i; ++i) System.out.println("BarCode CodeText: " + reader.getFoundBarCodes()[i].getCodeText());
BarCodeResult
s arraypublic int getFoundCount()
Gets recognized barcodes count
Value: The recognized barcodes countThis sample shows how to access to read with BarCodeReader barcodesBarCodeReader reader = new BarCodeReader("test.jpg"); reader.readBarCodes(); for(int i = 0; reader.getFoundCount() > i; ++i) System.out.println("BarCode CodeText: " + reader.getFoundBarCodes()[i].getCodeText());
public BarCodeResult[] readBarCodes()
Reads BarCodeResult
s from the image.
This sample shows how to detect any barcode.BarCodeReader reader = new BarCodeReader("test.jpg"); for (BarCodeResult result : reader.readBarCodes()) System.out.println(("BarCode CodeText: " + result.getCodeText()); BarCodeReader reader = new BarCodeReader("test.jpg"); reader.readBarCodes(); for(int i = 0; reader.getFoundCount() > i; ++i) System.out.println(("BarCode CodeText: " + reader.getFoundBarCodes()[i].getCodeText());
BarCodeResult
s on the image. If nothing is recognized, zero array is returned.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("test.jpg"); //set high performance mode reader.setQualitySettings(QualitySettings.getHighPerformance()); for (BarCodeResult result : reader.readBarCodes()) System.out.println(("BarCode CodeText: " + result.getCodeText()); BarCodeReader reader = new BarCodeReader("test.jpg"); //set high performance mode reader.setQualitySettings(QualitySettings.getHighPerformance()); //set separate options reader.getQualitySettings().setAllowMedianSmoothing(true); reader.getQualitySettings().setMedianSmoothingWindowSize(5); for (BarCodeResult result : reader.readBarCodes()) System.out.println("BarCode CodeText: " + result.getCodeText()); BarCodeReader reader = new BarCodeReader("test.jpg"); //default mode is NormalQuality //set separate options reader.getQualitySettings().setAllowMedianSmoothing(true); reader.getQualitySettings().setMedianSmoothingWindowSize(5); for(BarCodeResult result : reader.readBarCodes(); System.out.println("BarCode CodeText: " + result.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()); }
@Deprecated 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.
@Deprecated public java.lang.String getCodeText(java.nio.charset.Charset encoding)
Gets the code text with encoding.
encoding
- The encoding for codetext.@Deprecated public java.lang.String getCodeText(boolean includeCheckSum)
includeCheckSum
- true to include CheckSum into result; false to return only CodeText.@Deprecated public java.lang.String getCheckSum()
Gets the checksum for 1D barcodes.
@Deprecated public float getAngle()
Gets the angle of the barcode (0-360).
@Deprecated public byte[] getCodeBytes()
Gets the encoded code bytes.
@Deprecated public java.lang.String getMacroPdf417FileID()
Gets the file ID of the barcode, only available with MacroPdf417.
@Deprecated public int getMacroPdf417SegmentID()
Gets the segment ID of the barcode,only available with MacroPdf417.
@Deprecated public int getMacroPdf417SegmentsCount()
Gets macro pdf417 barcode segments count. Default value is -1.
@Deprecated public Code128DataPortion[] getCode128DataPortions()
Code128DataPortion
objects.@Deprecated public int getQRStructuredAppendModeBarCodesQuantity()
Gets the QR structured append mode barcodes quantity. Default value is -1.
@Deprecated public int getQRStructuredAppendModeBarCodeIndex()
Gets the index of the QR structured append mode barcode. Index starts from 0. DEFAULT value is -1.
@Deprecated public int getQRStructuredAppendModeParityData()
Gets the QR structured append mode parity data. Default value is -1.
@Deprecated public boolean getIsDeniable()
Checks the deniable recognition. Such recognition might occur in QualitySettings.MAX_BARCODES mode decoding or use QualitySettings.ALLOW_INCORRECT_BARCODES
@Deprecated public BarCodeRegion getRegion()
Gets the barcode region.
@Deprecated public SingleDecodeType getCodeType()
Gets the barcode type.
@Deprecated public java.lang.String getCodeTypeName()
Gets the name of the barcode type.
@Deprecated public float getRecognitionQuality()
Gets the recognition quality. Works for 1D and postal barcodes.
@Deprecated public boolean getDetectEncoding()
A flag which force engine to detect codetext encoding for Unicode codesets.
This sample shows how to detect text encoding on the fly if DetectEncoding is enabledInputStream is = new ByteArrayInputStream(new byte[...]); BarCodeBuilder bb = new BarCodeBuilder()) bb.setCodeText("пїЅпїЅпїЅпїЅпїЅ"); bb.setEncodeType(EncodeTypes.QR); bb.setCodeTextEncoding(Charset.forName("UTF-8")); bb.save(is, BarCodeImageFormat.PNG); reader = new BarCodeReader(is, BarCodeReadType.QR); reader.setDetectEncoding(true); for(BarCodeResult result : reader.readBarCodes()) System.out.println("BarCode CodeText: " + result.getCodeText()); is.setPosition(0); reader = new BarCodeReader(is, BarCodeReadType.QR); reader.setDetectEncoding(false); for(BarCodeResult result : reader.readBarCodes()) System.out.println("BarCode CodeText: " + result.getCodeText());
@Deprecated public void setDetectEncoding(boolean value)
A flag which force engine to detect codetext encoding for Unicode codesets.
This sample shows how to detect text encoding on the fly if DetectEncoding is enabledInputStream is = new ByteArrayInputStream(new byte[...]); BarCodeBuilder bb = new BarCodeBuilder()) bb.setCodeText("пїЅпїЅпїЅпїЅпїЅ"); bb.setEncodeType(EncodeTypes.QR); bb.setCodeTextEncoding(Charset.forName("UTF-8")); bb.save(is, BarCodeImageFormat.PNG); reader = new BarCodeReader(is, BarCodeReadType.QR); reader.setDetectEncoding(true); for(BarCodeResult result : reader.readBarCodes()) System.out.println("BarCode CodeText: " + result.getCodeText()); is.setPosition(0); reader = new BarCodeReader(is, BarCodeReadType.QR); reader.setDetectEncoding(false); for(BarCodeResult result : reader.readBarCodes()) System.out.println("BarCode CodeText: " + result.getCodeText());
public final void setBarCodeImage(android.graphics.Bitmap value, android.graphics.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(android.graphics.Bitmap value, android.graphics.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(android.graphics.Bitmap value)
Sets bitmap image for recognition. Must be called before Read() method.
value
- The bitmap image for recognition.public void setBarCodeImage(java.lang.String filename)
Sets image file for recogniton. Must be called before Read() method.
filename
- The image file for recogniton.public void setBarCodeReadType(SingleDecodeType... barcodeTypes)
Sets SingleDecodeType
type array for recognition.
Must be called before Read() method.
barcodeTypes
- The SingleDecodeType
type array to read.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()