Feedback

Defined in namespace Scandit.DataCapture.Core.Common.Feedback

Vibration
class Vibration

Added in version 6.2.0

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

Vibration()
Vibration()

Added in version 6.2.0

Creates a new Vibration object.

DefaultVibration
static Vibration DefaultVibration { get; }

Added in version 6.2.0

The default vibration for a successful scan.

The duration of vibration is set to 300 milliseconds.

Duration
TimeSpan Duration { get; }

Added in version 6.2.0

The duration of the vibration.

VibrateTime
TimeSpan VibrateTime { get; }

Added in version 6.2.0

The duration of the vibration.

Deprecated since version 6.1.0: Replaced by Duration.

Sound
class Sound

Added in version 6.2.0

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

Sound()
Sound(int resourceId)

Added in version 6.2.0

Creates a new Sound object for the given raw resource.

Deprecated since version 6.8.0: Replaced by ResourceSound

Sound()
Sound(string assetName)

Added in version 6.7.0

Creates a new Sound object for the given asset name, file extension should be included.

Deprecated since version 6.8.0: Replaced by AssetSound

ResourceId
int ResourceId { get; }

Added in version 6.2.0

Id of the sound resource.

This value will be 0 in case the sound was instantiated providing an asset name.

AssetName
string AssetName { get; }

Added in version 6.7.0

Name of the sound asset.

This value will be null in case the sound was instantiated providing a raw resource identifier.

DefaultSound
static Sound DefaultSound { get; }

Added in version 6.2.0

The default beep sound for a successful scan.

AssetSound
class AssetSound : Sound

Added in version 6.8.0

A sound created with an asset resource, to be played for example when a code has been successfully scanned.

AssetSound()
AssetSound(string assetName)

Added in version 6.8.0

Creates a new AssetSound object for the given asset name, file extension should be included.

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.

Feedback
class Feedback

Added in version 6.2.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()
static Feedback FromJson(string json)

Added in version 6.3.0

Constructs a new feedback with the provided JSON serialization. See Serialization for details.

DefaultFeedback
static Feedback DefaultFeedback { get; }

Added in version 6.2.0

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

Sound
Sound Sound { get; }

Added in version 6.2.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
Vibration Vibration { get; }

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

Creates a Feedback that emits no vibration and plays no sound.

Feedback()
Feedback(Vibration vibration)

Added in version 6.2.0

Creates a Feedback that emits the given vibration, but plays no sound.

Feedback()
Feedback(Sound sound)

Added in version 6.2.0

Creates a Feedback that plays the given sound, but emits no vibration.

Feedback()
Feedback(Vibration vibration, Sound sound)

Added in version 6.2.0

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

Emit()
void Emit()

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