ID Capture Listener

Defined in framework ScanditIdCapture

SDCIdCaptureListener

@protocol SDCIdCaptureListener <NSObject>

Added in version 6.2.0

Delegate protocol for id capture.

- didStartObservingIdCapture:

- (void)didStartObservingIdCapture:(SDCIdCapture *)idCapture

Added in version 6.2.0

Called when the listener starts observing the id capture instance.

- didStopObservingIdCapture:

- (void)didStopObservingIdCapture:(SDCIdCapture *)idCapture

Added in version 6.2.0

Called when the listener stops observing the id capture instance.

- idCapture:didCaptureInSession:frameData:

- (void)idCapture:(SDCIdCapture *)idCapture
didCaptureInSession:(SDCIdCaptureSession *)session
        frameData:(id<SDCFrameData>)frameData

Added in version 6.2.0

Called whenever a document is recognized and parsed. In this callback SDCIdCaptureSession.newlyCapturedId is guaranteed to be non-nil.

- idCapture:didLocalizeInSession:frameData:

- (void)idCapture:(SDCIdCapture *)idCapture
didLocalizeInSession:(SDCIdCaptureSession *)session
        frameData:(id<SDCFrameData>)frameData

Added in version 6.10.0

Called whenever a personal identification document or its part is localized within a frame. A document or its part is considered localized when it’s detected in a frame, but its data is not yet extracted. In this callback SDCIdCaptureSession.newlyLocalizedOnlyId is guaranteed to be non-nil.

- idCapture:didRejectInSession:frameData:

- (void)idCapture:(SDCIdCapture *)idCapture
didRejectInSession:(SDCIdCaptureSession *)session
        frameData:(id<SDCFrameData>)frameData

Added in version 6.10.0

Called whenever a personal identification document or its part is recognized in a frame, but rejected. A document is rejected if (a) it’s not enabled in the settings (see SDCIdCaptureSettings.supportedDocuments), (b) it’s a barcode of a correct symbology or a Machine Readable Zone (MRZ), but the data is encoded in an unexpected/incorrect format, (c) it’s a voided document and “IdCaptureSession.RejectVoidedIds” is enabled. In this callback SDCIdCaptureSession.newlyRejectedId is guaranteed to be non-nil.

- idCapture:didFailWithError:session:frameData:

- (void)idCapture:(SDCIdCapture *)idCapture
 didFailWithError:(NSError *)error
          session:(SDCIdCaptureSession *)session
        frameData:(id<SDCFrameData>)frameData

Added in version 6.5.0

Called whenever an error occurs during the document scanning process. For possible error codes see SDCIdCaptureErrorCode

Deprecated since version 6.18.0: This method is no longer executed by the listener. See idCapture:didRejectInSession:frameData: and idCapture:didTimeoutInSession:frameData: for scenarios previously reported by this callback.

- idCapture:didTimeoutInSession:frameData:

- (void)idCapture:(SDCIdCapture *)idCapture
didTimeoutInSession:(SDCIdCaptureSession *)session
        frameData:(id<SDCFrameData>)frameData

Added in version 6.16.0

Called whenever a document is localized, but could not be captured within a period of time. This can happen, for example, when the document contains defects preventing a successful scan or when the document is not supported by Scandit DataCapture.