chrome.desktopCapture

תיאור

ה-Desktop capture API לוכד את התוכן של המסך, של חלונות נפרדים או של כרטיסיות נפרדות.

הרשאות

desktopCapture

סוגים

DesktopCaptureSourceType

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

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

SelfCapturePreferenceEnum

Chrome 107 ומעלה

שיקוף SelfCapturePreferenceEnum.

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

SystemAudioPreferenceEnum

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

Mirrors SystemAudioPreferenceEnum.

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

שיטות

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

הסתרת תיבת הדו-שיח לבחירת מדיה במחשב שמופיעה על ידי selectDesktopMedia().

פרמטרים

  • desktopMediaRequestId

    מספר

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

chooseDesktopMedia()

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

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

פרמטרים

  • מקורות

    DesktopCaptureSourceType[]

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

  • targetTab

    Tab אופציונלי

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

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

    פונקציה

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

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

    • streamId

      מחרוזת

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

    • אפשרויות

      אובייקט

      Chrome 57 ומעלה

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

      • canRequestAudioTrack

        boolean

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

החזרות

  • מספר

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