Feedback
Defined in package com.scandit.datacapture.core.feedback
- Vibration
class Vibration
Added in version 6.0.0
A vibration, to be emitted for example when a code has been successfully scanned.
- Vibration()
Vibration()
Added in version 6.0.0
Creates a new Vibration object.
- defaultVibration()
static @NonNull Vibration defaultVibration()
Added in version 6.0.0
The default vibration for a successful scan.
The duration of vibration is set to 300 milliseconds.
- duration
@NonNull TimeInterval getDuration()
void
setDuration(@NonNull TimeInterval value)Added in version 6.1.0
The duration of the vibration.
- amplitude
int
getAmplitude()void
setAmplitude(int
value)Added in version 6.15.0
The strength of the vibration. This must be a value between 1 and 255, or VibrationEffect.DEFAULT_AMPLITUDE. This property is used only on Android SDK API level 26 or above. Some values might require higher level of the Android SDK API. See VibrationEffect for details.
- toJson()
@NonNull String toJson()
Added in version 6.10.0
Returns the JSON representation of the vibration.
- equals(other)
boolean
equals(@Nullable Object other)Added in version 6.9.0
Indicates whether some other object is equal to this one.
- hashCode()
int
hashCode()Added in version 6.9.0
Returns a hash code value for the object.
- Sound
abstract class Sound
Added in version 7.0.0
A sound, to be played for example when a code has been successfully scanned.
- AssetSound
class AssetSound : Sound
Added in version 6.8.0
- toJson()
@NonNull String toJson()
Added in version 7.0.0
Returns the JSON representation of the feedback.
- equals(other)
boolean
equals(@Nullable Object other)Added in version 7.0.0
Indicates whether some other object is equal to this one.
- hashCode()
int
hashCode()Added in version 7.0.0
Returns a hash code value for the object.
- ResourceSound
class ResourceSound : Sound
Added in version 6.8.0
A sound created with a raw resource, to be played for example when a code has been successfully scanned.
- ResourceSound()
ResourceSound(
int
resourceId)Added in version 6.8.0
Creates a new ResourceSound object for the given raw resource.
- resourceId
int
getResourceId()Added in version 6.0.0
Id of the sound resource.
- toJson()
@NonNull String toJson()
Added in version 7.0.0
Returns the JSON representation of the feedback.
- equals(other)
boolean
equals(@Nullable Object other)Added in version 7.0.0
Indicates whether some other object is equal to this one.
- hashCode()
int
hashCode()Added in version 7.0.0
Returns a hash code value for the object.
- Feedback
class Feedback
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.
- fromJson(json)
static @NonNull Feedback fromJson(@NonNull String json)
Added in version 6.3.0
Constructs a new feedback with the provided JSON serialization.
- defaultFeedback()
static @NonNull Feedback defaultFeedback()
Added in version 6.0.0
The default feedback consisting of a default sound and a default vibration.
- sound
@Nullable Sound getSound()
Added in version 6.0.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
@Nullable Vibration getVibration()
Added in version 6.0.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.
- Feedback()
Feedback()
Added in version 6.0.0
Creates a Feedback that emits no vibration and plays no sound.
- Feedback()
Feedback(@Nullable Vibration vibration)
Added in version 6.0.0
Creates a Feedback that emits the given vibration, but plays no sound.
- Feedback()
Feedback(@Nullable Sound sound)
Added in version 6.1.0
Creates a Feedback that plays the given sound, but emits no vibration.
- Feedback()
Feedback(@Nullable Vibration vibration, @Nullable Sound sound)
Added in version 6.0.0
Creates a Feedback that emits the given vibration and plays the given sound.
- emit()
void
emit()Added in version 6.0.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.
- release()
void
release()Added in version 6.0.0
Frees the resources associated with this feedback instance. This is only required when you are using the feedback instance without a capture mode. When the instance gets used by a capture mode, the resources will automatically be freed when they are no longer required.
- toJson()
@NonNull String toJson()
Added in version 6.10.0
Returns the JSON representation of the feedback.
- equals(other)
boolean
equals(@Nullable Object other)Added in version 6.9.0
Indicates whether some other object is equal to this one.
- hashCode()
int
hashCode()Added in version 6.9.0
Returns a hash code value for the object.
- WaveFormVibration
class WaveFormVibration : Vibration
Added in version 6.16.0
A wave form vibration, to be emitted for example when a code has been successfully scanned.
This form of vibration will only be used on Android SDK API level 26 or above. See VibrationEffect::createWaveForm for details.
If this is used on Android SDK API level 25 or below, it is replaced with simple vibration with duration.
- WaveFormVibration()
WaveFormVibration(
long
[] timings)Added in version 6.16.0
Creates a new WaveFormVibration object with timings.
- WaveFormVibration()
WaveFormVibration(
long
[] timings, @Nullable Integer[] amplitudes)Added in version 6.16.0
Creates a new WaveFormVibration object with timings and amplitudes.
- getAmplitudes()
@Nullable Integer[] getAmplitudes()
Added in version 6.16.0
Returns the amplitudes of the WaveFormVibration.
- getTimings()
long
[] getTimings()Added in version 6.16.0
Returns the timings of the WaveFormVibration.
- toJson()
@NonNull String toJson()
Added in version 6.16.0
Returns the JSON representation of the vibration.
- equals(other)
boolean
equals(@Nullable Object other)Added in version 6.16.0
Indicates whether some other object is equal to this one.
- hashCode()
int
hashCode()Added in version 6.16.0
Returns a hash code value for the object.