ID Capture Mode

Defined under the namespace Scandit.Datacapture.Id

IdCaptureTrigger

Added in version 6.25.0

Note

This feature is still in beta and may change in the future versions of Scandit Data Capture SDK.

Controls the capturing behavior of IdCapture.

Currently, IdCapture operates in one of the following modes: Auto and ButtonTap.

In Auto (default value) enabling the mode automatically starts the capture process. Results are delivered as soon as all the required data can be extracted from a document. In particular, if the document is well-positioned from the very start, the capture may happen instantly. Furthermore data may be extracted even from documents that are partially covered (by hand, glare, etc.) or blurry (because of motion). Therefore this trigger is best suitable for flows and use-cases where (1) there is no need to extract high quality, optimally positioned images of documents, (2) users are instructed beforehand that the capture will happen, so instant extraction doesn’t suprise them. Use overlay to display textual hints and animations that guide the user through the capture process.

When ButtonTap is selected, starting the mode does not automatically trigger the start of the capture process. Instead, in order to extract data from a document, a user needs to tap a button, specifically drawn on the screen for this purpose. Using overlay is required with this trigger. UI hints will instruct the user when the document is well-placed and the data extraction is possible. In SupportedSides.FrontAndBack, after the front side is captured, the mode goes back to “no capture” state and the button needs to be tapped again to capture the back side. This trigger does not prevent capture from documents the are partially covered or blurry, but gives the user a chance to properly position them and cease motion. Therefore it’s more suitable for flows and use-cases where (1) it’s essential to capture high quality, well-placed images of documents, (2) users need a moment to understand that a document is going to be scanned. Note that this trigger does not affect capture from SingleImageUploader, which happens instantly for both triggers.

Auto

Added in version 6.25.0

The capture process starts instantly when IdCapture is enabled.

Note

This feature is still in beta and may change in the future versions of Scandit Data Capture SDK.

ButtonTap

Added in version 6.25.0

The capture process starts once the button is tapped.

Note

This feature is still in beta and may change in the future versions of Scandit Data Capture SDK.