ID Capture

Defined under the namespace Scandit.Datacapture.Id

IdCapture

class IdCapture : DataCaptureMode

Added in version 6.6.0

forContext(context, settings)

static forContext(context: DataCaptureContext | null,
        settings: IdCaptureSettings): IdCapture

Added in version 6.6.0

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

isEnabled

isEnabled: boolean

Added in version 6.6.0

Implemented from DataCaptureMode. See DataCaptureMode.isEnabled.

addListener(listener)

addListener(listener: IdCaptureListener): void

Added in version 6.6.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)

removeListener(listener: IdCaptureListener): void

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

get context(): DataCaptureContext | null

Added in version 6.6.0

Implemented from DataCaptureMode. See DataCaptureMode.context.

feedback

feedback: IdCaptureFeedback

Added in version 6.22.0

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

recommendedCameraSettings()

static get recommendedCameraSettings(): CameraSettings

Added in version 6.6.0

Creates the recommended camera settings to use with this mode.

reset()

reset(): Promise<void>

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)

applySettings(settings: IdCaptureSettings): Promise<void>

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