DSDecodedBarcodeElement Class

DSDecodedBarcodeElement extends the DSRegionObjectElement class and represents a decoded barcode element.

Definition

Assembly: DynamsoftCaptureVisionBundle.xcframework

• Objective-C
• Swift

1. @interface DSDecodedBarcodeElement: DSRegionObjectElement
   

2. class DecodedBarcodeElement: RegionObjectElement
   

Methods

The following attributes are inherited from class DSRegionObjectElement.

| 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. |

init

Create a new DSDecodedBarcodeElement object.

• Objective-C
• Swift

1. - (instancetype)init;
   

2. init()
   

getText

Returns the text of the decoded barcode.

• Objective-C
• Swift

1. - (NSString *)getText
   

2. func getText() -> String
   

Return Value

A string representing the text of the decoded barcode.

setText

Set the text of the decoded barcode. The barcode bytes are changed as well to reflect the new text.

• Objective-C
• Swift

1. - (void)setText:(NSString *)text
   

2. func setText(text: String)
   

Parameters

[in] text: The text to be set for the decoded barcode.

Return Value

Returns the ErrorCode if it fails. Otherwise, returns 0.

getBytes

Returns the raw bytes of the decoded barcode.

• Objective-C
• Swift

1. - (NSData *)getBytes
   

2. func getBytes() -> NSData
   

Return Value

A NSData object representing the raw bytes of the decoded barcode.

setBytes

Set the raw bytes of the decoded barcode. The text of the barcode will change to reflect the new barcode bytes.

• Objective-C
• Swift

1. - (void)setBytes:(NSData *)bytes
   

2. func setBytes(bytes: NSData)
   

Parameters

[in] bytes: The bytes of the decoded barcode.

Return Value

Returns the ErrorCode if it fails. Otherwise, returns 0.

getFormat

Returns the format of the decoded barcode as a DSBarcodeFormat item.

• Objective-C
• Swift

1. - (DSBarcodeFormat)getFormat
   

2. func getFormat() -> BarcodeFormat
   

Return Value

A DSBarcodeFormat item representing the format of the decoded barcode.

setFormat

Set the format of the decoded barcode using a DSBarcodeFormat item.

• Objective-C
• Swift

1. - (void)setFormat:(DSBarcodeFormat)format
   

2. func setFormat(_ format: BarcodeFormat)
   

Parameters

[in] format: The format of the decoded barcode.

Return Value

Returns the ErrorCode if it fails. Otherwise, returns 0.

getConfidence

Returns the confidence score of the decoded barcode.

• Objective-C
• Swift

1. - (NSInteger)getConfidence
   

2. func getConfidence() -> NSInteger
   

Return Value

An integer representing the confidence score.

setConfidence

Set the confidence score of the decoded barcode.

• Objective-C
• Swift

1. - (void)setConfidence:(NSInteger)confidence
   

2. func setConfidence(_ confidence: NSInteger)
   

Parameters

[in] confidence: The confidence of the decoded barcode.

Return Value

Returns the ErrorCode if it fails. Otherwise, returns 0.

getFormatString

Returns the format of the decode barcode as a string.

• Objective-C
• Swift

1. - (NSString *)getFormatString
   

2. func getFormatString() -> String
   

Return Value

A string representing the format of the barcode.

getAngle

Returns the orientation angle of the decoded barcode should it be rotated in any way.

• Objective-C
• Swift

1. - (NSInteger)getAngle
   

2. func getAngle() -> NSInteger
   

Return Value

An integer representing the orientation angle of the barcode.

getModuleSize

Returns the module size of the decoded barcode.

• Objective-C
• Swift

1. - (NSInteger)getModuleSize
   

2. func getModuleSize() -> NSInteger
   

Return Value

An integer representing the module size of the decoded barcode.

getDetails

Returns the BarcodeDetails of the decoded barcode.

• Objective-C
• Swift

1. - (DSBarcodeDetails *)getDetails
   

2. func getDetails() -> BarcodeDetails
   

Return Value

A DSBarcodeDetails object representing the details of the decoded barcode.

getExtendedBarcodeResults

Returns the extended barcode result(s) of the decoded barcode as a DSExtendedBarcodeResult object. Please visit the DSExtendedBarcodeResult page to learn more of what information is contained there.

• Objective-C
• Swift

1. - (nullable NSArray<DSExtendedBarcodeResult *>*)getExtendedBarcodeResults
   

2. func getExtendedBarcodeResults() -> [ExtendedBarcodeResult]?
   

Return Value

An array of DSExtendedBarcodeResult that represents the extended barcode results.

isDPM

Specifies if the decoded barcode is a Direct Part Marking (DPM) code or not. DPM codes are read by setting the DPMCodeReadingModes.

• Objective-C
• Swift

1. - (BOOL)isDPM
   

2. func isDPM() -> Bool
   

Return Value

A BOOL value describing whether the barcode is a DPM code or not.

isMirrored

Specifies if the decoded barcode is mirrored or not. Mirrored barcodes are read by setting the MirrorMode.

• Objective-C
• Swift

1. - (BOOL)isMirrored
   

2. func isMirrored() -> Bool
   

Return Value

A BOOL value describing whether the barcode is mirrored or not.

setLocation

Sets the location of the decoded barcode.

• Objective-C
• Swift

1. - (NSInteger)setLocation:(DSQuadrilateral *)location;
   

2. func setLocation(_ location: DSQuadrilateral)
   

Parameters

[in] location: The location of the decoded barcode as a DSQuadrilateral object.

Return Value

Returns 0 if the location is set successfully, otherwise returns the error code.