ID Capture Listener#
Defined in package com.scandit.datacapture.id.capture
-
IdCaptureListener
# interface IdCaptureListener
Added in version 6.2.0
Listener interface for id capture.
-
onObservationStarted(idCapture)
# void
onObservationStarted
(@NonNull IdCapture idCapture)Added in version 6.2.0
Called when the listener starts observing the id capture instance.
-
onObservationStopped(idCapture)
# void
onObservationStopped
(@NonNull IdCapture idCapture)Added in version 6.2.0
Called when the listener stops observing the id capture instance.
-
onIdCaptured(capture, session, frameData)
# void
onIdCaptured
(@NonNull IdCapture capture, @NonNull IdCaptureSession session, @NonNull FrameData frameData)Added in version 6.2.0
Called whenever a document is recognized and parsed. In this callback IdCaptureSession.newlyCapturedId is guaranteed to be non-null.
-
onIdLocalized(capture, session, frameData)
# void
onIdLocalized
(@NonNull IdCapture capture, @NonNull IdCaptureSession session, @NonNull FrameData 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(capture, session, frameData)
# void
onIdRejected
(@NonNull IdCapture capture, @NonNull IdCaptureSession session, @NonNull FrameData 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(capture, error, session, frameData)
# void
onErrorEncountered
(@NonNull IdCapture capture, @NonNull Throwable error, @NonNull IdCaptureSession session, FrameData frameData)Added in version 6.5.0
Called whenever an error occurs during the document scanning process.
-