Id Capture Feedback

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

IdCaptureFeedback

class IdCaptureFeedback

Added in version 6.19.0

Determines what feedback (vibration, sound) should be emitted during the ID Capture process.

The feedback is specified for each IdCapture instance separately and can be changed through the IdCapture.feedback property by either modifying an existing instance of this class, or by assigning a new one.

defaultFeedback()

fun IdCaptureFeedback.defaultFeedback(): IdCaptureFeedback

Added in version 6.19.0

Returns an id capture feedback with default configuration:

default beep sound is loaded,
beeping for the id captured event is enabled,
vibration for the id captured event is enabled,
beeping for the id rejected event is disabled,
vibration for the id rejected event is disabled,
beeping for the id capture timeout event is disabled,
vibration for the id capture timeout event is disabled.

defaultSuccessSound()

fun IdCaptureFeedback.defaultSuccessSound(): Sound

Added in version 6.19.0

Returns the default success sound

defaultFailureSound()

fun IdCaptureFeedback.defaultFailureSound(): Sound

Added in version 6.19.0

Returns the default failure sound

IdCaptureFeedback()

IdCaptureFeedback()

Added in version 6.19.0

Empty constructor. Constructs a new feedback that will not emit any sound, nor vibration.

idCaptured

var idCaptured: Feedback

Added in version 6.19.0

A feedback that is emitted when IdCaptureListener.onIdCaptured() event is triggered.

idRejected

var idRejected: Feedback

Added in version 6.19.0

A feedback that is emitted when IdCaptureListener.onIdRejected() event is triggered.

toJson()

fun toJson(): String

Added in version 6.21.0

Returns the JSON representation of the feedback.

fromJson(json)

fun IdCaptureFeedback.fromJson(json: JsonValue): IdCaptureFeedback

Added in version 6.21.0

Construct a new id capture feedback with the provided JSON serialization.