Id Capture Feedback

Defined in framework ScanditIdCapture

IdCaptureFeedback
open class IdCaptureFeedback : NSObject

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.

`default`
open class var `default`: IdCaptureFeedback { get }

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
open class var defaultSuccessSound: Sound { get }

Added in version 6.19.0

Returns the default success sound

defaultFailureSound
open class var defaultFailureSound: Sound { get }

Added in version 6.19.0

Returns the default failure sound

init
init()

Added in version 6.19.0

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

idCaptured
open var idCaptured: Feedback { get, set }

Added in version 6.19.0

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

idRejected
open var idRejected: Feedback { get, set }

Added in version 6.19.0

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

jsonString
open var jsonString: String { get }

Added in version 6.21.0

Returns the JSON representation of the feedback.

init
convenience init(fromJSON JSONValue: JSONValue) throws

Added in version 6.21.0

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