Navigator: vibrate() メソッド

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

vibrate() は Navigator インターフェイスのメソッドで、端末のバイブレーションハードウェアがあればパルスを送ります。端末がバイブレーションに対応していない場合は、このメソッドは効果はありません。このメソッドが呼び出されたときに、すでにバイブレーションパターンが進行中であった場合は、前のパターンが停止され、代わりに新しいパターンが始まります。

このメソッドが、引数が無効であるためにバイブレーションを実行できなかった場合は false を返し、それ以外の場合は true を返します。パターンによってとても長いバイブレーションが指定された場合は、短縮されます。最大長は実装に依存します。

構文

js
vibrate(pattern)

引数

pattern

バイブレーションと停止の間隔のパターンを提供します。それぞれの値はミリ秒単位の数値でバイブレーションと停止の長さを交互に表します。単一の値 (そのミリ秒だけ一度バイブレーションを行う) か、値の配列でバイブレーション、停止、再度バイブレーションと交互の値の配列で指定することができます。詳しくはバイブレーション API を参照してください。

0 の値、空の配列、すべての値がゼロである配列を渡すと、現在進行中のバイブレーションパターンをすべて中止します。

返値

論理値です。

セキュリティ

ユーザーによる粘着的な有効化が必要です。ユーザーがページまたはUIの要素を操作しなければ、この機能は動作しません。

例

js
navigator.vibrate(200); // 200ms のバイブレーション
navigator.vibrate([
  100, 30, 100, 30, 100, 30, 200, 30, 200, 30, 200, 30, 100, 30, 100, 30, 100,
]); // モールス信号で 'SOS' とバイブレーションします。

仕様書

Specification
Vibration API (Second Edition)
# dom-navigator-vibrate

ブラウザーの互換性

BCD tables only load in the browser

関連情報