Id Capture Feedback

Defined in framework ScanditIdCapture

SDCIdCaptureFeedback
@interface SDCIdCaptureFeedback : 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 SDCIdCapture instance separately and can be changed through the SDCIdCapture.feedback property by either modifying an existing instance of this class, or by assigning a new one.

defaultFeedback
@property (class, nonatomic, readonly) SDCIdCaptureFeedback *defaultFeedback

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
@property (class, nonatomic, readonly) SDCSound *defaultSuccessSound

Added in version 6.19.0

Returns the default success sound

defaultFailureSound
@property (class, nonatomic, readonly) SDCSound *defaultFailureSound

Added in version 6.19.0

Returns the default failure sound

idCaptured
@property (nonatomic, strong, nonnull) SDCFeedback *idCaptured

Added in version 6.19.0

A feedback that is emitted when SDCIdCaptureListener.idCapture:didCaptureInSession:frameData: event is triggered.

idRejected
@property (nonatomic, strong, nonnull) SDCFeedback *idRejected

Added in version 6.19.0

A feedback that is emitted when SDCIdCaptureListener.idCapture:didRejectInSession:frameData: event is triggered.

idCaptureTimeout
@property (nonatomic, strong, nonnull) SDCFeedback *idCaptureTimeout

Added in version 6.19.0

A feedback that is emitted when SDCIdCaptureListener.idCapture:didTimeoutInSession:frameData: event is triggered.

JSONString
@property (nonatomic, nonnull, readonly) NSString *JSONString

Added in version 6.21.0

Returns the JSON representation of the feedback.

+ feedbackFromJSON:error:
+ (nullable instancetype)feedbackFromJSON:(nonnull SDCJSONValue *)JSONValue
                                    error:(NSError **)error

Added in version 6.21.0

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