HTMLMediaElement: setSinkId() メソッド

構文

setSinkId(sinkId) 

引数

sinkId

オーディオ出力機器の MediaDeviceInfo.deviceId です。

返値

Promise で、 undefined に解決します。

例外

NotAllowedError DOMException

speaker-selection 権限ポリシーが音声出力の使用をブロックするために使用された場合に返されます。

NotFoundError DOMException

deviceId がどの音声機器にも一致しない場合に返されます。

AbortError DOMException

音声出力機器から新しい音声機器への切り替えに失敗した場合に返されます。

セキュリティ要件

この API にアクセスするには、以下の制約があります。

• このメソッドは保護されたコンテキストの中で呼び出すこと。
• アクセスが speaker-selection HTTP 権限ポリシーで制限されることがあります。
• 既定以外の端末にアクセスするには、そのユーザー権限が要求されます。 ユーザーは、MediaDevices.selectAudioOutput() で表示されるプロンプトで、ID に関連付けられた端末を選択することで、その権限を付与します。

例

この例では、MediaDevices.enumerateDevices() が返す配列から音声出力機器を選択し、それを音声のシンクとして設定する方法を示します。 enumerateDevices() の結果には、ユーザー権限が要求されていないか、すでに付与されている端末しか含まれないことに注意してください。

const devices = await navigator.mediaDevices.enumerateDevices(); const audioDevice = devices.find((device) => device.kind === "audiooutput"); const audio = document.createElement("audio"); await audio.setSinkId(audioDevice.deviceId); console.log(`Audio is being output on ${audio.sinkId}`); 

仕様書

ブラウザーの互換性

関連情報

• オーディオ出力機器 API
• MediaDevices.selectAudioOutput()
• HTMLMediaElement.sinkId