BarCodeReader
BarCodeReader class
Namespace: Aspose.Barcode.Recognition
BarCodeReader encapsulates an image which may contain one or several barcodes, it then can perform ReadBarCodes operation to detect barcodes. This sample shows how to detect Code39 and Code128 barcodes.
Constructors
| Name | Description |
|---|---|
| __construct |
Methods
| Name | Static | Description |
|---|---|---|
| containsAny | No | Determines whether any of the given decode types is included into |
| exportToXml | No | Exports BarCode properties to the xml-file specified |
| importFromXml | Yes | Import BarCode properties from xml file |
| init | No | |
| setBarCodeImage | No | 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. |
| setBarCodeReadType | No | Sets SingleDecodeType type array for recognition. Must be called before readBarCodes() method. This sample shows how to detect Code39 and Code128 barcodes. |
Properties
| Name | Read/Write | Description |
|---|---|---|
| BarCodeDecodeType | Read-only | |
| FoundBarCodes | Read-only | Reads BarCodeResult from the image. Value: The recognized BarCodeResult array |
| FoundCount | Read-only | Gets recognized barcodes count This sample shows how to read barcodes with BarCodeReader Value: The recognized barcodes count |
| Timeout | Read/Write | Gets the timeout of recognition process in milliseconds. |
BarCodeReader__construct($imageResource, $areas, $decodeTypes)
| Parameter | Type | Description |
|---|---|---|
$imageResource | `` | |
$areas | `` | |
$decodeTypes | `` |
containsAnycontainsAny($decodeTypes)
Determines whether any of the given decode types is included into
| Parameter | Type | Description |
|---|---|---|
$decodeTypes | `` |
Returns: bool Value is a true if any types are included into.
exportToXmlexportToXml(string $xmlFile)
Exports BarCode properties to the xml-file specified
| Parameter | Type | Description |
|---|---|---|
$xmlFile | string |
Returns: bool Whether or not export completed successfully. Returns True in case of success; False Otherwise
importFromXmlimportFromXml(string $resource) (static)
Import BarCode properties from xml file
| Parameter | Type | Description |
|---|---|---|
$resource | string |
Returns: BarCodeReader
initinit()
setBarCodeImagesetBarCodeImage($imageResource, ?Rectangle … $areas)
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.
| Parameter | Type | Description |
|---|---|---|
$imageResource | `` | |
$areas | ?Rectangle ... |
setBarCodeReadTypesetBarCodeReadType(int … $types)
Sets SingleDecodeType type array for recognition. Must be called before readBarCodes() method. This sample shows how to detect Code39 and Code128 barcodes.
| Parameter | Type | Description |
|---|---|---|
$types | int ... |
BarCodeDecodeType
Access: Read-only
FoundBarCodes
Access: Read-only
Reads BarCodeResult from the image. Value: The recognized BarCodeResult array
FoundCount
Access: Read-only
Gets recognized barcodes count This sample shows how to read barcodes with BarCodeReader Value: The recognized barcodes count
Timeout
Access: Read/Write
Returns: int timeout.
Gets the timeout of recognition process in milliseconds.
Sets the timeout of recognition process in milliseconds.
| Parameter | Type | Description |
|---|---|---|
$value | int |