Collapse all Symbian^3 Product Developer Library

MHWRMHapticsPacketizer Class Reference

class MHWRMHapticsPacketizer

Interface for Haptics packetizer. Includes functionality for encoding message data, decoding response data and getters for constants.

Since: S60 5.1

Public Member Functions
	~MHWRMHapticsPacketizer()
CDesC8ArraySeg *	DecodeMessageL(const TDesC8 &, TInt &)
TInt	DefaultDevicePriority()
TInt	DeviceHandle()
TInt	EncCloseDeviceReq(TInt, RBuf8 &)
TInt	EncCreateStreamingEffectReq(TInt, RBuf8 &)
TInt	EncDestroyStreamingEffectReq(TInt, TInt, RBuf8 &)
TInt	EncGetDeviceCapabilityIntReq(TInt, TInt, RBuf8 &)
TInt	EncGetDeviceCapabilityStringReq(TInt, TInt, RBuf8 &)
TInt	EncGetDevicePropertyBoolReq(TInt, TInt, RBuf8 &)
TInt	EncGetDevicePropertyIntReq(TInt, TInt, RBuf8 &)
TInt	EncGetDevicePropertyStringReq(TInt, TInt, RBuf8 &)
TInt	EncGetEffectStateReq(TInt, TInt, RBuf8 &)
TInt	EncModifyPlayingMagSweepEffectReq(TInt, TInt, CHWRMHaptics::THWRMHapticsMagSweepEffect, RBuf8 &)
TInt	EncModifyPlayingPeriodicEffectReq(TInt, TInt, CHWRMHaptics::THWRMHapticsPeriodicEffect, RBuf8 &)
TInt	EncOpenDeviceReq(THWRMLogicalActuators, RBuf8 &)
TInt	EncPausePlayingEffectReq(TInt, TInt, RBuf8 &)
TInt	EncPlayEffectIncludeEffectDataReq(TInt, const TDesC8 &, TInt, RBuf8 &)
TInt	EncPlayEffectNoDataReq(TInt, TInt, RBuf8 &)
TInt	EncPlayEffectRepeatIncludeEffectDataReq(TInt, const TDesC8 &, TInt, TUint8, RBuf8 &)
TInt	EncPlayEffectRepeatNoDataReq(TInt, TInt, TUint8, RBuf8 &)
TInt	EncPlayMagSweepEffectReq(TInt, CHWRMHaptics::THWRMHapticsMagSweepEffect, RBuf8 &)
TInt	EncPlayPeriodicEffectReq(TInt, CHWRMHaptics::THWRMHapticsPeriodicEffect, RBuf8 &)
TInt	EncPlayStreamingSampleReq(TInt, const TDesC8 &, TInt, RBuf8 &)
TInt	EncPlayStreamingSampleWithOffsetReq(TInt, const TDesC8 &, TInt, TInt, RBuf8 &)
TInt	EncResumePausedEffectReq(TInt, TInt, RBuf8 &)
TInt	EncSetDevicePropertyBoolReq(TInt, TBool, TInt, RBuf8 &)
TInt	EncSetDevicePropertyIntReq(TInt, TInt, TInt, RBuf8 &)
TInt	EncSetDevicePropertyStringReq(TInt, const TDesC8 &, TInt, RBuf8 &)
TInt	EncSetPlatformLicenseKeyReq(TInt, RBuf8 &)
TInt	EncStopAllPlayingEffectsReq(TInt, RBuf8 &)
TInt	EncStopPlayingEffectReq(TInt, TInt, RBuf8 &)
TInt	InfiniteDuration()
TInt	InfiniteRepeat()
TInt	MaxCapabilityStringLength()
TInt	MaxDeviceNameLength()
TInt	MaxEffectNameLength()
TInt	MaxPropertyStringLength()
TInt	MaxStreamingSampleSize()

Constructor & Destructor Documentation

~MHWRMHapticsPacketizer()

~MHWRMHapticsPacketizer

(

)

[inline, virtual]

Destructor.

Since: S60 5.1

Member Functions Documentation

DecodeMessageL(const TDesC8 &, TInt &)

CDesC8ArraySeg *	DecodeMessageL	(	const TDesC8 &	aData,
			TInt &	aStatus
		)	[pure virtual]

Decodes given message and fills the data received in the message to the returned array.

Since: S60 5.1

Parameters

