chrome.audio

Nội dung mô tả

API chrome.audio được cung cấp để cho phép người dùng nhận thông tin và điều khiển các thiết bị âm thanh đi kèm với hệ thống. API này hiện chỉ có ở chế độ kiosk dành cho ChromeOS.

Quyền

audio

Phạm vi cung cấp

Chrome 59 trở lên Chỉ dành cho ChromeOS

Loại

AudioDeviceInfo

Thuộc tính

  • deviceName

    string

    Tên thiết bị.

  • deviceType

    DeviceType

    Loại thiết bị.

  • displayName

    string

    Tên thân thiện với người dùng (ví dụ: "Micrô USB").

  • id

    string

    Giá trị nhận dạng duy nhất của thiết bị âm thanh.

  • isActive

    boolean

    Đúng nếu đây là thiết bị hiện đang hoạt động.

  • cấp lần truy cập,

    number

    Mức âm thanh của thiết bị, âm lượng cho đầu ra, mức tăng âm cho đầu vào.

  • stableDeviceId

    chuỗi không bắt buộc

    Chuỗi mã nhận dạng thiết bị cố định/cố định (nếu có).

  • streamType

    StreamType

    Loại luồng liên kết với thiết bị này.

DeviceFilter

Thuộc tính

  • isActive

    boolean không bắt buộc

    Nếu bạn đặt chính sách này, chỉ các thiết bị âm thanh có trạng thái hoạt động khớp với giá trị này mới đáp ứng bộ lọc.

  • streamTypes

    StreamType[] không bắt buộc

    Nếu bạn đặt chính sách này, chỉ những thiết bị âm thanh có loại luồng trong danh sách này mới đáp ứng bộ lọc.

DeviceIdLists

Thuộc tính

  • input

    string[] không bắt buộc

    Danh sách thiết bị đầu vào được chỉ định theo mã nhận dạng.

    Để cho biết thiết bị đầu vào sẽ không bị ảnh hưởng, hãy không đặt thuộc tính này.

  • output

    string[] không bắt buộc

    Danh sách các thiết bị đầu ra được chỉ định theo mã nhận dạng.

    Để cho biết thiết bị đầu ra sẽ không bị ảnh hưởng, hãy không đặt thuộc tính này.

DeviceProperties

Thuộc tính

  • cấp lần truy cập,

    số không bắt buộc

    Mức âm thanh mong muốn của thiết bị âm thanh. Mức âm thanh mặc định là mức âm thanh hiện tại của thiết bị.

    Nếu dùng cùng với thiết bị đầu vào âm thanh, hãy biểu thị mức tăng của thiết bị âm thanh.

    Nếu dùng với thiết bị đầu ra âm thanh, hãy thể hiện âm lượng của thiết bị âm thanh.

DeviceType

Các loại thiết bị âm thanh hiện có.

Liệt kê

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"FRONT_MIC"

"REAR_MIC"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"OTHER"

LevelChangedEvent

Thuộc tính

  • deviceId

    string

    Mã nhận dạng của thiết bị có mức âm thanh đã thay đổi.

  • cấp lần truy cập,

    number

    Mức âm thanh mới của thiết bị.

MuteChangedEvent

Thuộc tính

  • isMuted

    boolean

    Liệu sự kiện trực tiếp hiện đã bị tắt tiếng hay chưa.

  • streamType

    StreamType

    Loại luồng mà giá trị tắt tiếng đã thay đổi. Giá trị tắt tiếng mới cập nhật sẽ áp dụng cho tất cả thiết bị có loại luồng này.

StreamType

Loại luồng mà thiết bị âm thanh cung cấp.

Liệt kê

"INPUT"

"OUTPUT"

Phương thức

getDevices()

Cam kết 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

Lấy danh sách các thiết bị âm thanh được lọc dựa trên filter.

