diff -r 51a74ef9ed63 -r ae94777fff8f Symbian3/SDK/Source/GUID-D53A00E4-CF37-5F11-8D15-C5ECCCE64597.dita --- a/Symbian3/SDK/Source/GUID-D53A00E4-CF37-5F11-8D15-C5ECCCE64597.dita Wed Mar 31 11:11:55 2010 +0100 +++ b/Symbian3/SDK/Source/GUID-D53A00E4-CF37-5F11-8D15-C5ECCCE64597.dita Fri Jun 11 12:39:03 2010 +0100 @@ -1,92 +1,92 @@ - - - - - -Vibra -APIVibra API provides the functionality to control the device -vibra, which is accessed using the CHWRMVibra instance. It -also provides methods to retrieve the current settings of the vibration feature -in the user profile and the current status of the vibra. It uses synchronous -method calls which block the client application until a response is received -from the plug-in.

Vibra API also allows the client to request -for tactile vibration feedback.

-

The API consists of CHWRMVibra,MHWRMVibraObserver and MHWRMVibraFeedbackObserver classes.

-

It provides the following fields:

- - - - -

Fields

-

Values

-

Descriptions

-
- - - - -

KHWRMVibraMinIntensity

-

-100

-

Minimum allowed intensity setting for vibra.

-
- -

KHWRMVibraMinPulseIntensity

-

1

-

Minimum allowed intensity setting for vibra pulse.

-
- -

KHWRMVibraMaxIntensity

-

100

-

Maximum allowed intensity setting for vibra.

-
- -

KHWRMVibraMaxDuration

-

(KMaxTInt/1000)-1

-

Maximum allowed duration value in milliseconds.

-
- -

KHWRMVibraInfiniteDuration

-

0

-

Specifies that vibrating must continue for maximum vibrating time -supported by device if vibrating is not explicitly stopped.

-
- - -
-
Observer

A separate callback interface MHWRMVibraObserver for status reporting is also -used. The client creates an instance of CHWRMVibra using NewL(). If the client requires the status information, -it must provide a callback pointer of the MHWRMVibraObserver implementing -class for the NewL() method.

- Vibra API Interfaces - -
-
Tactile vibration feedback

Tactile vibration is -used in many touch screen devices to provide vibration feedback to the user -through display surface.

The clients can specify the intensity and -duration of the feedback pulse, and receive notifications when the tactile -feedback settings changes in the user profile through MHWRMVibraFeedbackObserver class.

Note: The tactile feedback functionality is only available to the clients configured -at the firmware build time (Symbian platform licensees).

-Definitions - - - -

Vibra frozen state

-

Whenever vibra is released, its current state is stored as frozen -state. On next reserve, the user can specify that the frozen state be restored.

-
- -

Vibra virtual state

-

Reserves the specified resource. If reservation is not suspended, -then actual vibra is also set to the same state. If reservation is suspended, -actual vibra is not affected by any control methods.

-
- - -
+ + + + + +Vibra +APIVibra API provides the functionality to control the device +vibra, which is accessed using the CHWRMVibra instance. It +also provides methods to retrieve the current settings of the vibration feature +in the user profile and the current status of the vibra. It uses synchronous +method calls which block the client application until a response is received +from the plug-in.

Vibra API also allows the client to request +for tactile vibration feedback.

+

The API consists of CHWRMVibra,MHWRMVibraObserver and MHWRMVibraFeedbackObserver classes.

+

It provides the following fields:

+ + + + +

Fields

+

Values

+

Descriptions

+
+ + + + +

KHWRMVibraMinIntensity

+

-100

+

Minimum allowed intensity setting for vibra.

+
+ +

KHWRMVibraMinPulseIntensity

+

1

+

Minimum allowed intensity setting for vibra pulse.

+
+ +

KHWRMVibraMaxIntensity

+

100

+

Maximum allowed intensity setting for vibra.

+
+ +

KHWRMVibraMaxDuration

+

(KMaxTInt/1000)-1

+

Maximum allowed duration value in milliseconds.

+
+ +

KHWRMVibraInfiniteDuration

+

0

+

Specifies that vibrating must continue for maximum vibrating time +supported by device if vibrating is not explicitly stopped.

+
+ + +
+
Observer

A separate callback interface MHWRMVibraObserver for status reporting is also +used. The client creates an instance of CHWRMVibra using NewL(). If the client requires the status information, +it must provide a callback pointer of the MHWRMVibraObserver implementing +class for the NewL() method.

+ Vibra API Interfaces + +
+
Tactile vibration feedback

Tactile vibration is +used in many touch screen devices to provide vibration feedback to the user +through display surface.

The clients can specify the intensity and +duration of the feedback pulse, and receive notifications when the tactile +feedback settings changes in the user profile through MHWRMVibraFeedbackObserver class.

Note: The tactile feedback functionality is only available to the clients configured +at the firmware build time (Symbian platform licensees).

+Definitions + + + +

Vibra frozen state

+

Whenever vibra is released, its current state is stored as frozen +state. On next reserve, the user can specify that the frozen state be restored.

+
+ +

Vibra virtual state

+

Reserves the specified resource. If reservation is not suspended, +then actual vibra is also set to the same state. If reservation is suspended, +actual vibra is not affected by any control methods.

+
+ + +
\ No newline at end of file