ID Capture

Defined in package com.scandit.datacapture.id.capture

IdCapture

class IdCapture : DataCaptureMode

Added in version 6.2.0

forDataCaptureContext(dataCaptureContext, settings)

static @NonNull IdCapture forDataCaptureContext(@Nullable DataCaptureContext dataCaptureContext,
        @NonNull IdCaptureSettings settings)

Added in version 6.2.0

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

fromJson(dataCaptureContext, jsonData)

static @NonNull IdCapture fromJson(@NonNull DataCaptureContext dataCaptureContext,
        @NonNull String jsonData)

Added in version 6.6.0

Constructs a new IdCapture with the provided JSON serialization. See Serialization for details. The capture mode is automatically added to the context.

isEnabled

boolean isEnabled()
void setEnabled(boolean value)

Added in version 6.2.0

Implemented from DataCaptureMode. See DataCaptureMode.isEnabled.

addListener(listener)

void addListener(@NonNull IdCaptureListener listener)

Added in version 6.2.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(@NonNull IdCaptureListener listener)

Added in version 6.2.0

Removes listener from this id capture instance.

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

dataCaptureContext

@Nullable DataCaptureContext getDataCaptureContext()

Added in version 6.2.0

Implemented from DataCaptureMode. See DataCaptureMode.dataCaptureContext.

feedback

@NonNull IdCaptureFeedback getFeedback()
void setFeedback(@NonNull IdCaptureFeedback value)

Added in version 6.19.0

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

createRecommendedCameraSettings()

static @NonNull CameraSettings createRecommendedCameraSettings()

Added in version 6.2.0

Creates the recommended camera settings to use with this mode.

reset()

void reset()

Added in version 6.6.0

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

applySettings(settings)

void applySettings(@NonNull IdCaptureSettings settings)

Added in version 6.18.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.