Tham số

  • filter

    DeviceFilter (Bộ lọc thiết bị) không bắt buộc

    Thuộc tính thiết bị dùng để lọc danh sách các thiết bị âm thanh được trả về. Nếu bạn không đặt hoặc đặt bộ lọc thành {}, thì danh sách thiết bị được trả về sẽ chứa tất cả thiết bị âm thanh hiện có.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (devices: AudioDeviceInfo[])=>void

Giá trị trả về

  • Promise<AudioDeviceInfo[]>

    Chrome 116 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp để có khả năng tương thích ngược. Bạn không thể sử dụng cả hai trong cùng một lệnh gọi hàm. Lời hứa sẽ được phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

getMute()

Cam kết 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

Lấy trạng thái tắt tiếng trên toàn hệ thống cho loại luồng được chỉ định.

Tham số

  • streamType

    StreamType

    Loại luồng mà hệ thống sẽ tìm nạp trạng thái tắt tiếng.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (value: boolean)=>void

    • value

      boolean

Giá trị trả về

  • Promise<boolean>

    Chrome 116 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp để có khả năng tương thích ngược. Bạn không thể sử dụng cả hai trong cùng một lệnh gọi hàm. Lời hứa sẽ được phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

setActiveDevices()

Cam kết 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

Đặt danh sách các thiết bị đầu vào và/hoặc đầu ra đang hoạt động.

Tham số

  • Chỉ định mã nhận dạng của các thiết bị sẽ hoạt động. Nếu bạn không thiết lập danh sách đầu vào hoặc đầu ra, thì các thiết bị trong danh mục đó sẽ không bị ảnh hưởng.

    Sẽ là lỗi khi chuyển mã thiết bị không tồn tại.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    ()=>void

Giá trị trả về

  • Promise<void>

    Chrome 116 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp để có khả năng tương thích ngược. Bạn không thể sử dụng cả hai trong cùng một lệnh gọi hàm. Lời hứa sẽ được phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

setMute()

Cam kết 
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

Đặt trạng thái tắt tiếng cho một loại luồng. Trạng thái tắt tiếng sẽ áp dụng cho tất cả thiết bị âm thanh thuộc loại luồng âm thanh đã chỉ định.

Tham số

  • streamType

    StreamType

    Loại luồng mà bạn phải đặt trạng thái tắt tiếng.

  • isMuted

    boolean

    Giá trị ẩn mới.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    ()=>void

Giá trị trả về

  • Promise<void>

    Chrome 116 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp để có khả năng tương thích ngược. Bạn không thể sử dụng cả hai trong cùng một lệnh gọi hàm. Lời hứa sẽ được phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

setProperties()

Cam kết 
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

Đặt các thuộc tính cho thiết bị đầu vào hoặc thiết bị đầu ra.

Tham số

  • id

    string

  • các tài sản

    DeviceProperties

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    ()=>void

Giá trị trả về

  • Promise<void>

    Chrome 116 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp để có khả năng tương thích ngược. Bạn không thể sử dụng cả hai trong cùng một lệnh gọi hàm. Lời hứa sẽ được phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

Sự kiện

onDeviceListChanged

chrome.audio.onDeviceListChanged.addListener(
  callback: function,
)

Được kích hoạt khi thiết bị âm thanh thay đổi, thiết bị mới được thêm vào hoặc thiết bị hiện có bị xoá.

Tham số

onLevelChanged

chrome.audio.onLevelChanged.addListener(
  callback: function,
)

Được kích hoạt khi mức âm thanh thay đổi đối với thiết bị âm thanh đang hoạt động.

Tham số

onMuteChanged

chrome.audio.onMuteChanged.addListener(
  callback: function,
)

Được kích hoạt khi trạng thái tắt tiếng của đầu vào hoặc đầu ra âm thanh thay đổi. Xin lưu ý rằng trạng thái tắt tiếng được áp dụng trên toàn hệ thống và giá trị mới áp dụng cho mọi thiết bị âm thanh có loại luồng được chỉ định.

Tham số