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 {
   ...
}

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

    Declaration

    Swift

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

  • The cropped captured image

    Declaration

    Swift

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

  • The cropped flash image

    Declaration

    Swift

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

  • The original captured image

    Declaration

    Swift

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

  • The original flash image

    Declaration

    Swift

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

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

    Declaration

    Swift

    @objc
open internal(set) 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

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

  • Undocumented

    Declaration

    Swift

    @objc
required public init(options: DSOptions)

  • Undocumented

    Declaration

    Swift

    @objc
override open var description: String { get }