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

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.

hintsEnabled#
@property (nonatomic, assign) BOOL hintsEnabled

Added in version 6.15.0

Enable/disable additional UI hints to guide the user through the capture process. This is a beta feature and may change in a future release. By default the hints are disabled.

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.