chrome.audio

Deskripsi

chrome.audio API disediakan untuk memungkinkan pengguna mendapatkan informasi dan mengontrol perangkat audio yang terpasang ke sistem. API ini saat ini hanya tersedia dalam mode kios untuk ChromeOS.

Izin

audio

Ketersediaan

Chrome 59 dan yang lebih baru Khusus ChromeOS

Jenis

AudioDeviceInfo

Properti

  • deviceName

    string

    Nama perangkat.

  • deviceType

    DeviceType

    Jenis perangkat.

  • Nama Tampilan

    string

    Nama yang mudah digunakan (misalnya, "Mikrofon USB").

  • id

    string

    ID unik perangkat audio.

  • isActive

    boolean

    True jika ini adalah perangkat yang aktif saat ini.

  • yaitu tingkat klik

    angka

    Level suara perangkat, volume untuk output, penguatan untuk input.

  • stableDeviceId

    string opsional

    String ID perangkat yang stabil/tetap jika tersedia.

  • streamType

    StreamType

    Jenis streaming yang terkait dengan perangkat ini.

DeviceFilter

Properti

  • isActive

    boolean opsional

    Jika disetel, hanya perangkat audio dengan status aktif yang cocok dengan nilai ini yang akan memenuhi filter.

  • streamTypes

    StreamType[] opsional

    Jika disetel, hanya perangkat audio yang jenis streamingnya disertakan dalam daftar ini yang akan memenuhi filter.

DeviceIdLists

Properti

  • input

    string[] opsional

    Daftar perangkat input yang ditentukan oleh ID-nya.

    Untuk menunjukkan bahwa perangkat input tidak akan terpengaruh, biarkan properti ini tidak disetel.

  • hasil

    string[] opsional

    Daftar perangkat output yang ditentukan oleh ID-nya.

    Untuk menunjukkan bahwa perangkat output tidak akan terpengaruh, biarkan properti ini tidak disetel.

DeviceProperties

Properti

  • yaitu tingkat klik

    angka opsional

    Level suara yang diinginkan perangkat audio. Setelan default-nya adalah tingkat suara perangkat saat ini.

    Jika digunakan dengan perangkat input audio, mewakili peningkatan perangkat audio.

    Jika digunakan dengan perangkat output audio, mewakili volume perangkat audio.

DeviceType

Jenis perangkat audio yang tersedia.

Enum

"HEADPHONE"

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_PEMBICARA"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"HOTWORD"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"OTHER"

LevelChangedEvent

Properti

  • deviceId

    string

    ID perangkat yang level suaranya telah berubah.

  • yaitu tingkat klik

    angka

    Level suara baru perangkat.

MuteChangedEvent

Properti

  • isMuted

    boolean

    Apakah streaming sekarang dibisukan atau tidak.

  • streamType

    StreamType

    Jenis streaming yang nilai bisukannya diubah. Nilai pembisuan yang diperbarui berlaku untuk semua perangkat dengan jenis streaming ini.

StreamType

Jenis streaming yang disediakan perangkat audio.

Enum

"INPUT"

"OUTPUT"

Metode

getDevices()

Janji 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

Mendapatkan daftar perangkat audio yang difilter berdasarkan filter.

Parameter

  • filter

    DeviceFilter opsional

    Properti perangkat yang digunakan untuk memfilter daftar perangkat audio yang ditampilkan. Jika filter tidak disetel atau disetel ke {}, daftar perangkat yang ditampilkan akan berisi semua perangkat audio yang tersedia.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (devices: AudioDeviceInfo[]) => void

Hasil

  • Promise<AudioDeviceInfo[]>

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

getMute()

Janji 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

Mendapatkan status pembisuan seluruh sistem untuk jenis streaming yang ditentukan.

Parameter

  • streamType

    StreamType

    Jenis streaming yang harus diambil status nonaktifnya.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (value: boolean) => void

    • nilai

      boolean

Hasil

  • Promise<boolean>

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

setActiveDevices()

Janji 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

Menetapkan daftar perangkat input dan/atau output aktif.

Parameter

  • Menentukan ID perangkat yang harus aktif. Jika daftar input atau output tidak disetel, perangkat dalam kategori tersebut tidak akan terpengaruh.

    Meneruskan ID perangkat yang tidak ada merupakan kesalahan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    () => void

Hasil

  • Janji<void>

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

setMute()

Janji 
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

Menetapkan status pembisuan untuk jenis streaming. Status bisukan akan diterapkan ke semua perangkat audio dengan jenis streaming audio yang ditentukan.

Parameter

  • streamType

    StreamType

    Jenis streaming yang status bisukannya harus ditetapkan.

  • isMuted

    boolean

    Nilai bisukan baru.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    () => void

Hasil

  • Janji<void>

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

setProperties()

Janji 
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

Menetapkan properti untuk perangkat input atau output.

Parameter

  • id

    string

  • properti

    DeviceProperties

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    () => void

Hasil

  • Janji<void>

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

Acara

onDeviceListChanged

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

Diaktifkan saat perangkat audio berubah, baik perangkat baru ditambahkan, atau perangkat yang ada dihapus.

Parameter

onLevelChanged

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

Diaktifkan saat level suara berubah untuk perangkat audio yang aktif.

Parameter

onMuteChanged

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

Diaktifkan jika status bisukan input atau output audio berubah. Perlu diperhatikan bahwa status bisukan diterapkan di seluruh sistem dan nilai baru berlaku untuk setiap perangkat audio dengan jenis streaming tertentu.

Parameter