chrome.desktopCapture

תאריך הרענון: 2026-09-25 robots: noindex

תיאור

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

הרשאות

desktopCapture

סוגים

DesktopCaptureSourceType

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

ספירה

‫"screen"

‫'window'

‫'tab'

‫"audio"

SelfCapturePreferenceEnum

‫Chrome 107 ואילך

מראות SelfCapturePreferenceEnum.

ספירה

‫include

‫"exclude"

SystemAudioPreferenceEnum

‫Chrome 105 ואילך

משקף את SystemAudioPreferenceEnum.

ספירה

‫include

‫"exclude"

WindowAudioPreferenceEnum

‫Chrome 140+‎

משקף את WindowAudioPreferenceEnum.

ספירה

‫'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

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

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

  • callback

    פונקציה

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

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

    • streamId

      מחרוזת

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

    • options

      אובייקט

      ‫Chrome 57 ואילך

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

      • canRequestAudioTrack

        בוליאני

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

החזרות

  • number

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