SBSDKUIFinderDocumentScannerUIConfiguration

@interface SBSDKUIFinderDocumentScannerUIConfiguration : NSObject

Configuration for the user interface of the document scanning screen.

  • Whether the view finder is enabled or not.

    Declaration

    Objective-C

    @property (nonatomic) BOOL finderEnabled;

    Swift

    var finderEnabled: Bool { get set }

  • Foreground color of the detection overlay.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *finderLineColor;

    Swift

    var finderLineColor: UIColor { get set }

  • Width of finder frame border. Default is 2.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat finderLineWidth;

    Swift

    var finderLineWidth: CGFloat { get set }

  • Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. The default value is 1:1.41 which translates to DIN A4 portrait.

    Declaration

    Objective-C

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

    Swift

    var finderAspectRatio: SBSDKAspectRatio { get set }

  • Background color of the top bar.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *topBarBackgroundColor;

    Swift

    var topBarBackgroundColor: UIColor { get set }

  • Foreground color of disabled items in the top bar.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *topBarButtonsInactiveColor;

    Swift

    var topBarButtonsInactiveColor: UIColor { get set }

  • Foreground color of enabled items in the top bar.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *topBarButtonsActiveColor;

    Swift

    var topBarButtonsActiveColor: UIColor { get set }

  • Whether the flash button is hidden or not.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isFlashButtonHidden) BOOL flashButtonHidden;

    Swift

    var isFlashButtonHidden: Bool { get set }

  • Hides the shutter button if set to YES. Shows it otherwise. Defaults to NO. If set to YES, auto-snapping is enabled and the property autoSnappingEnabled of the behavior configuration will have no effect. Also the auto-snapping button will be hidden.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isShutterButtonHidden) BOOL shutterButtonHidden;

    Swift

    var isShutterButtonHidden: Bool { get set }

  • Color of the shutter buttons outer ring in auto-capture mode.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *shutterButtonAutoOuterColor;

    Swift

    var shutterButtonAutoOuterColor: UIColor { get set }

  • Color of the shutter buttons inner ring in auto-capture mode.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *shutterButtonAutoInnerColor;

    Swift

    var shutterButtonAutoInnerColor: UIColor { get set }

  • Color of the shutter buttons outer ring in manual-capture mode.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *shutterButtonManualOuterColor;

    Swift

    var shutterButtonManualOuterColor: UIColor { get set }

  • Color of the shutter buttons inner ring in manual-capture mode.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *shutterButtonManualInnerColor;

    Swift

    var shutterButtonManualInnerColor: UIColor { get set }

  • Color of the shutter buttons activity indicator when capturing an image.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *shutterButtonIndicatorColor;

    Swift

    var shutterButtonIndicatorColor: UIColor { get set }

  • Background color of the camera view. *

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *cameraBackgroundColor;

    Swift

    var cameraBackgroundColor: UIColor { get set }

  • Overlay color of the camera view. *

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *cameraOverlayColor;

    Swift

    var cameraOverlayColor: UIColor { get set }

  • Whether displaying of the polygon is enabled or not. *

    Declaration

    Objective-C

    @property (nonatomic) BOOL polygonEnabled;

    Swift

    var polygonEnabled: Bool { get set }

  • Foreground color of the detected documents polygon, when the polygons quality is acceptable. *

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *polygonColorOK;

    Swift

    var polygonColorOK: UIColor { get set }

  • Foreground color of the detected documents polygon, when the polygons quality is not acceptable. *

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *polygonColor;

    Swift

    var polygonColor: UIColor { get set }

  • Background color of the detected documents polygon, when the polygons quality is acceptable. *

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *polygonBackgroundColorOK;

    Swift

    var polygonBackgroundColorOK: UIColor { get set }

  • Background color of the detected documents polygon, when the polygons quality is not acceptable. *

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *polygonBackgroundColor;

    Swift

    var polygonBackgroundColor: UIColor { get set }

  • Width of the detected documents polygon in points.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat polygonLineWidth;

    Swift

    var polygonLineWidth: CGFloat { get set }

  • The radius to use when drawing rounded corners of the detected documents polygon. Default is 8.0.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat polygonCornerRadius;

    Swift

    var polygonCornerRadius: CGFloat { get set }

  • Background color of the user guidance label.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *userGuidanceBackgroundColor;

    Swift

    var userGuidanceBackgroundColor: UIColor { get set }

  • Foreground/text color of the user guidance label.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *userGuidanceTextColor;

    Swift

    var userGuidanceTextColor: UIColor { get set }

  • Allowed orientations for automatic interface rotations. *

    Declaration

    Objective-C

    @property (nonatomic) SBSDKOrientationLock orientationLockMode;

    Swift

    var orientationLockMode: SBSDKOrientationLock { get set }

  • Stroke color of polygon auto snap progress animation.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) UIColor *autoSnapProgressColor;

    Swift

    var autoSnapProgressColor: UIColor { get set }

  • Line width of polygon auto snap progress animation. Default is 5.0.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat autoSnapProgressLineWidth;

    Swift

    var autoSnapProgressLineWidth: CGFloat { get set }

  • Whether polygon auto snap progress animation is enabled or no. Default is enabled.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isAutoSnapProgressEnabled) BOOL autoSnapProgressEnabled;

    Swift

    var isAutoSnapProgressEnabled: Bool { get set }