DSDecodedBarcodeElement Class

The DSDecodedBarcodeElement class represents a decoded barcode element. It inherits from the DSRegionObjectElement class and provides additional functionality for retrieving information about the decoded barcode.

Definition

Assembly: DynamsoftBarcodeReader.framework

Objective-C
Swift

@interface DSDecodedBarcodeElement: DSRegionObjectElement

class DecodedBarcodeElement: RegionObjectElement

Attributes

Attributes	Type	Description
`text`	NSString *	The text of the decoded barcode.
`bytes`	NSData *	The raw bytes of the decoded barcode.
`isDPM`	BOOL	Whether the barcode is a DPM (Direct Part Marking) barcode (decoded by DPMReadingMode).
`isMirrored`	BOOL	Whether the barcode is mirrored (decoded by MirrorMode).
`format`	DSBarcodeFormat	The format of the decoded barcode as a barcode format enumeration.
`formatString`	NSString *	The format of the decode barcode as a string.
`angle`	NSInteger	The orientation angle of the barcode.
`moduleSize`	NSInteger	The module size of the decoded barcode.
`confidence`	NSInteger	The confidence score of the barcode recognition result.
`details`	DSBarcodeDetails *	The details of the decoded barcode.
`extendedBarcodeResults`	NSArray<DSExtendedBarcodeResult >	An array of extended barcode results.

Inherited Attributes

The following attributes are inherited from class DSRegionObjectElement.

Attributes	Type	Description
`location`	DSQuadrilateral *	The location info of the element that defined in DSQuadrilateral.
`referencedElement`	DSRegionObjectElement *	The referenced element that supports the capturing of this element.
`regionObjectElementType`	DSRegionObjectElementType	The type of the element.

text

The text of the decoded barcode.

Objective-C
Swift

@property(nonatomic, nullable, readonly) NSString* text;

```
var text: String? { get }
```

bytes

The raw bytes of the decoded barcode.

Objective-C
Swift

@property(nonatomic, nullable, readonly) NSData* bytes;

```
var bytes: Data? { get }
```

isDPM

Whether the barcode is a DPM (Direct Part Marking) barcode (decoded by DPMReadingMode).

Objective-C
Swift

@property(nonatomic, assign, readonly) BOOL isDPM;

```
var isDPM: Bool { get }
```

isMirrored

Whether the barcode is mirrored (decoded by MirrorMode).

Objective-C
Swift

@property(nonatomic, assign, readonly) BOOL isMirrored;

```
var isMirrored: Bool { get }
```

format

The format of the decoded barcode as a barcode format enumeration.

Objective-C
Swift

@property(nonatomic, assign, readonly) DSBarcodeFormat format;

```
var format: DSBarcodeFormat { get }
```

formatString

The format of the decode barcode as a string.

Objective-C
Swift

@property(nonatomic, assign, readonly) NSString * formatString;

```
var formatString: String { get }
```

angle

The orientation angle of the barcode.

Objective-C
Swift

@property(nonatomic, assign, readonly) NSInteger angle;

```
var angle: Int { get }
```

moduleSize

The module size of the decoded barcode.

Objective-C
Swift

@property(nonatomic, assign, readonly) NSInteger moduleSize;

```
var moduleSize: Int { get }
```

confidence

The confidence score of the barcode recognition result.

Objective-C
Swift

@property(nonatomic, assign, readonly) NSInteger confidence;

```
var confidence: Int { get }
```

details

The details of the decoded barcode.

Objective-C
Swift

@property(nonatomic, nullable, readonly) DSBarcodeDetails* details;

```
var details: DSBarcodeDetails? { get }
```

extendedBarcodeResults

An array of extended barcode results.

Objective-C
Swift

@property(nonatomic, nullable, readonly) NSArray<DSExtendedBarcodeResult *>* extendedBarcodeResults;

var extendedBarcodeResults: [ExtendedBarcodeResult]? { get }