Feedback

Defined under the namespace Scandit.Datacapture.Core

Vibration

class Vibration

Added in version 6.8.0

A vibration, to be emitted for example when a code has been successfully scanned.

defaultVibration

static get defaultVibration(): Vibration

Added in version 6.8.0

The default vibration for a successful scan.

selectionHapticFeedback

static get selectionHapticFeedback(): Vibration

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

Only available on iOS.

successHapticFeedback

static get successHapticFeedback(): Vibration

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

Only available on iOS.

impactHapticFeedback

static get impactHapticFeedback(): Vibration

Added in version 6.21.0

It creates haptics to communicate impact. In particular it uses UIImpactFeedbackGenerator. Please note that if the device does not have the Taptic Engine, no vibration will be emitted.

Only available on iOS.

Sound

class Sound

Added in version 6.8.0

A sound, to be played for example when a code has been successfully scanned.

resource

resource: string | null

Added in version 6.8.0

The name of the resource file, including the extension.

On iOS, the file must be added as a resource file, on Android it must be added specifically under app/src/main/assets.

defaultSound()

static get defaultSound(): Sound

Added in version 6.8.0

The default beep sound for a successful scan.

Feedback

class Feedback

Added in version 6.8.0

A feedback consisting of a sound and vibration, for example to be provided by a device when a code has been successfully scanned.

defaultFeedback()

static get defaultFeedback(): Feedback

Added in version 6.8.0

The default feedback consisting of a default sound and a default vibration.

sound

get sound(): Sound | null

Added in version 6.8.0

The sound to be played when a feedback is required. If null, 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-null instance.

vibration

get vibration(): Vibration | null

Added in version 6.8.0

The vibration to be emitted when a feedback is required. If null, 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-null instance.

constructor(vibration, sound)

constructor(vibration: Vibration | null,
        sound: Sound | null)

Added in version 6.8.0

Creates a Feedback that emits the given vibration and plays the given sound.

emit()

emit(): void

Added in version 6.8.0

Emits the feedback defined by this object. This method is further influenced by the device’s ring mode and/or volume settings - check sound and vibration for more details.

WaveFormVibration

class WaveFormVibration : Vibration

Added in version 6.21.0

A wave form vibration, to be emitted for example when a code has been successfully scanned.

constructor(timings, amplitudes)

constructor(timings: number[],
        amplitudes: number[] | null)

Added in version 6.21.0

Creates a new WaveFormVibration object with timings and amplitudes.

amplitudes()

get amplitudes(): number[] | null

Added in version 6.21.0

Returns the amplitudes of the WaveFormVibration.

timings()

get timings(): number[]

Added in version 6.21.0

Returns the timings of the WaveFormVibration.