DSDecodedBarcodesUnit Class
DSDecodedBarcodesUnit extends the DSIntermediateResultUnit class and represents a unit which holds the decoded barcodes.
Definition
Assembly: DynamsoftCaptureVisionBundle.xcframework
- Objective-C
- Swift
NS_SWIFT_NAME(DecodedBarcodesUnit) @interface DSDecodedBarcodesUnit: DSIntermediateResultUnitclass DecodedBarcodesUnit: DSIntermediateResultUnit
Methods
| Method | Description |
|---|---|
getDecodedBarcodes |
Returns all the barcodes that are decoded from the image. |
getCount |
Returns the number of decoded barcodes. |
getDecodedBarcode |
Returns the decoded barcode by specifying the index. |
removeAllDecodedBarcodes |
Remove all the decoded barcodes. |
setDecodedBarcode |
Set the decoded barcode. |
The following methods are inherited from DSIntermediateResultUnit.
| Method | Description |
|——- |————-|
| getLocation | Gets the location of the region object, represented as a quadrilateral. |
| getReferencedElement | Gets the referenced element that supports the capturing of this element. |
| getRegionObjectElementType | Gets the type of the region object element, defined by the enumeration DSRegionObjectElementType. |
| getImageData | Gets the image data of this region object element. |
getDecodedBarcodes
Returns all the barcodes that are decoded from the image as an array of DSDecodedBarcodeElement.
- Objective-C
- Swift
- (nullable NSArray<DSDecodedBarcodeElement*>*)getDecodedBarcodesfunc getDecodedBarcodes() -> [DSDecodedBarcodeElement]?
Return Value
An array of DSDecodedBarcodeElement as the decoded barcodes.
getCount
Returns the number of barcodes that are decoded from the image.
- Objective-C
- Swift
- (NSInteger)getCountfunc getCount() -> NSInteger
Return Value
An integer representing the number of barcodes that are decoded from the image.
getDecodedBarcode
Returns the DSDecodedBarcodeElement at the specified index. This is the same as accessing the same index of the result array from getDecodedBarcodes.
- Objective-C
- Swift
- (nullable DSDecodedBarcodeElement*)getDecodedBarcode:(NSInteger)indexfunc getDecodedBarcode(index: NSInteger) -> DSDecodedBarcodeElement?
Parameters
[in] index: The index of the decoded barcode from the array of decoded barcodes.
Return Value
A DSDecodedBarcodeElement representing the decoded barcode.
removeAllDecodedBarcodes
Removes all the DSDecodedBarcodeElement from the DSDecodedBarcodesUnit.
- Objective-C
- Swift
- (void)removeAllDecodedBarcodesfunc removeAllDecodedBarcodes()
setDecodedBarcode
Set the DSDecodedBarcodeElement of the DSDecodedBarcodesUnit.
- Objective-C
- Swift
- (NSInteger)setDecodedBarcode:(DSDecodedBarcodeElement*)element matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImagefunc setDecodedBarcode(element: DSDecodedBarcodeElement, matrixToOriginalImage: CGAffineTransform) -> Int
Parameters
[in] element: The DSDecodedBarcodeElement to replace all the decoded barcodes of the DSDecodedBarcodesUnit.
[in] matrixToOriginalImage: The transformation matrix to convert the decoded barcode object to the original image.
Return Value
Returns the ErrorCode if it fails. Otherwise, returns 0.