DSCapturedResult

The DSCapturedResult class represents the result of a capture operation on an image. Internally, DSCapturedResult stores an array that contains multiple items, each of which may be a barcode, text line, detected quad, normalized image, original image, parsed item, etc.

Definition

Assembly: DynamsoftCaptureVisionBundle.xcframework

Objective-C
Swift

@interface DSCapturedResult : DSCapturedResultBase

class CapturedResult : CapturedResultBase

Attributes

Attributes	Type	Description
`items`	NSArray<DSCapturedResultItem> **	An array of `DSCapturedResultItems`, which are the basic item of the captured results. A `DSCapturedResultItem` can be an original image, a decoded barcode, a recognized text, a detected quad, a normalized image or a parsed result. View DSCapturedResultItemType for all available types.
`decodedBarcodesResult`	DSDecodedBarcodesResult	A `DSDecodedBarcodesResult` object that contains all the `DSBarcodeResultItems` in the DSCapturedResult.
`recognizedTextLinesResult`	DSRecognizedTextLinesResult	A `DSRecognizedTextLinesResult` object that contains all the `DSTextLineResultItems` in the DSCapturedResult.
`processedDocumentResult`	DSProcessedDocumentResult	A `DSProcessedDocumentResult` object that contains all the results with the type of deskewed image, detected quads, and enhanced images.
`parsedResult`	DSParsedResult	A `DSParsedResult` object that contains all the `DSParsedResultItem` in the DSCapturedResult.

The following attributes are inherited from DSCapturedResultBase:

Attributes	Type	Description
`originalImageHashId`	NSString *	The hash id of the original image.
`originalImageTag`	DSImageTag *	The DSImageTag of the original image.
`rotationTransformMatrix`	CGAffineTransform	The rotation transformation matrix of the original image relative to the rotated image.
`errorCode`	NSInteger	Get the error code of this result.
`errorMessage`	NSString *	Get the error message of this result.

items

An array of DSCapturedResultItem, which is the basic unit of the captured results. A DSCapturedResultItem can be an original image, a decoded barcode, a recognized text, a detected quad, a normalized image, or a parsed result. View DSCapturedResultItemType for all available types.

Objective-C
Swift

@property (nonatomic, readonly, copy, nullable) NSArray<DSCapturedResultItem *> *items;

var items: [CapturedResultItem]? { get }

decodedBarcodesResult

A DSDecodedBarcodesResult object that contains all the DSBarcodesResultItems in the DSCapturedResult.

Objective-C
Swift

@property (nonatomic, readonly, strong, nullable) DSDecodedBarcodesResult * decodedBarcodesResult;

var decodedBarcodesResult: DecodedBarcodesResult? { get }

recognizedTextLinesResult

A DSRecognizedTextLinesResult object that contains all the DSTextLinesResultItems in the DSCapturedResult.

Objective-C
Swift

@property (nonatomic, readonly, strong, nullable) DSRecognizedTextLinesResult * recognizedTextLinesResult;

var recognizedTextLinesResult: RecognizedTextLinesResult? { get }

processedDocumentResult

A DSProcessedDocumentResult object that contains all the results with the type of deskewed image, detected quads, and enhanced images.

Objective-C
Swift

@property (nonatomic, readonly, strong, nullable) DSProcessedDocumentResult * processedDocumentResult;

var processedDocumentResult: ProcessedDocumentResult? { get }

parsedResult

A DSParsedResult object that contains all the DSParsedResultItem in the DSCapturedResult.

Objective-C
Swift

@property (nonatomic, readonly, strong, nullable) DSParsedResult * parsedResult;

var parsedResult: ParsedResult? { get }