AudioContext: phương thức setSinkId()

Cú pháp

setSinkId(sinkId)

Tham số

sinkId

Sink ID của thiết bị mà bạn muốn đặt làm thiết bị đầu ra âm thanh. Giá trị này có thể thuộc một trong các kiểu sau:

String

Một chuỗi biểu diễn sink ID, ví dụ được lấy qua thuộc tính deviceId của các đối tượng MediaDeviceInfo được trả về bởi MediaDevices.enumerateDevices().

AudioSinkOptions

Một đối tượng biểu diễn các tùy chọn khác nhau cho sink ID. Hiện tại đối tượng này chỉ có một thuộc tính là type với giá trị none. Việc thiết lập tham số này khiến âm thanh được xử lý mà không phát qua bất kỳ thiết bị đầu ra âm thanh nào. Đây là một lựa chọn hữu ích để giảm tiêu thụ điện năng khi bạn không cần phát lại cùng với xử lý.

Giá trị trả về

Một Promise hoàn tất với giá trị undefined.

Việc cố đặt sink ID thành chính giá trị hiện có của nó (tức giá trị được trả về bởi AudioContext.sinkId) sẽ không ném lỗi, nhưng quá trình sẽ bị hủy ngay lập tức.

Ngoại lệ

InvalidAccessError DOMException

Được ném ra nếu việc truy cập thiết bị đầu ra âm thanh đã chọn thất bại.

NotAllowedError DOMException

Được ném ra nếu trình duyệt không có quyền truy cập các thiết bị âm thanh.

NotFoundError DOMException

Được ném ra nếu sinkId được truyền vào không khớp với bất kỳ thiết bị âm thanh nào được tìm thấy trên hệ thống.

Ví dụ

Trong ví dụ kiểm thử SetSinkId của chúng tôi (hãy xem mã nguồn), chúng tôi tạo một đồ thị âm thanh sinh ra một đoạn white noise dài ba giây bằng AudioBufferSourceNode, đồng thời cho nó đi qua một GainNode để giảm âm lượng bớt.

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

Chúng tôi cũng cung cấp cho người dùng một menu thả xuống để cho phép họ thay đổi thiết bị đầu ra âm thanh ngay lập tức. Để làm điều này, chúng tôi:

1. Cung cấp một nút để điền dữ liệu vào menu thả xuống. Đầu tiên chúng tôi gọi MediaDevices.getUserMedia() để kích hoạt hộp thoại xin quyền cần thiết cho phép liệt kê thiết bị, rồi dùng MediaDevices.enumerateDevices() để lấy tất cả thiết bị khả dụng. Chúng tôi lặp qua các thiết bị khác nhau và biến từng thiết bị thành một tùy chọn trong phần tử <select>. Chúng tôi cũng tạo thêm tùy chọn "None" cho trường hợp bạn không muốn phát âm thanh ra bất kỳ đầu ra nào.
2. Thêm trình nghe sự kiện change vào phần tử <select> để thay đổi sink ID và do đó thay đổi thiết bị đầu ra âm thanh khi một giá trị mới được chọn. Nếu "None" được chọn trong menu, chúng tôi gọi setSinkId() với tham số đối tượng { type : 'none' } để không chọn thiết bị âm thanh nào; nếu không, chúng tôi gọi nó với ID thiết bị âm thanh chứa trong thuộc tính value của phần tử <select>.

Thiết bị đầu ra có thể được thay đổi trong khi đang phát âm thanh, cũng như trước hoặc giữa các lần phát.

Thông số kỹ thuật

Tương thích trình duyệt

Xem thêm

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