Vibration プラグイン

グローバルスコープに属していますが、使用できるのは、deviceready イベントの発火後になります。

このプラグインの詳細は、 こちらの原文 ( GitHub ) をご確認ください。

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

プラグイン ID

cordova-plugin-vibration

プラグインの追加方法

このプラグインを使用する場合には、Monaca クラウド IDE の [ Cordova プラグインの管理 ] 上で、Vibration プラグインを有効にします。

navigator.notification.vibrateWithPattern と navigator.notification.cancelVibration は、iOSでは動作しません。

API の解説

vibrate

この関数は、引き渡すパラメーターに応じて、動作 ( pattern/パターン ) が異なります。on、on/off、off の 3 つのパターンがあります。

基本的な振動処理

指定した時間の長さで、端末を振動させます。

    navigator.vibrate(time)

または、

    navigator.vibrate([time])

• time: 振動する時間 ( ミリ秒単位 ) です。 ( 数値 )

例

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

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

iOS 特有の動作

• time: 指定された時間を無視して、代わりに、システム側の設定を使用して振動させます。

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

pattern ( パターン ) を使用した振動処理 ( Android のみ )

指定された pattern に応じて、端末を振動させます。

    navigator.vibrate(pattern);

• 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)