browser.audio

חשוב: ה-API הזה פועל רק ב-ChromeOS.

תיאור

‫API של chrome.audio מאפשר למשתמשים לקבל מידע על מכשירי האודיו שמחוברים למערכת ולשלוט בהם. ה-API הזה זמין כרגע רק במצב קיוסק ב-ChromeOS.

הרשאות

audio

זמינות

‫Chrome מגרסה 59 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫ChromeOS בלבד

סוגים

AudioDeviceInfo

מאפיינים

• deviceName

  מחרוזת

  שם המכשיר.

• deviceType

  DeviceType

  סוג המכשיר.

• displayName

  מחרוזת

  השם הידידותי למשתמש (למשל, "מיקרופון USB").

• id [מזהה]

  מחרוזת

  המזהה הייחודי של מכשיר האודיו.

• isActive

  בוליאני

  אם זה המכשיר הפעיל הנוכחי, התנאי מתקיים.

• שלב

  number

  עוצמת הקול של המכשיר, עוצמת הקול של הפלט, הגברת הקלט.

• stableDeviceId

  מחרוזת אופציונלי

  מחרוזת מזהה המכשיר היציב/הקבוע, אם היא זמינה.

• streamType

  StreamType

  סוג השידור שמשויך למכשיר הזה.

DeviceFilter

מאפיינים

• isActive

  בוליאני אופציונלי

  אם המדיניות מוגדרת, רק מכשירי אודיו שהמצב הפעיל שלהם תואם לערך הזה יעמדו בתנאי הסינון.

• streamTypes

  StreamType[] אופציונלי

  אם המדיניות מוגדרת, רק מכשירי אודיו שסוג הסטרימינג שלהם נכלל ברשימה הזו יעמדו בתנאי המסנן.

DeviceIdLists

מאפיינים

• קלט

  string[] אופציונלי

  רשימה של מכשירים לקליטת נתונים לפי המזהה שלהם.

  כדי לציין שמכשירי קלט לא יושפעו, צריך להשאיר את המאפיין הזה לא מוגדר.

• output

  string[] אופציונלי

  רשימה של מכשירים להצגת מידע לפי המזהה שלהם.

  כדי לציין שההגדרה לא תשפיע על מכשירים להצגת מידע, צריך להשאיר את המאפיין הזה לא מוגדר.

DeviceProperties

מאפיינים

• שלב

  מספר אופציונלי

  עוצמת הקול הרצויה של מכשיר האודיו. כברירת מחדל, עוצמת הקול תהיה זהה לעוצמת הקול הנוכחית של המכשיר.

  אם משתמשים במכשיר לקליטת נתונים של אודיו, מייצג את הגברת האודיו במכשיר.

  אם משתמשים במכשיר להצגת מידע של אודיו, הוא מייצג את עוצמת הקול של מכשיר האודיו.

DeviceType

סוגי מכשירי האודיו הזמינים.

טיפוסים בני מנייה (enum)

"HEADPHONE"

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"HOTWORD"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"OTHER"

LevelChangedEvent

מאפיינים

• deviceId

  מחרוזת

  המזהה של המכשיר שעוצמת הקול שלו השתנתה.

• שלב

  number

  עוצמת הקול החדשה של המכשיר.

MuteChangedEvent

מאפיינים

• isMuted

  בוליאני

  אם השידור מושתק עכשיו או לא.

• streamType

  StreamType

  סוג השידור שבו השתנה ערך ההשתקה. ערך ההשתקה המעודכן חל על כל המכשירים עם סוג הסטרימינג הזה.

StreamType

סוג השידור שהתקן האודיו מספק.

טיפוסים בני מנייה (enum)

"INPUT"

"OUTPUT"

Methods

getDevices()

browser.audio.getDevices(
  filter?: DeviceFilter,
): Promise<AudioDeviceInfo[]>

מקבל רשימה של מכשירי אודיו שמסוננים לפי filter.

פרמטרים

• סינון

  DeviceFilter אופציונלי

  מאפייני מכשירים שלפיהם אפשר לסנן את רשימת מכשירי האודיו שמוחזרים. אם המסנן לא מוגדר או מוגדר לערך {}, רשימת המכשירים שתוחזר תכיל את כל מכשירי האודיו הזמינים.

החזרות

• Promise<AudioDeviceInfo[]>

  ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

  דיווח על רשימת מכשירי האודיו שהתבקשה.

getMute()

browser.audio.getMute(
  streamType: StreamType,
): Promise<boolean>

מקבל את מצב ההשתקה ברמת המערכת של סוג הסטרימינג שצוין.

פרמטרים

• streamType

  StreamType

  סוג הסטרימינג שעבורו צריך לאחזר את מצב ההשתקה.

החזרות

• Promise<boolean>

  ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

  אובייקט Promise שמוחזר עם ערך בוליאני שמציין אם ההשתקה מוגדרת או לא לסוג הסטרימינג שצוין.

setActiveDevices()

browser.audio.setActiveDevices(
  ids: DeviceIdLists,
): Promise<void>

הגדרת רשימות של מכשירים פעילים לקליטת נתונים או להצגת מידע.

פרמטרים

• מזהים

  DeviceIdLists

  מציינת את המזהים של המכשירים שצריכים להיות פעילים. אם רשימת הקלט או רשימת הפלט לא מוגדרת, המכשירים בקטגוריה הזו לא מושפעים.

  אם תעבירו מזהה מכשיר שלא קיים, תתקבל שגיאה.

החזרות

• Promise<void>

  ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

setMute()

browser.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
): Promise<void>

הגדרת מצב השתקה לסוג סטרימינג. מצב ההשתקה יחול על כל מכשירי האודיו עם סוג שידור האודיו שצוין.

פרמטרים

• streamType

  StreamType

  סוג הסטרימינג שעבורו צריך להגדיר את מצב ההשתקה.

• isMuted

  בוליאני

  ערך ההשתקה החדש.

החזרות

• Promise<void>

  ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

setProperties()

browser.audio.setProperties(
  id: string,
  properties: DeviceProperties,
): Promise<void>

מגדירה את המאפיינים של המכשיר לקלט או למכשיר להצגת מידע.

פרמטרים

• id [מזהה]

  מחרוזת

• נכסים

  DeviceProperties

החזרות

• Promise<void>

  ‫Chrome 116 ואילך ‫browser.* ‎ מ-Chrome 148

אירועים

onDeviceListChanged

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

מופעל כשמכשירי האודיו משתנים, כשמתווספים מכשירים חדשים או כשמכשירים קיימים מוסרים.

פרמטרים

• callback

  פונקציה

  הפרמטר callback נראה כך:

  (devices: AudioDeviceInfo[]) => void

  • מכשירים

    AudioDeviceInfo[]

onLevelChanged

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

מופעל כשעוצמת הקול משתנה במכשיר אודיו פעיל.

פרמטרים

• callback

  פונקציה

  הפרמטר callback נראה כך:

  (event: LevelChangedEvent) => void

  • אירוע

    LevelChangedEvent

onMuteChanged

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

מופעל כשמצב ההשתקה של קלט או פלט האודיו משתנה. חשוב לזכור שמצב ההשתקה חל על כל המערכת, והערך החדש חל על כל מכשיר אודיו עם סוג הסטרימינג שצוין.

פרמטרים

• callback

  פונקציה

  הפרמטר callback נראה כך:

  (event: MuteChangedEvent) => void

  • אירוע

    MuteChangedEvent