SBSDKUIMRZScannerBehaviorConfiguration

@interface SBSDKUIMRZScannerBehaviorConfiguration : NSObject

Configuration for the behavior of the machine readable zone scanner.

  • 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 }

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

    Declaration

    Objective-C

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

    Swift

    var isSuccessBeepEnabled: Bool { get set }

  • The maximum number of results to be accumulated when live-recognizing machine readable zones on sample buffers. This sets the second part of a requiredNumberOfEqualAccumulatedResults-of-maxNumberOfAccumulatedResults selector, e.g. 2 of 4 results must be equal. To make the selector less strict, select a higher value, e.g. 2 of 5 or even 2 of 6. Setting a value lower than requiredNumberOfEqualAccumulatedResults will throw an exception. Values less-than-or-equal to 0, will effectively turn off the result accumulation. The default value is 4.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger maxNumberOfAccumulatedResults;

    Swift

    var maxNumberOfAccumulatedResults: UInt { get set }

  • The minimum number of equal results in the accumulator when live-recognizing machine readable zones on sample buffers. This sets the first part of a requiredNumberOfEqualAccumulatedResults-of-maxNumberOfAccumulatedResults selector, e.g. 2 of 4 results must be equal. To get less false positive results make the selector more strict by selecting a higher value, e.g. 3 of 4 or even 4 of 4. Setting a value higher than maxNumberOfAccumulatedResults will throw an exception. Values less-than-or-equal to 0, will effectively turn off the result accumulation. The default value is 2.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger requiredNumberOfEqualAccumulatedResults;

    Swift

    var requiredNumberOfEqualAccumulatedResults: UInt { get set }

  • Time in seconds until the screen is automatically cancelled. Set to 0 to disable automatic cancellation. Defaults to 0 (disabled).

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval autoCancelTimeout;

    Swift

    var autoCancelTimeout: TimeInterval { get set }