chrome.desktopCapture

refresh date: 2026-09-25 robots: noindex

תיאור

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

הרשאות

desktopCapture

סוגים

DesktopCaptureSourceType

Enum used to define set of desktop media sources used in chooseDesktopMedia().

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

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

‫Chrome מגרסה 107 ואילך

משקף את SelfCapturePreferenceEnum.

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

"include"

"exclude"

SystemAudioPreferenceEnum

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

משקף את SystemAudioPreferenceEnum.

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

"include"

"exclude"

WindowAudioPreferenceEnum

‫Chrome מגרסה 140 ואילך

משקף את WindowAudioPreferenceEnum.

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

"system"

"window"

"exclude"

Methods

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
): void

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

פרמטרים

  • desktopMediaRequestId

    number

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

chooseDesktopMedia()

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

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

פרמטרים

  • מקורות

    DesktopCaptureSourceType[]

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

  • targetTab

    כרטיסייה אופציונלי

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

  • callback

    פונקציה

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

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

    • streamId

      מחרוזת

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

    • אפשרויות

      אובייקט

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

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

      • canRequestAudioTrack

        בוליאני

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

החזרות

  • number

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