音声出力デバイス API

sinkId、型は DOMString、readonly

この属性は、出力が届けられている音声デバイスの ID、 または出力がユーザーエージェントのデフォルトデバイスを通じて届けられている場合は 空文字列を含みます。空でない場合、この ID は、 enumerateDevices() から返される MediaDeviceInfo 値のいずれかの deviceId 属性と等しくなければなりません。

取得時には、 属性は [[SinkId]] スロットの値を返さなければなりません（MUST）。

setSinkId

アプリケーションが特定の デバイスから再生出力することを許可されている場合に、音声出力がレンダリングされるべき音声デバイスの ID を設定します。

このメソッドが呼び出されたとき、ユーザーエージェントは次の ステップを実行しなければなりません。

1. globalObject を、 現在の設定オブジェクトの 関連するグローバルオブジェクトとします。

2. document を globalObject の 関連付けられた Document とします。

3. document が 使用を許可されていない場合、識別子が "speaker-selection" である機能について、 名前が NotAllowedError である新しい DOMException で却下された promise を返します。

4. globalObject が一時的な 活性化を持たない場合、 ユーザーエージェントは、name 属性の値が InvalidStateError である DOMException オブジェクトで却下された promise を返してもよい（MAY）。

5. element を、このメソッドが呼び出された HTMLMediaElement オブジェクトとします。

6. sinkId をメソッドの最初の引数とします。

7. sinkId が element の [[SinkId]] と等しい場合、 undefined で解決された promise を返します。

8. p を新しい promise とします。

9. 次の下位ステップを並列に実行します。

   1. sinkId が空文字列ではなく、 enumerateDevices() により提供される結果によって識別されるどの音声出力デバイスにも一致しない場合、 p を、名前が NotFoundError である新しい DOMException で却下し、 これらの下位ステップを中止します。

   2. sinkId が空文字列ではなく、かつ そのデバイスが現在のユーザーエージェントのデフォルトデバイスでないとした場合に、 アプリケーションが sinkId により識別されるデバイスを通じて 音声を再生出力することを許可されない場合、p を、 名前が NotAllowedError である新しい DOMException で却下し、 これらの下位ステップを中止します。

   3. element の基礎となる音声出力デバイスを、 sinkId によって識別される音声デバイスに切り替えます。

      注記

      この下位ステップが成功し、かつメディア 要素の paused 属性が false である場合、音声は要素の sinkId 属性によって表されるデバイスからの再生を停止しなければならず（MUST）、 sinkId によって識別されるデバイスから 再生を開始します

   4. 前の下位ステップが失敗した場合、p を、 名前が AbortError である新しい DOMException で却下し、 これらの下位ステップを中止します。

   5. 次のステップを実行するタスクをキューに入れます。

      1. element の [[SinkId]] を sinkId に設定します。

      2. p を解決します。

10. p を返します。

selectAudioOutput

特定の音声出力デバイスを選択するようユーザーに促します。

selectAudioOutput メソッドが呼び出されたとき、 ユーザーエージェントは 次のステップを実行しなければなりません（MUST）。

1. this の 関連する グローバルオブジェクトが 一時的な 活性化を持たない場合、 name 属性の値が InvalidStateError である DOMException オブジェクトで却下された promise を返します。

2. options をメソッドの最初の引数とします。

3. deviceId を options.deviceId とします。

4. mediaDevices を this とします。

5. p を新しい promise とします。

6. 次のステップを並列に実行します。

   1. descriptor を、PermissionDescriptor とし、その name を "speaker-selection" に設定します

   2. descriptor の permission state が "denied" である場合、 p を、 name 属性の値が NotAllowedError である新しい DOMException で却下し、 これらのステップを中止します。

   3. 利用可能な音声出力デバイスについて、 ユーザーエージェントを 探査します。

   4. 音声出力デバイスが存在しない場合、p を、 name 属性の値が NotFoundError である新しい DOMException で却下し、 これらのステップを中止します。

   5. deviceId が "" でない場合、次の下位ステップを実行します。

      1. deviceId が、 この閲覧セッションまたは以前の閲覧 セッションで selectAudioOutput によって以前に公開されたデバイス id と一致する場合、または この閲覧セッションまたは以前の閲覧 セッションで getUserMedia() によって以前に公開された音声入力デバイスと同じ groupId を持つ音声出力デバイスの デバイス id と一致する場合、 ユーザーエージェントは、この起源の集合に対してこの id を永続化するかどうかについての 以前の判断に基づき、次の下位ステップを実行することを決定してもよい（MAY）。

         1. device を、 利用可能であれば deviceId によって識別されるデバイスとします。

         2. device が利用可能である場合、 p を deviceId または device のために新たにローテーションされたデバイス id のいずれかで解決し、 並列ステップを中止します。

   6. descriptor とともに、 音声出力デバイスを 選択するようユーザーに促します。

   7. 要求の結果が "denied" である場合、 p を、 name 属性の値が NotAllowedError である新しい DOMException で却下し、 これらのステップを中止します。

   8. selectedDevice を、ユーザーが選択した音声出力デバイスとします。

   9. deviceInfo を、 selectedDevice を表すために デバイス情報オブジェクトを作成する結果とし、 mediaDevices を用います。

   10. deviceInfo.deviceId を [[explicitlyGrantedAudioOutputDevices]] に追加します。

   11. p を deviceInfo で解決します。

7. p を返します。

selectAudioOutput の呼び出し後にデバイスが公開されたら、 それは現在の閲覧コンテキストに対して enumerateDevices() によって列挙されなければなりません（MUST）。

selectAudioOutput によって返された promise が 解決された場合、 ユーザーエージェントは、文書がただちに 再生を許可された状態で HTMLMediaElement においてメディアを再生でき、かつただちに 開始を許可された状態で AudioContext を開始できるようにしなければなりません（MUST）。 追加のユーザージェスチャーは不要です。

注記

これは、ブラウザーにおける autoplay の標準化が現在不足しているため、不正確です。

この辞書は、音声出力デバイスへの アクセスを取得するために使用できるオプションを記述します。

WebIDLdictionary AudioOutputOptions {
  DOMString deviceId = "";
};