SBSDKUIWorkflowScannerBehaviorConfiguration

@interface SBSDKUIWorkflowScannerBehaviorConfiguration : NSObject

Behavior configuration object for a ‘SBSDKUIWorkflowScannerViewController’.

  • Whether flash is toggled on or off.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isFlashEnabled) BOOL flashEnabled;

    Swift

    var isFlashEnabled: Bool { get set }

  • The scaling factor for captured images. Values are clamped to the range 0.0 - 1.0.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) CGFloat imageScale;

    Swift

    var imageScale: CGFloat { get set }

  • The sensitivity of auto-snapping. Values are clamped to the range 0.0 - 1.0. A value of 1.0 triggers automatic snapping immediately, a value of 0.0 delays the automatic by 3 seconds.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    CGFloat autoSnappingSensitivity;

    Swift

    var autoSnappingSensitivity: CGFloat { get set }

  • The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0. Set lower values to accept more perspective distortion. Warning: Lower values result in more blurred document images.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    double acceptedAngleScore;

    Swift

    var acceptedAngleScore: Double { get set }

  • The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score. Default is 80.0. Warning: Lower values result in low resolution document images.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    double acceptedSizeScore;

    Swift

    var acceptedSizeScore: Double { get set }

  • The video layers content mode.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    SBSDKUIVideoContentMode cameraPreviewMode;

    Swift

    var cameraPreviewMode: SBSDKUIVideoContentMode { get set }

  • The preferred orientation of captured images.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    SBSDKOrientationLock orientationLockMode;

    Swift

    var orientationLockMode: SBSDKOrientationLock { get set }

  • If set to YES, ignores the aspect ratio warning.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL ignoreBadAspectRatio;

    Swift

    var ignoreBadAspectRatio: Bool { get set }

  • Limits the maximum size of the document image. If width or height are zero, this property is effectively ignored. Defaults to CGSizeZero.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    CGSize documentImageSizeLimit;

    Swift

    var documentImageSizeLimit: CGSize { get set }

  • Whether scanner screen should make a sound on successful barcode or MRZ detection.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isSuccessBeepEnabled) BOOL successBeepEnabled;

    Swift

    var isSuccessBeepEnabled: Bool { get set }

  • If set to YES removes any stored images when the user cancels the workflow. Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL cleanupOnCancel;

    Swift

    var cleanupOnCancel: Bool { get set }