const TDesC8 & aData	Received response data.
TInt & aStatus	On return, contains the received status value found in the response data.

DefaultDevicePriority()

TInt

DefaultDevicePriority

(

)

[pure virtual]

Returns default device priority constant value.

Since: S60 5.1

DeviceHandle()

TInt

DeviceHandle

(

)

[pure virtual]

Returns device handle value set in DecodeMessageL(). If device is not open, the value is KErrNotFound.

Since: S60 5.1

EncCloseDeviceReq(TInt, RBuf8 &)

TInt	EncCloseDeviceReq	(	TInt	aDeviceHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for closing device/actuator.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Device/actuator to be closed.
RBuf8 & aBuffer	On return contains the request data buffer.

EncCreateStreamingEffectReq(TInt, RBuf8 &)

TInt	EncCreateStreamingEffectReq	(	TInt	aDeviceHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for creating streaming effect.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
RBuf8 & aBuffer	On return contains the request data buffer.

EncDestroyStreamingEffectReq(TInt, TInt, RBuf8 &)

TInt	EncDestroyStreamingEffectReq	(	TInt	aDeviceHandle,
			TInt	aEffectHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for destroying streaming effect.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aEffectHandle	Handle to the existing effect.
RBuf8 & aBuffer	On return contains the request data buffer.

EncGetDeviceCapabilityIntReq(TInt, TInt, RBuf8 &)

TInt	EncGetDeviceCapabilityIntReq	(	TInt	aDeviceHandle,
			TInt	aDevCapType,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for getting integer device capability.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aDevCapType	Type of the capability to be fetched.
RBuf8 & aBuffer	On return contains the request data buffer.

EncGetDeviceCapabilityStringReq(TInt, TInt, RBuf8 &)

TInt	EncGetDeviceCapabilityStringReq	(	TInt	aDeviceHandle,
			TInt	aDevCapType,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for getting string device capability.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aDevCapType	Type of the capability to be fetched.
RBuf8 & aBuffer	On return contains the request data buffer.

EncGetDevicePropertyBoolReq(TInt, TInt, RBuf8 &)

TInt	EncGetDevicePropertyBoolReq	(	TInt	aDeviceHandle,
			TInt	aDevPropType,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for getting boolean device property.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aDevPropType	Type of the property to be fetched.
RBuf8 & aBuffer	On return contains the request data buffer.

EncGetDevicePropertyIntReq(TInt, TInt, RBuf8 &)

TInt	EncGetDevicePropertyIntReq	(	TInt	aDeviceHandle,
			TInt	aDevPropType,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for getting integer device property.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aDevPropType	Type of the property to be fetched.
RBuf8 & aBuffer	On return contains the request data buffer.

EncGetDevicePropertyStringReq(TInt, TInt, RBuf8 &)

TInt	EncGetDevicePropertyStringReq	(	TInt	aDeviceHandle,
			TInt	aDevPropType,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for getting string device property.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aDevPropType	Type of the property to be fetched.
RBuf8 & aBuffer	On return contains the request data buffer.

EncGetEffectStateReq(TInt, TInt, RBuf8 &)

TInt	EncGetEffectStateReq	(	TInt	aDeviceHandle,
			TInt	aEffectHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for getting effect state.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aEffectHandle	Handle to the existing effect.
RBuf8 & aBuffer	On return contains the request data buffer.

EncModifyPlayingMagSweepEffectReq(TInt, TInt, CHWRMHaptics::THWRMHapticsMagSweepEffect, RBuf8 &)

TInt	EncModifyPlayingMagSweepEffectReq	(	TInt	aDeviceHandle,
			TInt	aEffectHandle,
			CHWRMHaptics::THWRMHapticsMagSweepEffect	aEffect,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for modifying mag sweep effect.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aEffectHandle	Handle to the existing effect.
CHWRMHaptics::THWRMHapticsMagSweepEffect aEffect	New data for the effect definition.
RBuf8 & aBuffer	On return contains the request data buffer.

EncModifyPlayingPeriodicEffectReq(TInt, TInt, CHWRMHaptics::THWRMHapticsPeriodicEffect, RBuf8 &)

TInt	EncModifyPlayingPeriodicEffectReq	(	TInt	aDeviceHandle,
			TInt	aEffectHandle,
			CHWRMHaptics::THWRMHapticsPeriodicEffect	aEffect,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for modifying periodic effect.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aEffectHandle	Handle to the existing effect.
CHWRMHaptics::THWRMHapticsPeriodicEffect aEffect	New data for the effect definition.
RBuf8 & aBuffer	On return contains the request data buffer.

EncOpenDeviceReq(THWRMLogicalActuators, RBuf8 &)

TInt	EncOpenDeviceReq	(	THWRMLogicalActuators	aLogicalActuator,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for opening a device/actuator.

Since: S60 5.1

Parameters

THWRMLogicalActuators aLogicalActuator	Logical actuator type to be opened.
RBuf8 & aBuffer	On return contains the request data buffer.

EncPausePlayingEffectReq(TInt, TInt, RBuf8 &)

TInt	EncPausePlayingEffectReq	(	TInt	aDeviceHandle,
			TInt	aEffectHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for pausing effect play.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aEffectHandle	Handle to the existing effect.
RBuf8 & aBuffer	On return contains the request data buffer.

EncPlayEffectIncludeEffectDataReq(TInt, const TDesC8 &, TInt, RBuf8 &)

TInt	EncPlayEffectIncludeEffectDataReq	(	TInt	aDeviceHandle,
			const TDesC8 &	aData,
			TInt	aEffectIndex,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for playing periodic effect from effect data.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
const TDesC8 & aData	Effect data, which includes the effect to be played.
TInt aEffectIndex	Index of the effect in the effect data.
RBuf8 & aBuffer	On return contains the request data buffer.

EncPlayEffectNoDataReq(TInt, TInt, RBuf8 &)

TInt	EncPlayEffectNoDataReq	(	TInt	aDeviceHandle,
			TInt	aEffectIndex,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for playing effect from loaded effect data.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aEffectIndex	Index of the effect in the effect data.
RBuf8 & aBuffer	On return contains the request data buffer.

EncPlayEffectRepeatIncludeEffectDataReq(TInt, const TDesC8 &, TInt, TUint8, RBuf8 &)

TInt	EncPlayEffectRepeatIncludeEffectDataReq	(	TInt	aDeviceHandle,
			const TDesC8 &	aData,
			TInt	aEffectIndex,
			TUint8	aRepeat,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for playing repeating effect from effect data.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
const TDesC8 & aData	Effect data, which includes the effect to be played.
TInt aEffectIndex	Index of the effect in the effect data.
TUint8 aRepeat	The number of times to repeat the effect.
RBuf8 & aBuffer	On return contains the request data buffer.

EncPlayEffectRepeatNoDataReq(TInt, TInt, TUint8, RBuf8 &)

TInt	EncPlayEffectRepeatNoDataReq	(	TInt	aDeviceHandle,
			TInt	aEffectIndex,
			TUint8	aRepeat,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for playing repeating effect from loaded effect data.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aEffectIndex	Index of the effect in the effect data.
TUint8 aRepeat	The number of times to repeat the effect.
RBuf8 & aBuffer	On return contains the request data buffer.

EncPlayMagSweepEffectReq(TInt, CHWRMHaptics::THWRMHapticsMagSweepEffect, RBuf8 &)

TInt	EncPlayMagSweepEffectReq	(	TInt	aDeviceHandle,
			CHWRMHaptics::THWRMHapticsMagSweepEffect	aEffect,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for playing a magsweep effect.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the device/actuator.
CHWRMHaptics::THWRMHapticsMagSweepEffect aEffect	Effect definition data.
RBuf8 & aBuffer	On return contains the request data buffer.

EncPlayPeriodicEffectReq(TInt, CHWRMHaptics::THWRMHapticsPeriodicEffect, RBuf8 &)

TInt	EncPlayPeriodicEffectReq	(	TInt	aDeviceHandle,
			CHWRMHaptics::THWRMHapticsPeriodicEffect	aEffect,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for playing a periodic effect.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the device/actuator.
CHWRMHaptics::THWRMHapticsPeriodicEffect aEffect	Effect definition data.
RBuf8 & aBuffer	On return contains the request data buffer.

EncPlayStreamingSampleReq(TInt, const TDesC8 &, TInt, RBuf8 &)

TInt	EncPlayStreamingSampleReq	(	TInt	aDeviceHandle,
			const TDesC8 &	aStreamingSample,
			TInt	aEffectHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for playing streaming sample.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
const TDesC8 & aStreamingSample	Sample data.
TInt aEffectHandle	Handle to an effect.
RBuf8 & aBuffer	On return contains the request data buffer.

EncPlayStreamingSampleWithOffsetReq(TInt, const TDesC8 &, TInt, TInt, RBuf8 &)

TInt	EncPlayStreamingSampleWithOffsetReq	(	TInt	aDeviceHandle,
			const TDesC8 &	aStreamingSample,
			TInt	aOffsetTime,
			TInt	aEffectHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for playing streaming sample with offset.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
const TDesC8 & aStreamingSample	Sample data.
TInt aOffsetTime	Offset time.
TInt aEffectHandle	Handle to an effect.
RBuf8 & aBuffer	On return contains the request data buffer.

EncResumePausedEffectReq(TInt, TInt, RBuf8 &)

TInt	EncResumePausedEffectReq	(	TInt	aDeviceHandle,
			TInt	aEffectHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for resuming paused effect play.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aEffectHandle	Handle to the existing effect.
RBuf8 & aBuffer	On return contains the request data buffer.

EncSetDevicePropertyBoolReq(TInt, TBool, TInt, RBuf8 &)

TInt	EncSetDevicePropertyBoolReq	(	TInt	aDeviceHandle,
			TBool	aDevPropValue,
			TInt	aDevPropType,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for setting boolean device property.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TBool aDevPropValue	Device property value.
TInt aDevPropType	Type of the property to be set.
RBuf8 & aBuffer	On return contains the request data buffer.

EncSetDevicePropertyIntReq(TInt, TInt, TInt, RBuf8 &)

TInt	EncSetDevicePropertyIntReq	(	TInt	aDeviceHandle,
			TInt	aDevPropValue,
			TInt	aDevPropType,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for setting integer device property.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aDevPropValue	Device property value.
TInt aDevPropType
RBuf8 & aBuffer	On return contains the request data buffer.

EncSetDevicePropertyStringReq(TInt, const TDesC8 &, TInt, RBuf8 &)

TInt	EncSetDevicePropertyStringReq	(	TInt	aDeviceHandle,
			const TDesC8 &	aDevPropValue,
			TInt	aDevPropType,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for setting string device property.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
const TDesC8 & aDevPropValue	Device property value.
TInt aDevPropType	Type of the property to be set.
RBuf8 & aBuffer	On return contains the request data buffer.

EncSetPlatformLicenseKeyReq(TInt, RBuf8 &)

TInt	EncSetPlatformLicenseKeyReq	(	TInt	aDeviceHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for setting platform license key.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
RBuf8 & aBuffer	On return contains the request data buffer.

EncStopAllPlayingEffectsReq(TInt, RBuf8 &)

TInt	EncStopAllPlayingEffectsReq	(	TInt	aDeviceHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for stopping all effect play.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
RBuf8 & aBuffer	On return contains the request data buffer.

EncStopPlayingEffectReq(TInt, TInt, RBuf8 &)

TInt	EncStopPlayingEffectReq	(	TInt	aDeviceHandle,
			TInt	aEffectHandle,
			RBuf8 &	aBuffer
		)	[pure virtual]

Creates request data for stopping effect play.

Since: S60 5.1

Parameters

TInt aDeviceHandle	Handle to the used device/actuator.
TInt aEffectHandle	Handle to the existing effect.
RBuf8 & aBuffer	On return contains the request data buffer.

InfiniteDuration()

TInt

InfiniteDuration

(

)

[pure virtual]

Returns infinite duration constant value.

Since: S60 5.1

InfiniteRepeat()

TInt

InfiniteRepeat

(

)

[pure virtual]

Returns infinite repeat constant value.

Since: S60 5.1

MaxCapabilityStringLength()

TInt

MaxCapabilityStringLength

(

)

[pure virtual]

Returns maximum capability string length constant value.

Since: S60 5.1

MaxDeviceNameLength()

TInt

MaxDeviceNameLength

(

)

[pure virtual]

Returns maximum device name length constant value.

Since: S60 5.1

MaxEffectNameLength()

TInt

MaxEffectNameLength

(

)

[pure virtual]

Returns maximum effect name length constant value.

Since: S60 5.1

MaxPropertyStringLength()

TInt

MaxPropertyStringLength

(

)

[pure virtual]

Returns maximum property string length constant value.

Since: S60 5.1

MaxStreamingSampleSize()

TInt

MaxStreamingSampleSize

(

)

[pure virtual]

Returns maximum streaming sample size constant value.

Since: S60 5.1