ID Capture Listener

Defined in namespace Scandit.DataCapture.ID.Capture

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.

Deprecated since version 6.18.0: This method is no longer executed by the listener. See OnIdRejected() and OnIdCaptureTimedOut() for scenarios previously reported by this callback.

OnIdCaptureTimedOut()

void OnIdCaptureTimedOut(IdCapture capture, IdCaptureSession session, IFrameData 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.

IdCaptureEventArgs

class IdCaptureEventArgs : EventArgs

Added in version 6.12.0

Provides data for IdCapture.IdCaptured and IdCapture.IdLocalized and IdCapture.IdRejected events.

IdCaptureEventArgs()

IdCaptureEventArgs(IdCapture idCapture, IdCaptureSession session, IFrameData frameData)

Added in version 6.12.0

IdCapture

IdCapture IdCapture { get; }

Added in version 6.12.0

Session

IdCaptureSession Session { get; }

Added in version 6.12.0

FrameData

IFrameData FrameData { get; }

Added in version 6.12.0

IdCaptureErrorEventArgs

class IdCaptureErrorEventArgs : EventArgs

Added in version 6.12.0

Provides data for IdCapture.ErrorEncountered event.

IdCaptureErrorEventArgs()

IdCaptureErrorEventArgs(IdCapture idCapture, Throwable error, IdCaptureSession session, IFrameData frameData)

Added in version 6.12.0

IdCapture

IdCapture IdCapture { get; }

Added in version 6.12.0

Error

Throwable Error { get; }

Added in version 6.12.0

Session

IdCaptureSession Session { get; }

Added in version 6.12.0

FrameData

IFrameData FrameData { get; }

Added in version 6.12.0