AudioContext: setSinkId() Methode

Syntax

setSinkId(sinkId)

Parameter

sinkId

Die Sink-ID des Geräts, das Sie als Ausgabe-Audiogerät festlegen möchten. Dies kann einer der folgenden Wertetypen sein:

String

Ein String, der die Sink-ID repräsentiert, z. B. über die deviceId-Eigenschaft der MediaDeviceInfo-Objekte, die von MediaDevices.enumerateDevices() zurückgegeben werden.

AudioSinkOptions

Ein Objekt, das verschiedene Optionen für eine Sink-ID darstellt. Derzeit nimmt dies eine einzelne Eigenschaft, type, mit dem Wert none an. Wenn dieser Parameter gesetzt wird, wird das Audio verarbeitet, ohne dass es über ein Audiogerät abgespielt wird. Dies ist eine nützliche Option, um den Stromverbrauch zu minimieren, wenn keine Wiedergabe zusammen mit der Verarbeitung benötigt wird.

Rückgabewert

Ein Promise, das mit einem Wert von undefined erfüllt wird.

Der Versuch, die Sink-ID auf ihren vorhandenen Wert zu setzen (d.h. zurückgegeben von AudioContext.sinkId), wirft keine Fehler, sondern bricht den Vorgang sofort ab.

Ausnahmen

InvalidAccessError DOMException

Wird ausgelöst, wenn der Zugriff auf das ausgewählte Audioausgabegerät fehlschlägt.

NotAllowedError DOMException

Wird ausgelöst, wenn der Browser keine Berechtigung zum Zugriff auf Audiogeräte hat.

NotFoundError DOMException

Wird ausgelöst, wenn die übergebene sinkId keinem der auf dem System gefundenen Audiogeräte entspricht.

Beispiele

In unserem SetSinkId-Testbeispiel (sehen Sie sich den Quellcode an), erstellen wir einen Audiografen, der einen dreisekündigen Burst von Weißem Rauschen über einen AudioBufferSourceNode erzeugt, den wir auch durch einen GainNode leiten, um die Lautstärke etwas zu senken.

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);
      }
    });
  }
});

Wir bieten dem Benutzer auch ein Dropdown-Menü, um das Audioausgabegerät dynamisch zu ändern. Dazu:

1. Stellen wir eine Schaltfläche bereit, um das Dropdown-Menü zu füllen. Wir rufen zuerst MediaDevices.getUserMedia() auf, um die erforderliche Berechtigungsaufforderung auszulösen, die wir für die Geräteliste benötigen, und verwenden dann MediaDevices.enumerateDevices(), um alle verfügbaren Geräte zu erhalten. Wir durchlaufen die verschiedenen Geräte und machen jedes als Option in einem <select>-Element verfügbar. Wir erstellen auch eine "None"-Option für den Fall, dass Sie Ihr Audio in keinem Ausgabegerät abspielen möchten.
2. Fügen wir dem <select>-Element einen change-Event-Listener hinzu, um die Sink-ID und damit das Audioausgabegerät zu wechseln, wenn ein neuer Wert ausgewählt wird. Wenn im Dropdown-Menü "None" ausgewählt wird, rufen wir setSinkId() mit dem { type : 'none' }-Objektparameter auf, um kein Audiogerät auszuwählen, andernfalls führen wir es mit der im <select>-Element enthaltenen Audio-Geräte-ID im value-Attribut als Parameter aus.

Das Ausgabegerät kann während der Audiowiedergabe, sowie davor oder zwischen Wiedergaben geändert werden.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Ändern des Zielausgabegeräts in Web Audio
• AudioContext.sinkId
• sinkchange