Feedback
Defined in framework ScanditCaptureCore
- Vibration
open class Vibration : NSObject
Added in version 6.0.0
A vibration, to be emitted for example when a code has been successfully scanned.
- `default`
open class var `default`: Vibration { get }
Added in version 6.0.0
The default vibration for a successful scan.
- selectionHapticFeedback
open class var selectionHapticFeedback: Vibration { get }
Added in version 6.7.0
It creates haptics to indicate a change in selection. In particular it uses UISelectionFeedbackGenerator. Please note that if the device does not have the Taptic Engine, no vibration will be emitted.
- successHapticFeedback
open class var successHapticFeedback: Vibration { get }
Added in version 6.7.0
It creates haptics to communicate successes. This is a notification feedback type, indicating that a task has completed successfully. In particular it uses UINotificationFeedbackGenerator with type UINotificationFeedbackTypeSuccess. Please note that if the device does not have the Taptic Engine, no vibration will be emitted.
- failureHapticFeedback
open class var failureHapticFeedback: Vibration { get }
Added in version 6.14.0
It creates haptics to communicate failures. This is a notification feedback type, indicating that a task has failed. In particular it uses UINotificationFeedbackGenerator with type UINotificationFeedbackTypeError. Please note that if the device does not have the Taptic Engine, no vibration will be emitted.
- Sound
open class Sound : NSObject
Added in version 6.0.0
A sound, to be played for example when a code has been successfully scanned.
- init
convenience init?(resourceName: String)
Added in version 6.7.0
Creates a new Sound for the given resource name. The resource should be placed in the main application bundle.
- Feedback
open class Feedback : NSObject
Added in version 6.0.0
A feedback consisting of a sound and vibration, for example to be provided by a device when a code has been successfully scanned.
- init
convenience init(fromJSONString JSONString: String) throws
Added in version 6.3.0
Constructs a new feedback with the provided JSON serialization.
- `default`
open class var `default`: Feedback { get }
Added in version 6.0.0
The default feedback consisting of a default sound and a default vibration.
- sound
open var sound: Sound? { get }
Added in version 6.0.0
The sound to be played when a feedback is required. If nil, no sound is played. Depending on the device’s ring mode and/or volume settings, no sound may be played even if this property is properly set to a non-nil instance.
- vibration
open var vibration: Vibration? { get }
Added in version 6.0.0
The vibration to be emitted when a feedback is required. If nil, no vibration is emitted. This property is further influenced by the device’s ring mode: the device may not vibrate even if this property is properly set to a non-nil instance.
- init
convenience init()
Added in version 6.0.0
Creates a Feedback that emits no vibration and plays no sound.
- init
init(vibration: Vibration?, sound: Sound?)
Added in version 6.0.0
Creates a Feedback that emits the given vibration and plays the given sound.
- WaveFormVibration
open class WaveFormVibration : Vibration
Added in version 6.17.0
A wave form vibration, to be emitted for example when a code has been successfully scanned.
The
timingsarray must be non-empty. Ifamplitudesis provided, it must contain the same number of elements astimings.- init
convenience init(timings: Array<TimeInterval>)
Added in version 6.17.0
Creates a new WaveFormVibration object with timings.
- init
convenience init(timings: Array<TimeInterval>, amplitudes: Array<
Float>?)Added in version 6.17.0
Creates a new WaveFormVibration object with timings and amplitudes.
- amplitudes
var amplitudes: Array<
Float>? { get }Added in version 6.17.0
Returns the amplitudes of the WaveFormVibration.
- timings
var timings: Array<TimeInterval> { get }
Added in version 6.17.0
Returns the timings of the WaveFormVibration.