Collapse all Symbian^3 Product Developer Library

MHWRMHapticsObserver Class Reference

class MHWRMHapticsObserver

A client should derive from this abstract class to receive haptics status notifications and notification of effect completion.

Since: S60 5.1

Public Member Functions
void	EffectCompletedL(TInt, TInt)
void	HapticsStatusChangedL(THWRMHapticsStatus)

Public Member Enumerations
enum	THWRMHapticsStatus { EHWRMHapticsStatusAvailable = 0, EHWRMHapticsStatusReserved, EHWRMHapticsStatusSuspended }

Member Functions Documentation

EffectCompletedL(TInt, TInt)

void	EffectCompletedL	(	TInt	aError,
			TInt	aEffectHandle
		)	[pure virtual]

Called when effect has completed playing.

Method reserved for future use.

Since: S60 5.1

Parameters

TInt aError	Reason of completion.
TInt aEffectHandle	The associated effectHandle to the effect.

HapticsStatusChangedL(THWRMHapticsStatus)

void

HapticsStatusChangedL

(

THWRMHapticsStatus

aStatus

)

[pure virtual]

Called when the device's haptics feature state changes

Since: S60 5.1

CHWRMHaptics::THWRMHapticsStatus

Parameters

THWRMHapticsStatus aStatus

Indicates haptics status.

Member Enumerations Documentation

Enum THWRMHapticsStatus

Haptics status.

Enumerators

EHWRMHapticsStatusAvailable = 0

Haptics is available for the observing client.

EHWRMHapticsStatusReserved

Haptics is reserved for another client. The client making the active reservation does not receive this notification, but a success code for the reservation command.

EHWRMHapticsStatusSuspended

Haptics has been suspended for this client. This occurs, when another client with higher priority makes reservation for haptics, or when this client is making reservation and haptics has already been reserved for a client with higher priority.

In suspended state, haptics effects are not played for the suspended client, but other commands are executed as normal.