Collapse all Symbian^3 Product Developer Library

RTactileFeedback Class Reference

class RTactileFeedback : public RSessionBase

Client interface to tactile feedback server.

tactilefeedbackresolver.lib

Since: S60 5.2

Inherits from

RTactileFeedback
- RSessionBase
  - RHandleBase

Public Member Functions
	RTactileFeedback()
IMPORT_C void	Close()
IMPORT_C TInt	Connect()
IMPORT_C void	FeedbackEnabledForDevice(TTouchFeedbackType &)
IMPORT_C void	ModifyFeedback(TInt)
IMPORT_C void	ModifyPreviewFeedback(TInt)
IMPORT_C void	PlayFeedback(TTouchLogicalFeedback, TBool, TBool)
IMPORT_C void	PlayPreviewFeedback(TInt, TTouchLogicalFeedback, TTouchFeedbackType)
IMPORT_C TInt	SetFeedbackEnabledForDevice(TTouchFeedbackType)
IMPORT_C void	StartFeedback(TTouchContinuousFeedback, TInt)
IMPORT_C void	StartPreviewFeedback(TInt, TTouchContinuousFeedback, TInt, TTouchFeedbackType)
IMPORT_C void	StopFeedback()
IMPORT_C void	StopPreviewFeedback()

Private Member Functions
TVersion	Version()

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Private Attributes
CThreadPlayer *	iThread

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RTactileFeedback()

IMPORT_C

RTactileFeedback

(

)

C++ default constructor.

Since: S60 5.2

Member Functions Documentation

Close()

IMPORT_C void

(

)

Closes connection to tactile feedback server.

Since: S60 5.2

Connect()

IMPORT_C TInt

Connect

(

)

Creates connection to tactile feedback server.

Since: S60 5.2

FeedbackEnabledForDevice(TTouchFeedbackType &)

IMPORT_C void

FeedbackEnabledForDevice

(

TTouchFeedbackType &

aFeedbackEnabled

)

Used to check enabled feedback types for the device.

Since: S60 5.2

Parameters

TTouchFeedbackType & aFeedbackEnabled

- Enabled feedback types are returned to this parameter as a bitmask.

ModifyFeedback(TInt)

IMPORT_C void

ModifyFeedback

(

TInt

aIntensity

)

Modifies the intensity of ongoing continuous feedback.

Since: S60 5.2

Parameters

TInt aIntensity

- New intensity for continuous feedback. Value range for intensity is 0-100%.

ModifyPreviewFeedback(TInt)

IMPORT_C void

ModifyPreviewFeedback

(

TInt

aIntensity

)

Modifies the intensity of ongoing preview of continuous feedback.

Since: S60 5.2

Parameters

TInt aIntensity

- New intensity for continuous feedback. Value range for intensity is 0-100% from basic strength.

PlayFeedback(TTouchLogicalFeedback, TBool, TBool)

IMPORT_C void	PlayFeedback	(	TTouchLogicalFeedback	aFeedbackType,
			TBool	aPlayVibra,
			TBool	aPlayAudio
		)

Produces immediately physical feedback according to given logical feedback type.

Since: S60 5.2

Parameters

TTouchLogicalFeedback aFeedbackType	- Logical feedback type.
TBool aPlayVibra	- ETrue to play vibra feedback, EFalse if vibra feedback is disabled.
TBool aPlayAudio	- ETrue to play audio feedback, EFalse if audio feedback is disabled.

PlayPreviewFeedback(TInt, TTouchLogicalFeedback, TTouchFeedbackType)

IMPORT_C void	PlayPreviewFeedback	(	TInt	aLevel,
			TTouchLogicalFeedback	aFeedback,
			TTouchFeedbackType	aType
		)

Produces immediate physical feedback according to given logical feedback type and given level.

Maximum feedback level depends on used player and it is defined in Central Repository settings (KTactileFeedbackVibraLevels & KTactileFeedbackAudioLevels).

UID for tactile feedback settings is: KCRUidTactileFeedback = 0x2000B494;

Since: S60 5.2

Parameters

TInt aLevel	- Level value defines the strength of playing effect. Maximum level value is player dependent.
TTouchLogicalFeedback aFeedback
TTouchFeedbackType aType	- Type of feedback to be previewed. Feedback type in preview mode must be either audio or haptics, not both.

SetFeedbackEnabledForDevice(TTouchFeedbackType)

IMPORT_C TInt

SetFeedbackEnabledForDevice

(

TTouchFeedbackType

aFeedbackType

)

Enables or disables audio or/and vibra feedback in whole device.

Since: S60 5.2

Parameters

TTouchFeedbackType aFeedbackType

- Feedback types to be enabled/disabled defined as a bitmask combination of enumeration items from TTouchFeedbackType.

StartFeedback(TTouchContinuousFeedback, TInt)

IMPORT_C void	StartFeedback	(	TTouchContinuousFeedback	aType,
			TInt	aIntensity
		)

Starts playing continuous feedback.

Since: S60 5.2

Parameters

TTouchContinuousFeedback aType	- Type of continuous feedback to be played.
TInt aIntensity	- Intensity of continuous feedback. Value range for intensity is 0-100%.

StartPreviewFeedback(TInt, TTouchContinuousFeedback, TInt, TTouchFeedbackType)

IMPORT_C void	StartPreviewFeedback	(	TInt	aLevel,
			TTouchContinuousFeedback	aFeedback,
			TInt	aIntensity,
			TTouchFeedbackType	aType
		)

Starts playing continuous feedback of given type on given level.

Maximum feedback level depends on used player and it is defined in Central Repository settings (KTactileFeedbackVibraLevels & KTactileFeedbackAudioLevels).

UID for tactile feedback settings is: KCRUidTactileFeedback = 0x2000B494;

Since: S60 5.2

Parameters

TInt aLevel	- Level value defines the strength of playing effect. Maximum level value is player dependent.
TTouchContinuousFeedback aFeedback	- Type of continuous feedback to be played.
TInt aIntensity	- Intensity of continuous feedback. Value range for intensity is 0-100% from basic strength (see aLevel).
TTouchFeedbackType aType	- Type of feedback to be previewed. Feedback type in preview mode must be either audio or haptics, not both.

StopFeedback()

IMPORT_C void

StopFeedback

(

)

Stops the ongoing feedback.

Since: S60 5.2

StopPreviewFeedback()

IMPORT_C void

StopPreviewFeedback

(

)

Stops the ongoing preview of continuous feedback.

Since: S60 5.2

Version()

TVersion

Version

(

)

const [private]

Returns the version of Tactile Feedback Server.

Member Data Documentation

CThreadPlayer * iThread

CThreadPlayer *

iThread

[private]

Instance of a class, which creates a new thread for the tactile feedback server Own.