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: DynamsoftCore.xcframework
- Objective-C
- Swift
@interface DSCapturedResult : NSObject
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 ImageTag associated with the original image. |
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. |
rotationTransformMatrix |
CGAffineTransform | The rotation transformation matrix of the original image relative to the rotated image. |
errorCode |
NSInteger | Error code associated with the capture result. |
errorMessage |
NSString * | Error message providing details about the error. |
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. |
detectedQuadsResult |
DSDetectedQuadsResult | A DSDetectedQuadsResult object that contains all the DSDetectedQuadResultItem in the DSCapturedResult. |
normalizedImagesResult |
DSNormalizedImagesResult | A DSNormalizedImagesResult object that contains all the DSNormalizedImageResultItem in the DSCapturedResult. |
parsedResult |
DSParsedResult | A DSParsedResult object that contains all the DSParsedResultItem in the DSCapturedResult. |
originalImageHashId
The hash ID of the original image which can be used to get the original image via the IntermediateResultManager class.
- Objective-C
- Swift
@property(nonatomic, copy, readonly) NSString *originalImageHashId;
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
@property(nonatomic, readonly) DSImageTag *originalImageTag;
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
@property(nonatomic, strong, nullable, readonly) NSArray<DSCapturedResultItem *> *items;
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
@property(nonatomic, assign, readonly) CGAffineTransform rotationTransformMatrix;
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
@property (nonatomic, assign, readonly) NSInteger errorCode;
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
@property (nonatomic, assign, readonly) NSString * errorMessage;
var errorMessage: String { 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 }
detectedQuadsResult
A DSDetectedQuadsResult
object that contains all the DSDetectedQuadResultItem
in the DSCapturedResult.
- Objective-C
- Swift
@property (nonatomic, readonly, strong, nullable) DSDetectedQuadsResult * detectedQuadsResult;
var detectedQuadsResult: DetectedQuadsResult? { get }
normalizedImagesResult
A DSNormalizedImagesResult
object that contains all the DSNormalizedImageResultItem
in the DSCapturedResult.
- Objective-C
- Swift
@property (nonatomic, readonly, strong, nullable) DSNormalizedImagesResult * normalizedImagesResult;
var normalizedImagesResult: NormalizedImagesResult? { 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 }