1 hwrmvibrasdkcrkeys.h |
1 /* |
|
2 * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: This file contains SDK central repository key definitions |
|
15 * for the vibra |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef HWRMVIBRASDKCRKEYS_H |
|
21 #define HWRMVIBRASDKCRKEYS_H |
|
22 |
|
23 #include <e32std.h> |
|
24 |
|
25 /** |
|
26 * @file hwrmvibrasdkcrkeys.h |
|
27 * |
|
28 * The API provides the vibra related Centrl Repository keys. |
|
29 * These keys provide information on the vibra setting controlled by |
|
30 * Profiles, maximum vibrating time supported by the device and |
|
31 * minimum time vibra cannot be started after it was forcibly |
|
32 * turned off when maximum time was reached. In addition keys |
|
33 * provide tactile feedback setting controlled by profiles and |
|
34 * default intensity and duration for feedback vibration. |
|
35 * |
|
36 * This interface relies on the Central Repository (CenRep) interface provided |
|
37 * by Symbian. |
|
38 * |
|
39 * The CenRep UID is #KCRUidVibraCtrl and following keys are provided: |
|
40 * - #KVibraCtrlProfileVibraEnabled |
|
41 * - #KVibraCtrlMaxTime |
|
42 * - #KVibraMinOffTime |
|
43 */ |
|
44 |
|
45 /** |
|
46 * CenRep UID for all vibra related settings keys provided by this API. |
|
47 */ |
|
48 const TUid KCRUidVibraCtrl = {0x10200C8B}; |
|
49 |
|
50 /** |
|
51 * Vibra setting controlled by Profiles. |
|
52 * |
|
53 * Possible integer values: |
|
54 * |
|
55 * 0 = Vibra is off in profile (default value) <br> |
|
56 * 1 = Vibra is on in profile <br> |
|
57 */ |
|
58 const TUint32 KVibraCtrlProfileVibraEnabled = 0x00000001; |
|
59 |
|
60 /** |
|
61 * Maximum vibrating time supported by device. |
|
62 * |
|
63 * Value is milliseconds as an integer. |
|
64 * If value is zero, no maximum time is supported. |
|
65 * Maximum supported time is TMaxTInt microseconds in milliseconds. |
|
66 * |
|
67 * Value is read-only. |
|
68 * |
|
69 * Default value: 10000. |
|
70 */ |
|
71 const TUint32 KVibraCtrlMaxTime = 0x00000002; |
|
72 |
|
73 /** |
|
74 * Minimum time vibra cannot be started after it was |
|
75 * forcibly turned off when maximum time was reached. |
|
76 * This can be used to enforce vibra cooling after long |
|
77 * use periods. |
|
78 * |
|
79 * Value is milliseconds as an integer. |
|
80 * |
|
81 * Value is read-only. |
|
82 * |
|
83 * Default value: 0 |
|
84 */ |
|
85 const TUint32 KVibraMinOffTime = 0x00000003; |
|
86 |
|
87 /** |
|
88 * Tactile feedback setting controlled by Profiles. |
|
89 * |
|
90 * Possible integer values: |
|
91 * |
|
92 * 0 = Tactile feedback is off in profile (default value) <br> |
|
93 * 1 = Tactile feedback is on in profile <br> |
|
94 */ |
|
95 const TUint32 KVibraCtrlProfileFeedbackEnabled = 0x00000004; |
|
96 |
|
97 /** |
|
98 * Tactile feedback vibration default intensity. |
|
99 * |
|
100 * Possible default intensity values are from the range -100...100. |
|
101 * |
|
102 * Value is read-only. |
|
103 * |
|
104 * Default value: 100 |
|
105 */ |
|
106 const TUint32 KVibraCtrlFeedbackIntensity = 0x00000005; |
|
107 |
|
108 /** |
|
109 * Tactile feedback vibration default duration. |
|
110 * |
|
111 * Value is milliseconds as an integer. |
|
112 * |
|
113 * Value is read-only. |
|
114 * |
|
115 * Default value: 20 |
|
116 */ |
|
117 const TUint32 KVibraCtrlFeedbackDuration = 0x00000006; |
|
118 |
|
119 |
|
120 #endif // HWRMVIBRASDKCRKEYS_H |
|
121 |
|
122 // End of File |