ThesetSinkId() method of theAudioContext interface sets the output audio device for theAudioContext. If a sink ID is not explicitly set, the default system audio output device will be used.

To set the audio device to a device different than the default one, the developer needs permission to access to audio devices. If required, the user can be prompted to grant the required permission via aMediaDevices.getUserMedia() call.

In addition, this feature may be blocked by aspeaker-selectionPermissions Policy.

Syntax

setSinkId(sinkId)

Parameters

sinkId

The sink ID of the device you want to set as the output audio device. This can take one of the following value types:

String

A string representing the sink ID, retrieved for example via thedeviceId property of theMediaDeviceInfo objects returned byMediaDevices.enumerateDevices().

AudioSinkOptions

An object representing different options for a sink ID. Currently this takes a single property,type, with a value ofnone. Setting this parameter causes the audio to be processed without being played through any audio output device. This is a useful option to minimize power consumption when you don't need playback along with processing.

Return value

APromise that fulfills with a value ofundefined.

Attempting to set the sink ID to its existing value (i.e., returned byAudioContext.sinkId), throws no errors, but it aborts the process immediately.

Exceptions

InvalidAccessErrorDOMException

Thrown if accessing the selected audio output device failed.

NotAllowedErrorDOMException

Thrown if the browser does not have permission to access audio devices.

NotFoundErrorDOMException

Thrown if the passedsinkId does not match any audio device found on the system.

Examples

In ourSetSinkId test example (check out thesource code), we create an audio graph that generates a three-second burst of white noise via anAudioBufferSourceNode, which we also run through aGainNode to quiet things down a bit.

mediaDeviceBtn.addEventListener("click", async () => {  if ("setSinkId" in AudioContext.prototype) {    selectDiv.textContent = "";    const stream = await navigator.mediaDevices.getUserMedia({      audio: true,    });    const devices = await navigator.mediaDevices.enumerateDevices();    // Most of the DOM scripting to generate the dropdown cut out for brevity    const audioOutputs = devices.filter(      (device) =>        device.kind === "audiooutput" && device.deviceId !== "default",    );    audioOutputs.forEach((device) => {      const option = document.createElement("option");      option.value = device.deviceId;      option.textContent = device.label;      select.appendChild(option);    });    const option = document.createElement("option");    option.value = "none";    option.textContent = "None";    select.appendChild(option);    select.addEventListener("change", async () => {      if (select.value === "none") {        await audioCtx.setSinkId({ type: "none" });      } else {        await audioCtx.setSinkId(select.value);      }    });  }});

We also provide the user with a dropdown menu to allow them to change the audio output device on the fly. To do this, we:

1. Provide a button to populate the dropdown menu. We first invokeMediaDevices.getUserMedia() to trigger the permissions prompt we need to allow device enumeration, then useMediaDevices.enumerateDevices() to get all the available devices. We loop through the different devices and make each one available as an option in a<select> element. We also create a "None" option for the case where you don't want to play your audio in any output.
2. Add achange event listener to the<select> element to change the sink ID and therefore the audio output device when a new value is selected. If "None" is selected in the dropdown, we invokesetSinkId() with the{ type : 'none' } object parameter to select no audio device, otherwise we run it with the audio device ID contained in the<select> elementvalue attribute as the parameter.

The output device can be changed during audio playback, as well as before, or between plays.

Specifications

Browser compatibility

See also

• Change the destination output device in Web Audio
• AudioContext.sinkId
• sinkchange