API published in: S60 3rd Ed
Required Capabilities
None
Exceptions
The capability WriteDeviceData is required when setting value of the key KVibraCtrlProfileVibraEnabled.
Other: Vibra Settings API is not a real API (it doesn't have any functions), it only provides the vibra related Central Repository keys.
These keys provide information on the vibra setting in active profile, maximum vibrating time supported by the device and minimum time vibra cannot be started after it was forcibly turned off when maximum time was reached.
This interface relies on the Central Repository (CenRep) interface provided by Symbian.
The CenRep UID is KCRUidVibraCtrl and following keys are provided:
#include <e32std.h>
Go to the source code of this file.
Variables |
|
| const TUid | KCRUidVibraCtrl = {0x10200C8B} |
| CenRep UID for all vibra related settings keys provided by this API. |
|
| const TUint32 | KVibraCtrlProfileVibraEnabled = 0x00000001 |
| Vibra setting in active profile. |
|
| const TUint32 | KVibraCtrlMaxTime = 0x00000002 |
| Maximum vibrating time supported by device. |
|
| const TUint32 | KVibraMinOffTime = 0x00000003 |
| Minimum time vibra cannot be started after it was forcibly turned off when maximum time was reached. |
|
|
|
CenRep UID for all vibra related settings keys provided by this API. |
|
|
Maximum vibrating time supported by device. Value is milliseconds as an integer. If value is zero, no maximum time is supported. Maximum supported time is TMaxTInt microseconds in milliseconds. Value is read-only. Default value: 10000. |
|
|
Vibra setting in active profile. Possible integer values:
0 = Vibra is off in active profile (default value) |
|
|
Minimum time vibra cannot be started after it was forcibly turned off when maximum time was reached. This can be used to enforce vibra cooling after long use periods. Value is milliseconds as an integer. Value is read-only. Default value: 0 |