Skip to content

Latest commit

 

History

History
146 lines (120 loc) · 4.85 KB

captured-result.md

File metadata and controls

146 lines (120 loc) · 4.85 KB
Raw
layout title description keywords needGenerateH3Content needAutoGenerateSidebar noTitleIndex ignore
default-layout
DSCapturedResult - Dynamsoft Core Module iOS Edition API Reference
The class DSCapturedResult of Dynamsoft Core Module represents the result of a capture operation on an image, which contains multiple items such as barcode, text line, detected quad, normalized image, original image, parsed item, etc.
captured result, objective-c, swift
true
true
true
true

DSCapturedResult

You are viewing a history document page of DynamsoftCore v3.0.20. Start from v3.2.10 version, the class DSCapturedResult is migrated to the DynamsoftCaptureVisionRouter library. [View the latest document page of DSCapturedResult]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result.html).

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: DynamsoftCore.framework

>- Objective-C >- Swift > >1. ```objc @interface DSCapturedResult : NSObject ``` 2. ```swift class CapturedResult : NSObject ```

Attributes

Attributes Type Description
originalImageHashId NSString * The hash id of the original image. You can use this ID to get the original image via IntermediateResultManager class.
originalImageTag DSImageTag The DSImageTag of the original image that records information such as the image ID of the original image.
items NSArray<DSCapturedResultItem> ** An array of DSCapturedResultItems, which are the basic unit of the captured results. A DSCapturedResultItem can be a original image, a decoded barcode, a recognized text, a detected quad, a normalized image or a parsed result. View DSCapturedResultItemType for all available types.
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.

originalImageHashId

The hash ID of the original image which can be used to get the original image via the IntermediateResultManager class.

>- Objective-C >- Swift > >1. ```objc @property(nonatomic, copy, readonly) NSString *originalImageHashId; ``` 2. ```swift var originalImageHashId: String { get } ```

originalImageTag

The DSImageTag of the original image that records information such as the image ID of the original image.

>- Objective-C >- Swift > >1. ```objc @property(nonatomic, readonly) DSImageTag *originalImageTag; ``` 2. ```swift var originalImageTag: ImageTag { get } ```

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 > >1. ```objc @property(nonatomic, strong, nullable, readonly) NSArray *items; ``` 2. ```swift var items: [CapturedResultItem]? { get } ```

rotationTransformMatrix

The rotation transformation matrix of the original image relative to the rotated image. View CGAffineTransform for more info.

>- Objective-C >- Swift > >1. ```objc @property(nonatomic, assign, readonly) CGAffineTransform rotationTransformMatrix; ``` 2. ```swift var rotationTransformMatrix: CGAffineTransform { get } ```

errorCode

Get the error code of this result. A CapturedResult will carry error information when the license module is missing or the process timeout.

>- Objective-C >- Swift > >1. ```objc @property (nonatomic, assign, readonly) NSInteger errorCode; ``` 2. ```swift var errorCode: Int { get } ```

errorMessage

Get the error message of this result. A CapturedResult will carry error information when the license module is missing or the process timeout.

>- Objective-C >- Swift > >1. ```objc @property (nonatomic, assign, readonly) NSString * errorMessage; ``` 2. ```swift var errorMessage: String { get } ```