ID Capture

Defined in library scandit_datacapture_id

IdCapture

class IdCapture : DataCaptureMode

Added in version 6.11.0

IdCapture(settings)

 IdCapture(IdCaptureSettings settings)

Added in version 7.6.0

Constructs a new IdCapture with the provided settings.

IdCapture.forContext(context, settings)

IdCapture.forContext(DataCaptureContext context,
        IdCaptureSettings settings)

Added in version 6.11.0

Constructs a new IdCapture with the provided settings.

Deprecated since version 7.6: This static function has been deprecated in favour of the new constructor IdCapture().

isEnabled

bool isEnabled

Added in version 6.11.0

Implemented from DataCaptureMode. See DataCaptureMode.isEnabled.

addListener(listener)

void addListener(IdCaptureListener listener)

Added in version 6.11.0

Adds the listener to this id capture instance.

In case the same listener is already observing this instance, calling this method will not add the listener again.

removeListener(listener)

void removeListener(IdCaptureListener listener)

Added in version 6.11.0

Removes listener from this id capture instance.

In case the listener is not currently observing this instance, calling this method has no effect.

context

DataCaptureContext? get context

Added in version 6.11.0

Implemented from DataCaptureMode. See DataCaptureMode.context.

feedback

IdCaptureFeedback feedback

Added in version 6.22.0

Instance of IdCaptureFeedback, determines what feedback (vibration, sound) should be emitted during the ID Capture process.

createRecommendedCameraSettings()

static CameraSettings createRecommendedCameraSettings()

Added in version 7.6.0

Creates the recommended camera settings to use with this mode.

recommendedCameraSettings

static CameraSettings get recommendedCameraSettings

Added in version 6.11.0

Gets the recommended camera settings to use with this mode.

Deprecated since version 7.6: This static property has been deprecated in favour of createRecommendedCameraSettings().

reset()

Future<void> reset()

Added in version 6.11.0

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

applySettings(settings)

Future<void> applySettings(IdCaptureSettings settings)

Added in version 6.19.0

Asynchronously applies the new settings to the ID Capture. If the scanner is currently running, the task will complete when the next frame is processed, and will use the new settings for that frame. If the scanner is currently not running, the task will complete as soon as the settings have been stored and won’t wait until the next frame is going to be processed.