Enumerations

The following enumerations are available globally.

DSOptions enums

  • An enum that tells the scan handler how to perform the capture.

    Discussion

    Setting this mode changes the behavior of the scan based on the set type. For example a scan type of Manual requries the user or developer to tell the scan handler when to capture the image.

    See more

    Declaration

    Swift

    @objc
public enum DSCaptureMode : Int

  • Used to define how a source image will be obtained during an auto-capture session.

    See more

    Declaration

    Swift

    public enum DSAutoCaptureImageSource : Int

  • An enum representing an ID1 document side.

    See more

    Declaration

    Swift

    @objc
public enum DSSide : Int

  • Provides constants for different ID1 document types (Driver’s License, Passport Card, etc.).

    See more

    Declaration

    Swift

    @objc
public enum DSID1Type : Int

  • The method in which a Machine-Readable Zone should be captured, if at all

    The Machine-Readable Zone appears on travel documents such as passports or passport cards. The MRZ will always be two or three lines and is often placed near the bottom of the document. Example:

    P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<< L898902C<3UTO6908061F9406236ZE184226B<<<<<14

    Important

    For documents without an MRZ, .ignore should be used. When you need the MRZ, use .recognize. When you only need to verify that the MRZ exists, .detect is slightly faster.
    See more

    Declaration

    Swift

    @objc
public enum DSMRZCaptureMethod : Int