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.

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

Added in version 6.2.0

Removes listener from this id capture instance.

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

Added in version 6.2.0

Implemented from SDCDataCaptureMode. See SDCDataCaptureMode.context.

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.