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.

SDCTextHintPosition

Added in version 6.22.0

Sets the position of the textual hints.

SDCTextHintPositionAboveViewfinder

Added in version 6.22.0

Places the text hint above viewfinder.

SDCTextHintPositionBelowViewfinder

Added in version 6.22.0

Places the text hint below viewfinder.

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 that guides the user through the SDCIdCapture process.

In order to display this overlay, add it to data capture view.

This overlay shows a viewfinder, automatically selected based on SDCIdCaptureSettings.supportedDocuments and SDCIdCaptureSettings.supportedSides, along with animations and textual hints, that allow the user to capture smoothly and avoid common pitfalls. It is designed to work out-of-the-box for a wide range of use-cases.

You can tweak the look of the viewfinder by setting idLayoutStyle and idLayoutLineStyle. Additionally you can configure the brush used to highlight localized, captured, or rejected documents.

You can translate the texts used by the viewfinder into various languages by adding adding string resources with the following ids to your app:

Resource id	Comment
scandit_id_capture_camera_too_far	Document cannot be captured, because the camera is too far.
scandit_id_capture_document_partially_visible	Document cannot be captured, because it’s only partially visible - either covered or not fully fitting the frame of the camera.
scandit_id_capture_show_document	Ask the user to show a document, front of card capture scenario or multiple document types selected.
scandit_id_capture_show_passport	Ask the user to show the passport.
scandit_id_capture_show_front_of_document	Ask the user to show the front side of a document in the front & back capture scenario.
scandit_id_capture_show_back_of_document	Ask the user to show the back side of a document in the front & back capture scenario.
scandit_id_capture_show_barcode_on_document	Ask the user to show the barcode on a document, either when a barcode type is selected or the back side of a document in the front & back capture scenario contains only a barcode.
scandit_id_capture_show_visa	Ask the user to show the visa.

The default texts can also be replaced with custom messages by calling setFrontSideTextHint: and setBackSideTextHint:. setFrontSideTextHint: replaces texts displayed asking the user for the front side of a document, in the front & back capture scenario, but also when only a single side or a part of a document is being captured. setBackSideTextHint: replaces texts displayed asking the user for the back side of the document in the front & back capture scenario. These methods take precedence over the texts set using string resources.

+ 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 defaultIdLayoutStyle.

textHintPosition

@property (nonatomic, assign) SDCTextHintPosition textHintPosition

Added in version 6.22.0

The text hint position of the overlay. By default this is SDCTextHintPositionAboveViewfinder.

showTextHints

@property (nonatomic, assign) BOOL showTextHints

Added in version 6.22.0

Indicates whether text hints are shown or not. True by default.

idLayoutLineStyle

@property (nonatomic, assign) SDCIdLayoutLineStyle idLayoutLineStyle

Added in version 6.8.0

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

capturedBrush

@property (nonatomic, strong, nonnull) SDCBrush *capturedBrush

Added in version 6.10.0

The brush used to draw rectangular highlights around captured personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). By default it equals defaultCapturedBrush.

To disable highlights use SDCBrush.transparentBrush.

localizedBrush

@property (nonatomic, strong, nonnull) SDCBrush *localizedBrush

Added in version 6.10.0

The brush used to draw rectangular highlights around localized personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). A document or its part is considered localized when it’s detected in a frame, but its data is not yet extracted. By default it equals defaultLocalizedBrush.

To disable highlights use SDCBrush.transparentBrush.

rejectedBrush

@property (nonatomic, strong, nonnull) SDCBrush *rejectedBrush

Added in version 6.10.0

The brush used to draw rectangular highlights around personal identification documents or their parts (such as barcodes), which were detected in a frame but rejected. For example, data encoded in a barcode may have an unsupported format. By default it equals defaultRejectedBrush.

To disable highlights use SDCBrush.transparentBrush.

defaultCapturedBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultCapturedBrush

Added in version 6.10.0

The default brush used to draw rectangular highlights around captured personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). By default, the stroke of a highlight is 3dp white and the fill is transparent.

defaultLocalizedBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultLocalizedBrush

Added in version 6.10.0

The default brush used to draw rectangular highlights around localized personal identification documents or their parts such as barcodes or Machine Readable Zones (MRZs). A document or its part is considered localized when it’s detected in a frame, but its data is not yet extracted. By default, the fill of the highlight is white (alpha 50%) and the border is transparent.

defaultRejectedBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultRejectedBrush

Added in version 6.10.0

The default brush used to draw rectangular highlights around personal identification documents or their parts (such as barcodes), which were detected in a frame, but rejected. For example, data encoded in a barcode may have an unsupported format. By default, the fill of the highlight is white (alpha 50%) and the border is transparent.

defaultIdLayoutStyle

@property (class, nonatomic, readonly) SDCIdLayoutStyle defaultIdLayoutStyle

Added in version 6.14.0

Returns the default value for the ID layout style of the overlay.

defaultIdLayoutLineStyle

@property (class, nonatomic, readonly) SDCIdLayoutLineStyle defaultIdLayoutLineStyle

Added in version 6.14.0

Returns the default value for the ID layout line style of the overlay.

defaultIdLayout

@property (class, nonatomic, readonly) SDCIdLayout defaultIdLayout

Added in version 6.14.0

Returns the default value for the ID layout of the overlay.

- setFrontSideTextHint:

- (void)setFrontSideTextHint:(nonnull NSString *)text

Added in version 6.17.0

Sets text for textual hint displayed when scanning the front of document.

- setBackSideTextHint:

- (void)setBackSideTextHint:(nonnull NSString *)text

Added in version 6.17.0

Sets text for textual hint displayed when scanning the back of document.

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.