chrome.desktopCapture

תיאור

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

הרשאות

desktopCapture

סוגים

DesktopCaptureSourceType

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

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

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

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

משקף את SelfCapturePreferenceEnum.

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

‎"include"

‎"exclude"

SystemAudioPreferenceEnum

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

משקף את SystemAudioPreferenceEnum.

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

‎"include"

‎"exclude"

WindowAudioPreferenceEnum

בהמתנה

משקף את WindowAudioPreferenceEnum.

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

"system"

"window"

‎"exclude"

Methods

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

הוספת קוד להסתרת תיבת הדו-שיח של הכלי לבחירת מדיה במחשב, שמוצגת על ידי chooseDesktopMedia().

פרמטרים

  • desktopMediaRequestId

    number

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

chooseDesktopMedia()

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

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

פרמטרים

  • מקורות

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

  • targetTab

    Tab אופציונלי

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

  • callback

    פונקציה

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

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

    • streamId

      מחרוזת

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

    • אפשרויות

      אובייקט

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

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

      • canRequestAudioTrack

        בוליאני

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

החזרות

  • number

    מזהה שאפשר להעביר ל-cancelChooseDesktopMedia() במקרה שצריך לבטל את ההודעה.