chrome.audio

תיאור

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

הרשאות

audio

זמינות

Chrome 59+ ChromeOS בלבד

סוגים

AudioDeviceInfo

תכונות

  • deviceName

    מחרוזת

    שם המכשיר.

  • deviceType

    DeviceType

    סוג המכשיר.

  • displayName

    מחרוזת

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

  • id

    מחרוזת

    המזהה הייחודי של התקן האודיו.

  • isActive

    boolean

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

  • שלב

    מספר

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

  • stableDeviceId

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

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

  • streamType

    StreamType

    סוג מקור הנתונים המשויך למכשיר הזה.

DeviceFilter

תכונות

  • isActive

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

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

  • streamTypes

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

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

DeviceIdLists

תכונות

  • קלט

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

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

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

  • output

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

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

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

DeviceProperties

תכונות

  • שלב

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

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

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

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

DeviceType

הסוגים הזמינים של התקני האודיו.

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

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"HOTWORD"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"OTHER"

LevelChangedEvent

תכונות

  • deviceId

    מחרוזת

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

  • שלב

    מספר

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

MuteChangedEvent

תכונות

  • isMuted

    boolean

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

  • 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

    • value

      boolean

החזרות

  • Promise<boolean>

    Chrome 116 ומעלה

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

setActiveDevices()

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

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

פרמטרים

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

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 116 ומעלה

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

setMute()

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

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

פרמטרים

  • streamType

    StreamType

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

  • isMuted

    boolean

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 116 ומעלה

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

setProperties()

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

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

פרמטרים

  • id

    מחרוזת

  • נכסים

    DeviceProperties

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

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

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

    ()=>void

החזרות

  • Promise<void>

    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,
)

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

פרמטרים