ID Capture Listener
Defined in library scandit_datacapture_id
- IdCaptureListener
abstract class IdCaptureListener
Added in version 6.11.0
Listener interface for id capture.
- didCaptureId(idCapture, session)
void
didCaptureId(IdCapture idCapture, IdCaptureSession session)Added in version 6.11.0
Called whenever a document is recognized and parsed. In this callback IdCaptureSession.newlyCapturedId is guaranteed to be non-null.
- didLocalizeId(idCapture, session)
void
didLocalizeId(IdCapture idCapture, IdCaptureSession session)Added in version 6.11.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.
- didRejectId(idCapture, session)
void
didRejectId(IdCapture idCapture, IdCaptureSession session)Added in version 6.11.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, (c) it’s a voided document and “IdCaptureSession.RejectVoidedIds” is enabled. In this callback IdCaptureSession.newlyRejectedId is guaranteed to be non-null.
- didFailWithError(idCapture, error, session)
void
didFailWithError(IdCapture idCapture, IdCaptureError error, IdCaptureSession session)Added in version 6.11.0
Called whenever an error occurs during the document scanning process.
- didTimedOut(idCapture, session, getFrameData)
void
didTimedOut(IdCapture idCapture, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.19.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.
ID Capture Advanced Listener
Defined in library scandit_datacapture_id
- IdCaptureAdvancedListener
abstract class IdCaptureAdvancedListener
Added in version 6.14.0
Listener interface for id capture.
- didCaptureId(idCapture, session, getFrameData)
void
didCaptureId(IdCapture idCapture, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.14.0
Called whenever a document is recognized and parsed. In this callback IdCaptureSession.newlyCapturedId is guaranteed to be non-null.
- didLocalizeId(idCapture, session, getFrameData)
void
didLocalizeId(IdCapture idCapture, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.14.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.
- didRejectId(idCapture, session, getFrameData)
void
didRejectId(IdCapture idCapture, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.14.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.
- didFailWithError(idCapture, error, session, getFrameData)
void
didFailWithError(IdCapture idCapture, IdCaptureError error, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.14.0
Called whenever an error occurs during the document scanning process.
- didTimedOut(idCapture, session, getFrameData)
void
didTimedOut(IdCapture idCapture, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.19.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.
ID Capture Advanced Async Listener
Defined in library scandit_datacapture_id
- IdCaptureAdvancedAsyncListener
abstract class IdCaptureAdvancedAsyncListener
Added in version 6.18.2
Listener interface for id capture.
- didCaptureId(idCapture, session, getFrameData)
Future<
void
> didCaptureId(IdCapture idCapture, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.18.2
Called whenever a document is recognized and parsed. In this callback IdCaptureSession.newlyCapturedId is guaranteed to be non-null.
- didLocalizeId(idCapture, session, getFrameData)
Future<
void
> didLocalizeId(IdCapture idCapture, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.18.2
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.
- didRejectId(idCapture, session, getFrameData)
Future<
void
> didRejectId(IdCapture idCapture, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.18.2
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.
- didTimedOut(idCapture, session, getFrameData)
Future<
void
> didTimedOut(IdCapture idCapture, IdCaptureSession session, Future<FrameData> getFrameData())Added in version 6.19.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.