GamepadHapticActuator: метод playEffect()

Ограниченное использование

Эта функция не относится к Baseline, так как она не работает в некоторых широко используемых браузерах.

Метод playEffect() интерфейса GamepadHapticActuator заставляет устройство воспроизвести определённый вибрационный эффект.

Синтаксис

playEffect(type, params)

Параметры

type

Строка, представляющая желаемый эффект. Возможные значения — "dual-rumble" и "trigger-rumble", а их эффект может варьироваться в зависимости от типа устройства. Подробные сведения о типах эффектов см. в GamepadHapticActuator.effects.

params

Объект для описания желаемого тактильного эффекта.

Ожидаемые значения:

duration Необязательно: Продолжительность эффекта в миллисекундах. По умолчанию — 0.
startDelay Необязательно: Задержка в миллисекундах перед запуском эффекта. По умолчанию — 0.
strongMagnitude Необязательно: Интенсивность вибрации низкой частоты (сильной) вибромоторов, нормализованная в диапазоне между 0.0 и 1.0. По умолчанию — 0.0.
weakMagnitude Необязательно: Интенсивность вибрации высокой частоты (слабой) вибромоторов, нормализованная в диапазоне между 0.0 и 1.0. По умолчанию — 0.0.
leftTrigger (актуально только для эффектов "trigger-rumble" ) Необязательно: Интенсивность вибрации левого переднего триггера, нормализованная в диапазоне между 0.0 и 1.0. По умолчанию — 0.0.
rightTrigger (актуально только для эффектов "trigger-rumble" ) Необязательно: Интенсивность вибрации правого переднего триггера, нормализованная в диапазоне между 0.0 и 1.0. По умолчанию — 0.0.

Примечание: Новый вызов playEffect() перезаписывает предыдущий активный вызов.

Возвращаемое значение

Обещание, которое выполняется с "complete" при успешном завершении эффекта или с "preempted" при остановке текущего эффекта или его замене другим эффектом.

Обещание может отклониться с следующими типами исключений:

InvalidStateError DOMException: Текущий документ не активен или скрыт.
NotSupportedError DOMException: Запрошенный type не поддерживается актуатором текущего джойстика.
TypeError DOMException: Запрошенный type — не допустимый тип эффекта.

Примеры

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

gamepad.vibrationActuator
  .playEffect("dual-rumble", {
    startDelay: 0,
    duration: 200,
    weakMagnitude: 1.0,
    strongMagnitude: 1.0,
  })
  .then((result) => console.log(result));
// Should log "complete" if effect successfully runs

Спецификации

Спецификация
Gamepad # dom-gamepadhapticactuator-playeffect

Совместимость с браузерами

	Рабочий стол					Мобильные устройства
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox для Android	Opera Android	Safari на iOS	Samsung Internet	WebView Android
`playEffect`	68	15	Нет	55	16.4	68	Нет	48	Нет	10.0	68
`params_leftTrigger_parameter`	126	126	Нет	112	Нет	126	Нет	83	Нет	Нет	126
`params_rightTrigger_parameter`	126	126	Нет	112	Нет	126	Нет	83	Нет	Нет	126
`type_trigger-rumble`	126	126	Нет	112	Нет	126	Нет	83	Нет	Нет	126

См. также

API джойстика

© 2005–2024 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/GamepadHapticActuator/playEffect