chrome.audio

תיאור

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

הרשאות

audio

זמינות

Chrome מגרסה 59 ואילך ב-ChromeOS בלבד

סוגים

AudioDeviceInfo

מאפיינים

  • deviceName

    string

    שם המכשיר.

  • deviceType

    DeviceType

    סוג המכשיר.

  • displayName

    string

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

  • id [מזהה]

    string

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

  • isActive

    boolean

    הערך true אם זהו המכשיר הפעיל הנוכחי.

  • רמה

    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

    string

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

  • רמה

    number

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

MuteChangedEvent

מאפיינים

  • isMuted

    boolean

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

  • streamType

    StreamType

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

StreamType

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

Enum

"INPUT"

"OUTPUT"

Methods

getDevices()

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

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

פרמטרים

  • סינון

    DeviceFilter אופציונלי

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

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

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

    (devices: AudioDeviceInfo[]) => void

החזרות

  • Promise<AudioDeviceInfo[]>

    גרסה 116 ואילך של Chrome

    יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

getMute()

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

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

פרמטרים

  • streamType

    StreamType

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

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

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

    (value: boolean) => void

    • ערך

      boolean

החזרות

  • Promise<boolean>

    גרסה 116 ואילך של Chrome

    יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

setActiveDevices()

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

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

פרמטרים

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

    אסור להעביר מזהה מכשיר לא קיים.

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

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

    () => void

החזרות

  • Promise<void>

    גרסה 116 ואילך של Chrome

    יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

setMute()

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

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

פרמטרים

  • streamType

    StreamType

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

  • isMuted

    boolean

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

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

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

    () => void

החזרות

  • Promise<void>

    גרסה 116 ואילך של Chrome

    יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

setProperties()

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

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

פרמטרים

  • id [מזהה]

    string

  • נכסים

    DeviceProperties

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

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

    () => void

החזרות

  • Promise<void>

    Chrome מגרסה 116 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

אירועים

onDeviceListChanged

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

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

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

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

    (devices: AudioDeviceInfo[]) => void

onLevelChanged

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

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

פרמטרים

onMuteChanged

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

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

פרמטרים