Id Capture Listener#

Defined in namespace Scandit.Datacapture.Id

IIdCaptureListener#
interface IIdCaptureListener

Added in version 6.9.0

Listener interface for id capture.

OnObservationStarted()#
void OnObservationStarted(IdCapture idCapture)

Added in version 6.9.0

Called when the listener starts observing the id capture instance.

OnObservationStopped()#
void OnObservationStopped(IdCapture idCapture)

Added in version 6.9.0

Called when the listener stops observing the id capture instance.

OnIdCaptured()#
void OnIdCaptured(IdCapture capture, IdCaptureSession session, IFrameData frameData)

Added in version 6.9.0

Called whenever a document is recognized and parsed. In this callback IdCaptureSession.NewlyCapturedId is guaranteed to be non-null.

OnIdLocalized()#
void OnIdLocalized(IdCapture capture, IdCaptureSession session, IFrameData 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 IdCaptureSession.NewlyLocalizedOnlyId is guaranteed to be non-null.

OnIdRejected()#
void OnIdRejected(IdCapture capture, IdCaptureSession session, IFrameData 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 IdCaptureSettings.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. In this callback IdCaptureSession.NewlyRejectedId is guaranteed to be non-null.

OnErrorEncountered()#
void OnErrorEncountered(IdCapture capture, Throwable error, IdCaptureSession session, IFrameData frameData)

Added in version 6.9.0

Called whenever an error occurs during the document scanning process.