AudioSinkInfo

{{APIRef("Web Audio API")}}{{SeeCompatTable}}

The AudioSinkInfo interface of the {{domxref("Web Audio API", "Web Audio API", "", "nocode")}} represents information describing an {{domxref("AudioContext")}}'s sink ID, retrieved via {{domxref("AudioContext.sinkId")}}.

{{InheritanceDiagram}}

Instance properties

• {{domxref("AudioSinkInfo.type", "type")}} {{ReadOnlyInline}} {{Experimental_Inline}}
  • : Returns the type of the audio output device.

Examples

If a new {{domxref("AudioContext")}} is created with a sinkId value of { type: 'none' }, calling {{domxref("AudioContext.sinkId")}} later in the code will return an AudioSinkInfo object containing type: 'none'. This is currently the only value available.

audioCtx = new window.AudioContext({
  sinkId: { type: "none" },
});

// …

audioCtx.sinkId;

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• SetSinkId test example (check out the source code)
• {{domxref("AudioContext.setSinkId()")}}
• {{domxref("AudioContext.sinkId")}}
• {{domxref("AudioContext/sinkchange_event", "sinkchange")}}