DSBarcodeResultItem Class

DSBarcodeResultItem extends the DSCapturedResultItem class and represents a single barcode result. This is the most basic item of the decoded barcode result, one of the captured result types that the Capture Vision Router can output.

Definition

Assembly: DynamsoftBarcodeReader.xcframework

Objective-C
Swift

@interface DSBarcodeResultItem: DSCapturedResultItem

class BarcodeResultItem : DSCapturedResultItem

Attributes

Attributes	Type	Description
`format`	DSBarcodeFormat	The format of the barcode.
`formatString`	NSString *	The format text of the barcode.
`text`	NSString *	The decode text of the barcode.
`bytes`	NSData *	The decode byte of the barcode.
`location`	DSQuadrilateral *	The location of the barcode.
`confidence`	NSInteger	The confidence of the decoding result.
`angle`	NSInteger	The rotation angle of the barcode.
`moduleSize`	NSInteger	The module size of the barcode.
`details`	DSBarcodeDetails *	The details of the decoded barcode.
`isDPM`	BOOL	Specifies if the decoded barcode is a DPM code or not.
`isMirrored`	BOOL	Specifies if the decoded barcode is mirrored or not.

The following attributes are inherited from DSCapturedResultItem.

Attributes	Type	Description
`type`	DSCapturedResultItemType	The type of the captured result item.
`referencedItem`	DSCapturedResultItem *	The referenced captured result item. The reference dependencies is defined in the Capture Vision settings.
`targetROIDefName`	NSString	The name of the `TargetROIDef` object which includes a task that generated the result.
`taskName`	NSString	The name of the task that generated the result.

format

The format of the barcode. This format will be one of the DSBarcodeFormat enumerations.

Objective-C
Swift

@property(nonatomic, readonly) DSBarcodeFormat format;

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

formatString

The format of the barcode, but as a string instead of a DSBarcodeFormat enumeration item.

Objective-C
Swift

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

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

text

The raw decoded text of the barcode.

Objective-C
Swift

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

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

bytes

The raw bytes of the decoded barcode text which is useful when the text string cannot be used.

Objective-C
Swift

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

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

location

The location of the barcode as a DSQuadrilateral. The quadrilateral contains the four vertices of the location, with the first vertex in the points array being the top-left most vertex, and then going in a clockwise direction.

Objective-C
Swift

@property(nonatomic, nullable, readonly) DSQuadrilateral *location;

```
var location: DSQuadrilateral? { get }
```

confidence

The confidence of the decoded result, which is a measure of the result’s accuracy or reliability. If the confidence is lower than 30, the result will not be output by default. To change the minimum accepted confidence score for a barcode, please see the minResultConfidence setting.

Objective-C
Swift

@property(nonatomic, readonly) NSInteger confidence;

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

angle

If the barcode is captured at an angle or is rotated by any measure, this property represents the rotation angle of the barcode.

Objective-C
Swift

@property(nonatomic, readonly) NSInteger angle;

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

moduleSize

The size of the individual modules or elements within the barcode.

Objective-C
Swift

@property(nonatomic, readonly) NSInteger moduleSize;

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

details

The details of the decoded barcode. DSBarcodeDetails can offer much more enhanced details specific to the barcode format of the decoded barcode. If you would like to learn more about how you can use these barcode details, please see this article on how to get detailed barcode info.

Objective-C
Swift

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

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

isDPM

Specifies if the decoded barcode is a Direct Part Marking (DPM) code or not. To learn how to read DPM codes, please visit how to read DPM codes.

Objective-C
Swift

@property(nonatomic, readonly) BOOL isDPM;

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

isMirrored

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

Objective-C
Swift

@property(nonatomic, readonly) BOOL isMirrored;

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