chrome.desktopCapture

תיאור

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

הרשאות

desktopCapture

סוגים

DesktopCaptureSourceType

Enum המשמש להגדרת קבוצה של מקורות מדיה למחשבים שולחניים המשמשים ב-selectDesktopMedia().

Enum

"מסך"

'window'

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 ואילך

שיקוף של SelfCapturePreferenceEnum.

Enum

"כולל"

"החרגה"

SystemAudioPreferenceEnum

Chrome 105+

רפליקציות ל-SystemAudioPreferenceEnum.

Enum

"כולל"

"החרגה"

שיטות

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

הסתרת תיבת הדו-שיח של הכלי לבחירת מדיה לשולחן העבודה שמוצגת על ידי selectDesktopMedia().

פרמטרים

  • desktopMediaRequestId

    number

    המזהה שהוחזר על ידי selectDesktopMedia()

chooseDesktopMedia()

chrome.desktopCapture.chooseDesktopMedia(
  sources: DesktopCaptureSourceType[],
  targetTab?: Tab,
  callback: function,
)

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

פרמטרים

  • מקורות

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

  • targetTab

    Tab אופציונלי

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

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

    פונקציה

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

    (streamId: string, options: object) => void

    • streamId

      מחרוזת

      מחרוזת אטומה שאפשר להעביר אל ממשק ה-API של getUserMedia() כדי ליצור שידור מדיה שתואם למקור שנבחר על ידי המשתמש. אם המשתמש לא בחר מקור כלשהו (כלומר, ביטל את ההנחיה), תופעל קריאה חוזרת עם streamId ריק. ניתן להשתמש בstreamId שנוצר פעם אחת בלבד והתוקף שלו יפוג לאחר כמה שניות כשלא משתמשים בו.

    • אפשרויות

      אובייקט

      Chrome 57 ומעלה

      מכילה מאפיינים שמתארים את עדכוני התוכן.

      • canRequestAudioTrack

        בוליאני

        True אם מדובר ב-'audio' כלולה במקורות של פרמטרים, ומשתמש הקצה לא מבטל את הסימון של האפשרות 'שיתוף אודיו' תיבת הסימון. אחרת, הערך הוא False, ובמקרה הזה אין לבקש שידור אודיו דרך שיחת getUserMedia.

החזרות

  • number

    מזהה שניתן להעביר אל cancelChooseDesktopMedia() במקרה שצריך לבטל את ההנחיה.