Property Ksktscanpropidrumbleconfigdevice - Socket ScanAPI Reference Manual

Socket ScanAPI Reference
Version
ScanAPI Interface Version

14.26 Property kSktScanPropIdRumbleConfigDevice

This property can be used to retrieve or to set the configuration of the Rumble
feature of the device.
Some devices don't support the rumble feature. In that case an error
(ESKT_NOTSUPPORTED) is generated if an application is trying to set or get this
property.
A rumble has two configurable parameters; the On duration and the Off duration.
The On duration is the time the rumble is active, and the Off duration is the time the
rumble is inactive.
There are four actions that can be configured with a rumble and they are described
in the following table:
Name
kSktScanRumbleActionTypeGoodScan
kSktScanRumbleActionTypeGoodScanLocal Rumble action when the device locally
kSktScanRumbleActionTypeBadScan
kSktScanRumbleActionTypeBadScanLocal
The rumble configuration can be described as below:
Name
Rumble Action
Number of
Rumbles
On duration
© 2013 Socket Mobile, Inc.
Size
2 bytes
2 bytes
2 bytes
1.0.0 or higher
Description
Rumble action when a good scan
occurs
acknowledges a good scan.
Rumble action when a bad scan occurs
Runble action when the device locally
acknowledges a bad scan
Present
Get Complete, Set
Get Complete, Set
Get Complete, Set
Description
Configuration of a
particular Rumble
action.
Define the number
of Rumble present
in this
configuration. The
maximum number
of rumbles is 5.
Define the duration
when the rumble is
active. The On
duration range is
50 (0x32) to 32767
(0x7FFF)
111/152