Id Capture Overlay#

Defined in framework ScanditIdCapture

SDCIdLayoutStyle#

Added in version 6.8.0

The layout style of the SDCIdCaptureOverlay.

SDCIdLayoutStyleRounded#

Added in version 6.8.0

Layout style with rounded corners.

SDCIdLayoutStyleSquare#

Added in version 6.8.0

Layout style with square corners.

SDCIdLayoutLineStyle#

Added in version 6.8.0

The style of the lines drawn as part of the SDCIdLayout.

SDCIdLayoutLineStyleBold#

Added in version 6.8.0

Draws lines with a width of 5 dips/points.

SDCIdLayoutLineStyleLight#

Added in version 6.8.0

Draws lines with a width of 3 dips/points.

SDCIdCaptureOverlay#
@interface SDCIdCaptureOverlay : NSObject <SDCDataCaptureOverlay>

Added in version 6.6.0

Overlay for the SDCIdCapture capture mode that displays viewfinders based on scanned document type on top of a data capture view.

+ overlayWithIdCapture:forDataCaptureView:#
+ (instancetype)overlayWithIdCapture:(nonnull SDCIdCapture *)idCapture
                  forDataCaptureView:(nullable SDCDataCaptureView *)view

Added in version 6.6.0

Constructs a new id capture overlay for the provided id capture instance. When passing a non-nil view instance, the overlay is automatically added to the view.

+ overlayWithIdCapture:
+ (instancetype)overlayWithIdCapture:(nonnull SDCIdCapture *)idCapture

Added in version 6.6.0

Constructs a new id capture overlay for the provided id capture instance. For the overlay to be displayed on screen, it must be added to a SDCDataCaptureView.

- setIdLayout:#
- (void)setIdLayout:(SDCIdLayout)idLayout

Added in version 6.6.0

Sets the kind of UI displayed to assist a user in scanning specific types of personal identification documents.

idLayoutStyle#
@property (nonatomic, assign) SDCIdLayoutStyle idLayoutStyle

Added in version 6.8.0

The ID layout style of the overlay. By default this is SDCIdLayoutStyleRounded.

idLayoutLineStyle#
@property (nonatomic, assign) SDCIdLayoutLineStyle idLayoutLineStyle

Added in version 6.8.0

The ID layout line style. By default this is SDCIdLayoutLineStyleLight.

NSStringFromIdLayoutStyle(style)#
NSString *_Nonnull NSStringFromIdLayoutStyle(SDCIdLayoutStyle style)

Added in version 6.8.0

Serialize the layout style in a JSON string.

SDCIdLayoutStyleFromJSONString(JSONString, style)#
BOOL SDCIdLayoutStyleFromJSONString(NSString *_Nonnull JSONString, SDCIdLayoutStyle *_Nonnull style)

Added in version 6.8.0

Deserialize the layout style from a JSON string.

NSStringFromIdLayoutLineStyle(style)#
NSString *_Nonnull NSStringFromIdLayoutLineStyle(SDCIdLayoutLineStyle style)

Added in version 6.8.0

Serialize the layout line style in a JSON string.

SDCIdLayoutLineStyleFromJSONString(JSONString, style)#
BOOL SDCIdLayoutLineStyleFromJSONString(NSString *_Nonnull JSONString, SDCIdLayoutLineStyle *_Nonnull style)

Added in version 6.8.0

Deserialize the layout line style from a JSON string.