HTMLMediaElement.setSinkId()
Experimental
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
Parameters
- sinkId
- The
MediaDeviceInfo.deviceIdof the audio output device.
Exceptions
| Exception | Explanation |
|---|---|
DOMException |
No permission to use the requested device |
Examples
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
BCD tables only load in the browser