Resource Base
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.

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

  • Objective-C
  • Swift
  1. @interface DSCapturedResult : NSObject
    
  2. 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 DSBarcodesResultItems in the DSCapturedResult.
recognizedTextLinesResult DSRecognizedTextLinesResult A DSRecognizedTextLinesResult object that contains all the DSTextLinesResultItems 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
  1. @property(nonatomic, copy, readonly) NSString *originalImageHashId;
    
  2. 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. @property(nonatomic, readonly) DSImageTag *originalImageTag;
    
  2. 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. @property(nonatomic, strong, nullable, readonly) NSArray<DSCapturedResultItem *> *items;
    
  2. 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. @property(nonatomic, assign, readonly) CGAffineTransform rotationTransformMatrix;
    
  2. 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. @property (nonatomic, assign, readonly) NSInteger errorCode;
    
  2. 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. @property (nonatomic, assign, readonly) NSString * errorMessage;
    
  2. var errorMessage: String { get }
    

decodedBarcodesResult

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

  • Objective-C
  • Swift
  1. @property (nonatomic, readonly, strong, nullable) DSDecodedBarcodesResult * decodedBarcodesResult;
    
  2. var decodedBarcodesResult: DecodedBarcodesResult? { get }
    

recognizedTextLinesResult

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

  • Objective-C
  • Swift
  1. @property (nonatomic, readonly, strong, nullable) DSRecognizedTextLinesResult * recognizedTextLinesResult;
    
  2. var recognizedTextLinesResult: RecognizedTextLinesResult? { get }
    

detectedQuadsResult

A DSDetectedQuadsResult object that contains all the DSDetectedQuadResultItem in the DSCapturedResult.

  • Objective-C
  • Swift
  1. @property (nonatomic, readonly, strong, nullable) DSDetectedQuadsResult * detectedQuadsResult;
    
  2. var detectedQuadsResult: DetectedQuadsResult? { get }
    

normalizedImagesResult

A DSNormalizedImagesResult object that contains all the DSNormalizedImageResultItem in the DSCapturedResult.

  • Objective-C
  • Swift
  1. @property (nonatomic, readonly, strong, nullable) DSNormalizedImagesResult * normalizedImagesResult;
    
  2. var normalizedImagesResult: NormalizedImagesResult? { get }
    

parsedResult

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

  • Objective-C
  • Swift
  1. @property (nonatomic, readonly, strong, nullable) DSParsedResult * parsedResult;
    
  2. var parsedResult: ParsedResult? { get }
    

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version
    • Version 2.x
      • Version 2.2.10
      • Version 2.0.21
      • Version 2.0.20
      • Version 2.0.10
      • Version 2.2.10
      • Version 2.0.21
      • Version 2.0.20
      • Version 2.0.10
    • Version 1.x
      • Version 1.2.1
      • Version 1.2.0
      • Version 1.1.0
      • Version 1.0.0
      • Version 1.0.4
      • Version 1.0.3
      • Version 1.0.2
      • Version 1.0.1
      • Version 1.0.0
      • Version 1.1.13
      • Version 1.1.12
      • Version 1.1.11
      • Version 1.1.9
      • Version 1.1.8
      • Version 1.1.7
      • Version 1.1.6
      • Version 1.1.5
      • Version 1.1.4
      • Version 1.1.3
      • Version 1.1.2
      • Version 1.1.1
      • Version 1.1.0
      • Version 1.0.0
      • Version 1.0.4
      • Version 1.0.3
      • Version 1.0.2
      • Version 1.0.1
      • Version 1.0.0
    Change +
    © 2003–2024 Dynamsoft. All rights reserved.
    Privacy Statement / Site Map / Home / Purchase / Support