GamepadHapticActuator.pulse()

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The pulse() method of the GamepadHapticActuator interface makes the hardware pulse at a certain intensity for a specified duration.

Syntax

gamepadHapticActuatorInstance.pulse(value, duration).then(function(result) { /* ... */ });

Parameters

value

A double representing the intensity of the pulse. This can vary depending on the hardware type, but generally takes a value between 0.0 (no intensity) and 1.0 (full intensity).

duration

A double representing the duration of the pulse, in milliseconds.

Note: Repeated calls to pulse() override the previous calls if they are still ongoing.

Return value

A promise that resolves with a value of true when the pulse has successfully completed.

Examples

const gamepad = navigator.getGamepads()[0];

gamepad.hapticActuators[0].pulse(1.0, 200);

Specifications

Specification
Gamepad Extensions
# dom-gamepadhapticactuator-pulse

Browser compatibility

BCD tables only load in the browser

See also