cordova-plugin-vibration

このプラグインは、デバイスを振動させる方法を提供します。APIは、http://www.w3.org/TR/vibration/ のW3Cバイブレーション仕様に準拠しています。

このプラグインは、グローバルオブジェクト/メソッド `navigator.vibrate` を定義します。グローバルスコープ内ですが、`deviceready` イベントの後まで使用できません。

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(navigator.vibrate);
}

インストール

cordova plugin add cordova-plugin-vibration

サポートされているプラットフォーム

• iOS
• Windows Phone
• Android
  Android WebView（APIレベル19以上）は、W3C Vibration API をネイティブでサポートしているため、このプラグインにAndroid固有の実装は必要ありません。

navigator.vibrate

この関数は、渡されたパラメータに基づいて3つの異なる機能を備えています。

標準バイブレーション

指定された時間、デバイスを振動させます。

navigator.vibrate(time)

または

navigator.vibrate([time])

• **時間**: デバイスを振動させるミリ秒。 (数値)

例

// Vibrate for 3 seconds
navigator.vibrate(3000);

// Vibrate for 3 seconds
navigator.vibrate([3000]);

特異性

iOSの特異性

• **時間**: 指定された時間を無視し、プリセットされた時間だけ振動します。

    navigator.vibrate(3000); // 3000 is ignored
  

Windows Phoneの特異性

• **時間**: 最大時間は5000ミリ秒（5秒）、最小時間は1ミリ秒です。

    navigator.vibrate(8000); // will be truncated to 5000
  

Androidの特異性

ユーザーがフレームまたは埋め込まれたフレームをまだタップしていない場合、`navigator.vibrate` の呼び出しはすぐに `false` を返します。

https://www.chromestatus.com/feature/5644273861001216 を参照してください。

パターンによるバイブレーション

指定されたパターンでデバイスを振動させます。

navigator.vibrate(pattern);

• **パターン**: バイブレーターをオンまたはオフにする期間（ミリ秒）のシーケンス。 (数値の配列)

例

// Vibrate for 1 second
// Wait for 1 second
// Vibrate for 3 seconds
// Wait for 1 second
// Vibrate for 5 seconds
navigator.vibrate([1000, 1000, 3000, 1000, 5000]);

特異性

• iOSではサポートされていません。

バイブレーションのキャンセル

現在実行中のバイブレーションをすぐにキャンセルします。

navigator.vibrate(0)

または

navigator.vibrate([])

または

navigator.vibrate([0])

パラメータに0、空の配列、または値0の要素が1つだけの配列を渡すと、バイブレーションはキャンセルされます。

特異性

• iOSではサポートされていません。