This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The HTMLMediaElement.setSinkId() method sets the ID of the audio device to use for output and returns a Promise. This only works when the application is authorized to use the specified device.
Syntax
HTMLMediaElement.setSinkId(sinkId).then(function() { ... })
Returns
A Promise that resolves to undefined.
Parameters
- sinkId
- The
MediaDeviceInfo.deviceIdof the audio output device.
Exceptions
This function can throw a DOMException (No permission to use requested device).
Example
const devices = await navigator.mediaDevices.enumerateDevices();
const audioDevices = devices.filter(device => device.kind === 'audiooutput');
const audio = document.createElement('audio');
await audio.setSinkId(audioDevices[0].deviceId);
console.log('Audio is being played on ' + audio.sinkId);
Specifications
| Specification | Status | Comment |
|---|---|---|
| Audio Output Devices API The definition of 'sinkId' in that specification. |
Candidate Recommendation | Initial definition. Older versions of this spec were called "Media Capture Output". |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
| Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | 49 | No | ? | ? | ? | ? |
| Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | Opera Android | iOS Safari | Samsung Internet |
|---|---|---|---|---|---|---|---|
| Basic support | 49 | 49 | No | ? | ? | ? | ? |