SBSDKUICheckRecognizerBehaviorConfiguration

@interface SBSDKUICheckRecognizerBehaviorConfiguration : NSObject

Configuration for the behavior of the check scanner.

  • Whether flash is toggled on or off. The default value is NO.

    Declaration

    Objective-C

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

    Swift

    var isFlashEnabled: Bool { get set }

  • If set to YES a high-resolution photo of the check is captured to run the recognition on. Upon successful recognition the recognition result also contains a high-resolution image of the check. If set to NO, the video frames will be used for recognition and result image delivery. The default value is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL captureHighResolutionImage;

    Swift

    var captureHighResolutionImage: Bool { get set }

  • An array of accepted check types. By default all check types are allowed.

    Declaration

    Objective-C

    @property (nonatomic, copy, nonnull) NSArray<SBSDKCheckDocumentRootType *> *acceptedCheckStandards;

    Swift

    var acceptedCheckStandards: [SBSDKCheckDocumentRootType] { get set }

  • The aspect ratio of the view finder. Set to nil, if no finder should be used. The default value is 8.5 x 4.5.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) SBSDKAspectRatio *finderAspectRatio;

    Swift

    var finderAspectRatio: SBSDKAspectRatio? { get set }