chrome.audio

תיאור

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

הרשאות

audio

זמינות

‫Chrome 59 ואילך ChromeOS בלבד

סוגים

AudioDeviceInfo

מאפיינים

  • deviceName

    מחרוזת

    שם המכשיר.

  • deviceType

    DeviceType

    סוג המכשיר.

  • displayName

    מחרוזת

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

  • id [מזהה]

    מחרוזת

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

  • isActive

    בוליאני

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

  • רמה

    number

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

  • stableDeviceId

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

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

  • streamType

    StreamType

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

DeviceFilter

מאפיינים

  • isActive

    ‫boolean אופציונלי

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

  • 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()

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

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

פרמטרים

  • סינון

    ‫DeviceFilter אופציונלי

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

החזרות

getMute()

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

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

פרמטרים

  • streamType

    StreamType

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

החזרות

  • Promise<boolean>

    ‫Chrome 116 ואילך

setActiveDevices()

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

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

פרמטרים

  • מזהים

    DeviceIdLists

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

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

החזרות

  • Promise<void>

    ‫Chrome 116 ואילך

setMute()

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

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

פרמטרים

  • streamType

    StreamType

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

  • isMuted

    בוליאני

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

החזרות

  • Promise<void>

    ‫Chrome 116 ואילך

setProperties()

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

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

פרמטרים

החזרות

  • Promise<void>

    ‫Chrome 116 ואילך

אירועים

onDeviceListChanged

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

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

פרמטרים

onLevelChanged

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

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

פרמטרים

onMuteChanged

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

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

פרמטרים