ID Capture

Defined in framework ScanditIdCapture

SDCIdCaptureErrorCode

Added in version 6.5.0

SDCIdCaptureErrorCodeUndefined

Added in version 6.5.0

Undefined error.

SDCIdCaptureErrorCodeInitializationError

Added in version 6.5.0

IdCapture Initialization error.

SDCIdCaptureErrorCodeParsingError

Added in version 6.5.0

Parsing document fields failed.

SDCIdCapture

@interface SDCIdCapture : NSObject <SDCDataCaptureMode>

Added in version 6.2.0

+ idCaptureWithContext:settings:

+ (instancetype)idCaptureWithContext:(nullable SDCDataCaptureContext *)context
                            settings:(nonnull SDCIdCaptureSettings *)settings

Added in version 6.2.0

Constructs a new SDCIdCapture with the provided settings. When dataCaptureContext is not nil, the mode is automatically added to it.

+ idCaptureFromJSONString:context:error:

+ (nullable instancetype)idCaptureFromJSONString:(nonnull NSString *)JSONString
                                         context:(nonnull SDCDataCaptureContext *)context
                                           error:(NSError **)error

Added in version 6.6.0

Constructs a new SDCIdCapture with the provided JSON serialization. See Serialization for details. The capture mode is automatically added to the context.

enabled

@property (nonatomic, assign, getter=isEnabled) BOOL enabled

Added in version 6.2.0

Implemented from SDCDataCaptureMode. See SDCDataCaptureMode.enabled.

- addListener:

- (void)addListener:(nonnull id<SDCIdCaptureListener>)listener

Added in version 6.2.0

Adds the listener to this id capture instance.

In case the same listener is already observing this instance, calling this method will not add the listener again. The listener is stored using a weak reference and must thus be retained by the caller for it to not go out of scope.

- removeListener:

- (void)removeListener:(nonnull id<SDCIdCaptureListener>)listener

Added in version 6.2.0

Removes listener from this id capture instance.

In case the listener is not currently observing this instance, calling this method has no effect.

context

@property (nonatomic, nullable, readonly) SDCDataCaptureContext *context

Added in version 6.2.0

Implemented from SDCDataCaptureMode. See SDCDataCaptureMode.context.

feedback

@property (nonatomic, strong, nonnull) SDCIdCaptureFeedback *feedback

Added in version 6.19.0

Instance of SDCIdCaptureFeedback, determines what feedback (vibration, sound) should be emitted during the ID Capture process.

recommendedCameraSettings

@property (class, nonatomic, nonnull, readonly) SDCCameraSettings *recommendedCameraSettings

Added in version 6.2.0

Creates the recommended camera settings to use with this mode.

- reset

- (void)reset

Added in version 6.6.0

Resets the ongoing scanning process. This method can be used to abandon scanning the back side of a document.

- applySettings:

- (void)applySettings:(nonnull SDCIdCaptureSettings *)settings

Added in version 6.18.0

Asynchronously Applies the new settings to the ID Capture. If the scanner is currently running, the task will complete when the next frame is processed, and will use the new settings for that frame. If the scanner is currently not running, the task will complete as soon as the settings have been stored and won’t wait until the next frame is going to be processed.