Options

struct Options

Document capture options.

  • Lower document capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.2.

    A lower width threshold tolerance of 0.2 (20%) means that a scanned ID must fall within (100 - 20) = 80% of the capture overlay rectangle width.

    Declaration

    Swift

    public var lowerWidthThresholdTolerance: Float

  • Upper ID capture rectangle width threshold tolerance percentage, represented as a value between 0.0 and 1.0. Default is 0.05.

    An upper width threshold tolerance of 0.05 (5%) means that a scanned ID must fall within (100 + 5) = 105% of the capture overlay rectangle width.

    Declaration

    Swift

    public var upperWidthThresholdTolerance: Float

  • Whether or not to display debug information during capture. Default is false.

    Declaration

    Swift

    public var isDebugMode: Bool

  • Whether or not to always try to capture in 4K. Default is false.

    Declaration

    Swift

    public var capture4K: Bool

  • Whether or not to display an instruction screen to the user before initiating capture. Default is true.

    Declaration

    Swift

    public var enableInstructionScreen: Bool

  • Document capture rectangle width.

    Declaration

    Swift

    public var documentCaptureFrameWidth: Float?

  • Document capture rectangle height.

    Declaration

    Swift

    public var documentCaptureFrameHeight: Float?

  • Maximum additional document file size, in MB. Default is 2 MB.

    Declaration

    Swift

    public var documentFileSizeLimit: Float