AudioContext: sinkchange event

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The sinkchange event of the AudioContext interface is fired when the output audio device (and therefore, the AudioContext.sinkId) has changed.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js

addEventListener("sinkchange", (event) => {});

onsinkchange = (event) => {};

Event type

Event.

Examples

A sinkchange event listener can be used to report a change of audio output device. Note that if sinkId contains an AudioSinkInfo object, it indicates that the audio has been changed to not play on any output device.

js

audioCtx.addEventListener("sinkchange", () => {
  if (typeof audioCtx.sinkId === "object" && audioCtx.sinkId.type === "none") {
    console.log("Audio changed to not play on any device");
  } else {
    console.log(`Audio output device changed to ${audioCtx.sinkId}`);
  }
});

See our SetSinkId test example for working code.

Specifications

Specification
Web Audio API
# eventdef-audiocontext-sinkchange

Browser compatibility

BCD tables only load in the browser

See also