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

    ערך בוליאני אופציונלי

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

  • 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"

"פלט"

שיטות

getDevices()

הבטחה 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

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

פרמטרים

  • סינון

    DeviceFilter אופציונלי

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

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

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

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

    (devices: AudioDeviceInfo[]) => void

החזרות

  • Promise<AudioDeviceInfo[]>

    Chrome 116 ואילך

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

getMute()

הבטחה 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

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

פרמטרים

  • streamType

    StreamType

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

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

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

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

    (value: boolean) => void

    • ערך

      בוליאני

החזרות

  • Promise<boolean>

    Chrome 116 ואילך

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

setActiveDevices()

הבטחה 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

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

פרמטרים

  • מזהים

    DeviceIdLists

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

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

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

    Chrome 116 ואילך

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

setMute()

הבטחה 
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

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

פרמטרים

  • streamType

    StreamType

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

  • isMuted

    בוליאני

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

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

    Chrome 116 ואילך

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

setProperties()

הבטחה 
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

    Chrome 116 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (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,
)

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

פרמטרים