このトピックでは、WVMotion の JavaScript API について説明します。 HTML5 アプリケーションまたはミニアプリを作成する際に、このトピックを参照できます。 API を呼び出して、電話への息の吹きかけなど、ユーザーが電話に対して実行する操作をリッスンできます。また、API を呼び出して電話を振動させることもできます。
WVMotion.listenBlow
息の吹きかけジェスチャをリッスンします。
入力パラメーター
[
number]time: オプション。ユーザーが電話に息を吹きかけたときに息の吹きかけイベントが生成される間隔。単位:秒。 iOS では、値の範囲は[0, 1]です。デフォルト値は0です。値は、息の吹きかけジェスチャが続くにつれて増加します。
コールバックパラメーター
コールバックパラメーターはありません。息の吹きかけジェスチャのリッスンが有効になっている場合、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。
イベントリスニング
motion.blow: 息の吹きかけジェスチャのリッスンが有効になっているときに、ユーザーが電話に息を吹きかけます。
イベントパラメーター:
[
number]pass: 息の吹きかけイベントを生成する息の吹きかけジェスチャの継続時間。パラメーター値は、オペレーティングシステムによって異なります。 iOS では、パラメーター値の範囲は[0, 1]です。この値は、息の吹きかけジェスチャが続くにつれて増加します。 Android では、パラメーター値は1に固定されています。
document.addEventListener('motion.blow', function(e) {
alert('息の吹きかけジェスチャが検知されました。');
}, false);
window.WindVane.call('WVMotion', 'listenBlow', {}, function(e) {
alert('success');
}, function(e) {
alert('failure:' + JSON.stringify(e));
});
WVMotion.stopListenBlow
息の吹きかけジェスチャのリッスンを停止します。
入力パラメーター
入力パラメーターはありません。
コールバックパラメーター
コールバックパラメーターはありません。この API 操作は常に success コールバックを呼び出します。
window.WindVane.call('WVMotion', 'stopListenBlow', {}, function(e) {
alert('success');
});
WVMotion.listenGyro
ジャイロスコープの監視を有効または無効にします。
HTML5 アプリケーションまたはミニアプリは、ジャイロスコープを監視することで、電話の向きの変化を感知できます。これにより、アプリケーションまたはミニアプリはそれに応じて画面を回転させることができます。電話のジャイロスコープと重力センサーを使用して、電話の動きを監視します。ジャイロスコープは電話のオイラー角(ロール、ピッチ、ヨー)を取得でき、重力センサーは3方向の重力の大きさを取得できます。
ジャイロスコープのデータ形式は iOS と Android で異なるため、オペレーティングシステム全体で一貫性のある形式の重力センサーデータが戻り値として使用されます。 HTML5 アプリケーションとミニアプリは、アルゴリズムを使用して、データに基づいて電話の向きを取得できます。
入力パラメーター
[
boolean]on: ジャイロスコープの監視を有効にするかどうかを指定します。trueは監視が有効になっていることを示し、falseは監視が無効になっていることを示します。[
number]frequency: ジャイロスコープイベント間の最小間隔。単位:ミリ秒。ジャイロスコープイベントの間隔は、常にこのパラメーター値よりも大きくなります。
コールバックパラメーター
コールバックパラメーターはありません。ジャイロスコープの監視が有効または無効になっている場合、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。
イベントリスニング
motion.gyro: ジャイロスコープが監視されているときに電話の向きが変わります。
イベントパラメーター:
[
number] x: x 方向の重力の大きさ。有効値の範囲:[-1, 1]。[
number] y: y 方向の重力の大きさ。有効値の範囲:[-1, 1]。[
number] z: z 方向の重力の大きさ。有効値の範囲:[-1, 1]。
document.addEventListener('motion.gyro', function(e) {
alert ('電話の向きの変化が検知されました。');
}, false);
var params = {
// ジャイロスコープの監視を有効または無効にします。
on: true,
// ジャイロスコープイベントの間隔。
frequency: 100
};
window.WindVane.call('WVMotion', 'listenGyro', params, function(e) {
alert('success');
}, function(e) {
alert('failure:' + JSON.stringify(e));
});
WVMotion.listeningShake
シェイクジェスチャの監視を有効または無効にします。
入力パラメーター
[
boolean]on: シェイクジェスチャの監視を有効にするかどうかを指定します。trueは監視が有効になっていることを示し、falseは監視が無効になっていることを示します。[
number]frequency: オプション。シェイクイベント間の最小間隔。デフォルト値は500です。単位:ミリ秒。シェイクイベントの間隔は、常にこのパラメーター値よりも大きくなります。[
number]shakeThreshold: オプション。シェイクジェスチャを識別するために使用される加速度のしきい値。シェイクジェスチャは、シェイク加速度がしきい値を超えた場合にのみ有効です。デフォルト値:1.2。[
number]shakeNum: オプション。シェイクイベントの生成に使用されるシェイクジェスチャの数。デフォルト値:1。
コールバックパラメーター
コールバックパラメーターはありません。シェイクジェスチャの監視が有効または無効になっている場合、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。
イベントリスニング
motion.shake: シェイクジェスチャが監視されているときに、ユーザーが電話を振ります。
イベントパラメーター:
[
number] x: x 方向の加速度。[
number] y: y 方向の加速度。[
number] z: z 方向の加速度。
document.addEventListener('motion.shake', function(e) {
alert ('シェイクジェスチャが検知されました。');
}, false);
var params = {
// シェイクジェスチャの監視を有効または無効にします。
on: true
};
window.WindVane.call('WVMotion', 'listeningShake', params, function(e) {
alert('success');
}, function(e) {
alert('failure: ' + JSON.stringify(e));
})
WVMotion.vibrate
電話を振動させます。
入力パラメーター
[
int]duration: オプション。振動の継続時間。単位:ミリ秒。オペレーティングシステムは、デフォルトでパラメーター値を決定します。このパラメーターは WindVane Android でのみ使用可能であり、一部のデバイスモデルでは無効になる場合があります。
コールバックパラメーター
コールバックパラメーターはありません。この API 操作は常に success コールバックを呼び出します。
window.WindVane.call('WVMotion', 'vibrate', {});
var params = {
// 振動の継続時間。
duration: 7000
};
window.WindVane.call('WVMotion', 'vibrate', params);
WVMotion.startAccelerometer
この API は、WindVane Android 1.0.3.4 以降でのみ使用可能です。
加速度データをリッスンします。
入力パラメーター
[
string] interval: オプション。加速度のコールバック関数が監視される間隔。デフォルト値:'normal'。有効な値:ui: UI が更新されるコールバック間隔。パラメーター値は約 60 ミリ秒です。
game: ゲームが更新されるコールバック間隔。パラメーター値は約 20 ミリ秒です。
normal: 通常のコールバック間隔。パラメーター値は約 200 ミリ秒です。
コールバックパラメーター
成功コールバックのパラメーター:
コールバックパラメーターはありません。
失敗コールバックのパラメーター:
[
string] msg: 失敗に関するメッセージ。
イベントリスニング
WVMotion.Event.accelerometer
加速度データを取得します。
イベントパラメーター:
[
float] x: x 軸のデータ。[
float] y: y 軸のデータ。[
float] z: z 軸のデータ。
document.addEventListener('WVMotion.Event.accelerometer', function (e) {
alert('event accelerometer: ' + JSON.stringify(e.param));
});
var params = {
interval: 'normal'
};
window.WindVane.call('WVMotion', 'startAccelerometer', params, function(e) {
}, function(e) {
alert('startAccelerometer failure: ' + JSON.stringify(e));
});WVMotion.stopAccelerometer
この API は、WindVane Android 1.0.3.4 以降でのみ使用可能です。
加速度データのリッスンを停止します。
入力パラメーター
入力パラメーターはありません。
コールバックパラメーター
コールバックパラメーターはありません。この API 操作は常に success コールバックを呼び出します。
window.WindVane.call('WVMotion', 'stopAccelerometer', {});WVMotion.startCompass
この API は、WindVane Android 1.0.3.4 以降でのみ使用可能です。
コンパスデータをリッスンします。
入力パラメーター
[
string] interval: オプション。加速度データのコールバック関数が監視される間隔。デフォルト値:'normal'。有効な値:ui: UI が更新されるコールバック間隔。パラメーター値は約 60 ミリ秒です。
game: ゲームが更新されるコールバック間隔。パラメーター値は約 20 ミリ秒です。
normal: 通常のコールバック間隔。パラメーター値は約 200 ミリ秒です。
コールバックパラメーター
成功コールバックのパラメーター:
コールバックパラメーターはありません。
失敗コールバックのパラメーター:
[
string] msg: 失敗に関するメッセージ。
イベントリスニング
WVMotion.Event.compass
コンパスデータを取得します。
イベントパラメーター:
[
float] direction: 向いている方向と真北の方向の間の角度。有効値の範囲:[0, 360)。[
long] timestamp: タイムスタンプ。
document.addEventListener('WVMotion.Event.compass', function (e) {
alert('event compass: ' + JSON.stringify(e.param));
});
var params = {
interval: 'normal'
};
window.WindVane.call('WVMotion', 'startCompass', params, function(e) {
}, function(e) {
alert('startCompass failure: ' + JSON.stringify(e));
});WVMotion.stopCompass
この API は、WindVane Android 1.0.3.4 以降でのみ使用可能です。
コンパスデータのリッスンを停止します。
入力パラメーター
入力パラメーターはありません。
コールバックパラメーター
コールバックパラメーターはありません。この API 操作は常に success コールバックを呼び出します。
window.WindVane.call('WVMotion', 'stopCompass', {});