DSResult

@objc
open class DSResult : NSObject

A capture result representing an attempt to capture an object. The result will return all information about the capture attempt including any captured images.

Example Usage:

if let error = resut.error {
   //do something with the error
}

if let capturedImage = result.image {
   ...
}

  • Undocumented

    Declaration

    Swift

    @objc
open var originalImage: Data? { get }

  • Undocumented

    Declaration

    Swift

    @objc
open var originalFlashImage: Data? { get }

  • Document data related to the scan, for example a ID1 barcode data

    Declaration

    Swift

    @objc
open internal(set) var documentData: DSDocumentData? { get }

  • The image the SDK thinks is the best for validation use. This image may be cropped or uncropped, please check the isImageCropped flag to determine if the image is cropped or not

    Declaration

    Swift

    @objc
open internal(set) var image: Data? { get }

  • The flash image the SDK thinks is the best for validation use. This image may be cropped or uncropped, please check the isFlashImageCropped flag to determine if the image is cropped or not

    Declaration

    Swift

    @objc
open internal(set) var flashImage: Data? { get }

  • The cropped captured image

    Declaration

    Swift

    @objc
open internal(set) var croppedImage: Data? { get }

  • The cropped flash image

    Declaration

    Swift

    @objc
open internal(set) var croppedFlashImage: Data? { get }

  • The uncropped captured image

    Declaration

    Swift

    @objc
open internal(set) var uncroppedImage: Data? { get }

  • The uncropped flash image

    Declaration

    Swift

    @objc
open internal(set) var uncroppedFlashImage: Data? { get }

  • Idicates whether the image property contains a cropped image

    Declaration

    Swift

    @objc
open internal(set) var isImageCropped: Bool { get }

  • Idicates whether the flashImage property contains a cropped image

    Declaration

    Swift

    @objc
open internal(set) var isFlashImageCropped: Bool { get }

  • Indicates that a face was detected in the image or not

    Declaration

    Swift

    @available(*, deprecated, message: "Please use captureAnalysis.faceDetected")
@objc
open var faceDetected: Bool { get }

  • Indicates how confident the SDK is that it captured the configured document type

    Declaration

    Swift

    @objc
open internal(set) var confidence: Double { get }

  • An error that represents why an image was not captured, these can be informative errors like the user was too close to the target document

    Declaration

    Swift

    @objc
open internal(set) var error: DSError? { get }

  • Focus confidence from 0 meaning no fous to 1.0 meaning completely in focus. This value should not be considered to be binary, a 0.40 could be an in focus value, however higher values will indicate better focus.

    Declaration

    Swift

    @available(*, deprecated, message: "Please use captureAnalysis.focus")
@objc
open var focus: Double { get }

  • Provides detailed analysis about the image that was just captured.

    Declaration

    Swift

    @objc
open internal(set) var captureAnalysis: CaptureAnalysis { get }

  • Undocumented

    Declaration

    Swift

    @objc
public init(options: DSOptions)

  • Undocumented

    Declaration

    Swift

    override open var description: String { get }