ID Capture#

Defined in namespace Scandit.DataCapture.ID.Capture

IdCaptureErrorCode#

Added in version 6.9.0

Undefined#

Added in version 6.9.0

Undefined error.

InitializationError#

Added in version 6.9.0

IdCapture Initialization error.

ParsingError#

Added in version 6.9.0

Parsing document fields failed.

IdCapture#
class IdCapture : IDataCaptureMode

Added in version 6.9.0

Create()#
static IdCapture Create(DataCaptureContext dataCaptureContext, IdCaptureSettings settings)

Added in version 6.9.0

Constructs a new IdCapture with the provided settings. When dataCaptureContext is not null, the mode is automatically added to it.

Enabled#
bool Enabled { get;set; }

Added in version 6.9.0

Implemented from IDataCaptureMode. See IDataCaptureMode.Enabled.

AddListener()#
void AddListener(IIdCaptureListener listener)

Added in version 6.9.0

Adds the listener to this id capture instance.

RemoveListener()#
void RemoveListener(IIdCaptureListener listener)

Added in version 6.9.0

Removes listener from this id capture instance.

Context#
DataCaptureContext Context { get; }

Added in version 6.9.0

Implemented from IDataCaptureMode. See IDataCaptureMode.Context.

RecommendedCameraSettings#
static CameraSettings RecommendedCameraSettings { get; }

Added in version 6.9.0

Gets the recommended camera settings to use with this mode.

Reset()#
void Reset()

Added in version 6.9.0

Resets the ongoing scanning process. This method can be used to abandon scanning the back side of a document.

IdCaptured#
event EventHandler<IdCaptureEventArgs> IdCaptured

Added in version 6.12.0

Occurs when a document is recognized and parsed. In this event IdCaptureSession.NewlyCapturedId is guaranteed to be non-null.

IdLocalized#
event EventHandler<IdCaptureEventArgs> IdLocalized

Added in version 6.12.0

Occurs when 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 event IdCaptureSession.NewlyLocalizedOnlyId is guaranteed to be non-null.

IdRejected#
event EventHandler<IdCaptureEventArgs> IdRejected

Added in version 6.12.0

Occurs when 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 event IdCaptureSession.NewlyRejectedId is guaranteed to be non-null.

ErrorEncountered#
event EventHandler<IdCaptureErrorEventArgs> ErrorEncountered

Added in version 6.12.0

Occurs when an error occurs during the document scanning process. For possible error codes see IdCaptureErrorCode