Creates a streaming effect.

Client calls CreateStreamingEffect() to create a new streaming effect and gets a new handle for it; it should use that effect handle to play a streaming sample by calling PlayStreamingSample().

Gets the default device priority. Method may be used only after an actuator has been opened successfully.

Delete all loaded effect datas.

Delete loaded effect data referenced by file handle.

Destroys a streaming effect previously created in a successful call to CreateStreamingEffect().

Gets a capability value of the haptics.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Gets a property value of the haptics.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Get a number of effects defined in a loaded effect data buffer.

Get the duration of an effect defined in a loaded effect data buffer.

Gets the index of an effect defined in a loaded effect data buffer from the name of the effect.

Gets the name of an effect defined in a loaded effect data buffer.

Retrieves the status of an effect (playing, not playing, paused).

Gets the type of an effect defined in loaded effect data buffer.

Gets the parameters of a MagSweep effect defined in a loaded effect data buffer.

Gets the parameters of a periodic effect defined in a loaded effect data buffer.

This method retrieves the current haptics status.

THWRMHapticsStatus

Gets the value that represents infinite duration. Method may be used only after an actuator has been opened successfully.

Gets the value that represents infinite repeats. Method may be used only after an actuator has been opened successfully.

Load effect data defined in effect data buffer (obtained e.g. from a file containing the effect data).

Gets the maximum capability string length. Method may be used only after an actuator has been opened successfully.

Gets the maximum device name length. Method may be used only after an actuator has been opened successfully.

Gets the maximum length of an effect name stored in a loaded effect data file. Method may be used only after an actuator has been opened successfully.

Gets the maximum property string length. Method may be used only after an actuator has been opened successfully.

Gets the maximum streaming sample size. Method may be used only after an actuator has been opened successfully.

Modifies a playing MagSweep effect.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Modifies a playing periodic effect.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Two-phased constructor. Use this method for creating a haptics instance with callbacks.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Method for opening a logical actuator for use.

This method must be called before using any other methods of this class, except when using GetXXX methods. The Haptics API supports a limited number of instances of CHWRMHaptics class. If all instances are currently in use, the next attempt to call OpenActuatorL() from any client fails. Applications should not use more instances than necessary as this may prevent other applications from instantiating the CHWRMHaptics class.

Pauses a playing effect.

Plays an effect defined in loaded effect data buffer.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Plays an effect defined in effect data buffer.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Repeatedly plays a Timeline effect defined in loaded effect data buffer.

The current implementation of PlayEffectRepeat() repeats only Timeline effects. If the given effect index refers to a simple effect, PlayEffectRepeat() ignores the aRepeat parameter and plays the simple effect once. In that case, PlayEffectRepeat() behaves like PlayEffect(). PlayEffectRepeat() does not return a warning when requested to repeat a simple effect.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Repeatedly plays a Timeline effect defined in effect data buffer.

The current implementation of PlayEffectRepeat() repeats only Timeline effects. If the given effect index refers to a simple effect, PlayEffectRepeat() ignores the aRepeat parameter and plays the simple effect once. In that case, PlayEffectRepeat() behaves similarly to PlayEffect(). PlayEffectRepeat() does not return a warning when requested to repeat a simple effect.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Plays a MagSweep effect given in the parameters defining the effect.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Plays a Periodic effect given in the parameters defining the effect.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Plays a streaming sample given in the parameter defining the effect.

Streaming sample can only be played after calling CreateStreamingEffect() and by using the effecthandle it returns.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Plays a streaming sample with a time offset given in the parameters defining the effect.

Client calls CreateStreamingEffect() to create a new streaming effect and gets a new handle for it; it should use that effect handle to play the streaming sample with this method.

Synchronous method returns when the haptic command has been evaluated and the return value is valid.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Releases haptics feature if it was previously reserved for this client.

If this client has not reserved haptics feature, does nothing. If haptics is on when it is released and no other client has a suspended reservation, haptics is stopped.

Reserves haptics feature exclusively for this client. A higher priority client may cause lower priority client reservation to be temporarily suspended. The suspended client does not get any notification about suspension. If haptics is already reserved by a higher or equal priority client, reserving still succeeds, but reservation is immediately suspended. When the reservation is suspended, playing effects do not actually cause the effects to be played. Note: Unless the client has instantiated the Haptics API with the status observer, it does not receive any notifications about the fact that its effects are not actually played by the physical player when the client has been suspended by a higher priority reservation. Note also that even if haptics is reserved by some client, a higher priority client succeeds in playing its effects.

Calling this method is equal to call ReserveHapticsL(EFalse), i.e. foreground status is always used to control further reservations. However, this is a future feature, and not implemented in current version.

Reserves haptics feature exclusively for this client. A higher priority client may cause lower priority client reservation to be temporarily suspended. The suspended client does not get any notifications about suspension. If haptics is already reserved by a higher or equal priority client, reserving still succeeds, but reservation is immediately suspended. When the reservation is suspended, playing effects does not actually cause the effects to be played. Note: Unless the client has instantiated the Haptics API with the status observer, it does not receive any notifications about the fact that its effects are not actually played by the physical player when the client has been suspended by a higher priority reservation. Note also that even if haptics is reserved by some client, a higher priority client succeeds in playing its effects.

Resumes playback on a paused effect from the point where the effect was paused.

Depending on the available slots, it is possible that all simple effects from a paused effect data buffer or streaming sample cannot be resumed. The API returns success when it is able to play one of these simple effects.

Sets a property of the haptics.

Some properties affect all haptics instances, some only the current instance of the haptics. More about that can be found in THWRMHapticsDevicePropertyTypes.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Stops all playing and paused effects of a haptics instance.

Stops a playing effect.

Method for getting a bitmask value of supported logical actuators.

Developer needs to evaluate the returned bitmask against THWRMLogicalActuators enumeration values to know the supported logical actuators.

Actuator types.

To be used with GetDeviceCapability().

Device's capability types.

Use TInt& aDeviceCapabilityValue overloaded version of the method GetDeviceCapability() unless otherwise mentioned.

Device category.

THWRMHapticsDevicePropertyTypes enumeration Use SetDeviceProperty() to set properties for the haptics and GetDeviceProperty() to get properties currently in use.

Effect states.

As returned in a call to GetEffectState().

Effect styles

Used to specify Periodic or MagSweep effect style when calling PlayMagSweepEffect(), PlayPeriodicEffect(), ModifyPlayingMagSweepEffect() and ModifyPlayingPeriodicEffect().

Effect types

Bitmask for supported effect styles.

To be used to analyze the value returned by GetDeviceCapability().

Bitmask for effect support.

To be used to analyze value returned by GetDeviceCapability().