バイブレーション API

規範的ではないと記載されたセクションに加え、本仕様のすべての著作ガイドライン、図、例、および注記は規範的ではありません。それ以外はすべて規範的です。

この文書で使用されるキーワード MAY、MUST、および SHOULD は、BCP 14 [RFC2119] [RFC8174] に従って解釈されるべきです。これらのキーワードは、すべて大文字で表記されている場合にのみ、上記のように使用されます。

本仕様は、含まれるインターフェースを実装するユーザーエージェントという単一製品に適合性要件を定義します。

本仕様で定義されたAPIをECMAScriptで実装する場合、Web IDL仕様 [WEBIDL-1] に従い、同仕様のバインディングと用語に一貫して従う必要があります。

WebIDLtypedef (unsigned long or sequence<unsigned long>) VibratePattern;

partial interface Navigator {
    boolean vibrate (VibratePattern pattern);
};

vibrate() メソッドの手順は、バイブレーションパターンの処理アルゴリズムを実行することです。 バイブレーションパターンは VibratePattern オブジェクトとして表現されます。

バイブレーションパターンの処理の規則は、下記のアルゴリズムによります。

1. vibrate() メソッドの第1引数をpatternとします。
2. patternを検証と正規化に渡し、その結果をvalid patternとします。
3. documentのvisibility state が visibleでない場合、falseを返して手順を終了します。
   注

   信頼された（特権）アプリケーションは、OSの機能と密接に統合されている場合、アプリケーションが全く表示されていなくてもデバイスを振動させることができるため、前の手順を無視することがあります。
4. 振動を実行を、thisの関連グローバルオブジェクト とvalid patternで実行します。

検証と正規化を バイブレーションパターンに対してpatternを使って行う場合、次の手順を実行します:

1. patternがリストなら次へ。そうでなければ以下を実行します:
   1. 空リストlistを作成し、patternをlistに追加します。
   2. patternをlistに設定します。
2. max lengthに値10を持たせます。
3. patternの長さがmax lengthより大きければ、最初のmax length個のみ残して切り捨てます。
   注

   patternの長さが偶数かつゼロでない場合、最後のエントリは効果がないため、実装はこの時点でpatternから削除できます。
4. max durationに値10000を持たせます。
5. pattern内の各エントリの値がmax durationより大きい場合、その値をmax durationに設定します。
6. patternを返します。

振動を実行を グローバルオブジェクト globalとバイブレーションパターンpatternで行う場合、次の手順を実行します:

1. globalがsticky activationを持たない場合、 falseを返して手順を終了します。
2. 実装はMAYでfalseを返して手順を終了できます。
   注

   例えば、振動ハードウェアが存在しない、ユーザーが特定のオリジンではデバイスの振動を許可しない設定をしている、またはページが振動できる合計時間を制限し、その超過リクエストを拒否するなど、実装がアルゴリズムを中断する場合があります。
3. 他の 振動を実行 アルゴリズムのインスタンスがすでに実行中の場合、以下のサブステップを実行します：
   1. 他の 振動を実行 アルゴリズムのインスタンスがあれば中断します。
   2. pattern が空リスト、値0の単一エントリを含む、またはデバイスが振動できない場合は true を返してこれらのステップを終了します。
4. trueを返し、以降の手順は非同期で続行します。
5. pattern内の各timeについて、以下を実行します:
   1. timeのインデックスが偶数（最初のエントリは0）、デバイスをtimeミリ秒振動させます。
   2. それ以外の場合はtimeミリ秒待機します。

ユーザーエージェントは、 visibility stateが トップレベル閲覧コンテキストの Documentで変化したと判断した場合、すでに実行中のバイブレーションパターンの処理アルゴリズムを中断しなければなりません。

Vibration API自体はデータの発生源ではなく、Webで消費可能なデータを生成しません。しかし、他のAPIのイベントソースとして利用される可能性が知られています。特に、加速度センサーやジャイロスコープなどの特定のセンサーは、製造時の微細な不完全性により、バイブレーションAPIによる刺激を利用してフィンガープリントの手段となる可能性があります。この意味で、Vibration APIは他の仕組みと組み合わせることで間接的なプライバシーリスクを生じさせます。これには、クロスデバイストラッキングや通信など、予期しないプライバシーリスクが含まれる可能性があります。また、振動しているデバイスは外部の観察者から視認され、ユーザーの物理的な識別や追跡が可能となる場合もあります。

これらの理由から、ユーザーエージェントは API利用時にユーザーへ通知し、オリジンごとまたはグローバルでAPIを無効化（実質的に何も行わない）する手段を提供してもよい（MAY）。

ユーザーエージェントは、 振動リクエストの回数制限（例：1分または1時間ごと）などグローバルなレート制限を用いて過度な利用を防ぐべきです（SHOULD）。