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().

شمارشی

"screen"

«پنجره»

«برگه»

"audio"

SelfCapturePreferenceEnum

Chrome نسخه ۱۰۷ و بالاتر

SelfCapturePreferenceEnum را آینه‌سازی می‌کند.

شمارشی

«include»

"exclude"

SystemAudioPreferenceEnum

Chrome نسخه ۱۰۵ و بالاتر

آینه‌سازی SystemAudioPreferenceEnum.

شمارشی

«include»

"exclude"

WindowAudioPreferenceEnum

Chrome نسخه ۱۴۰ به بالا

WindowAudioPreferenceEnum را آینه‌سازی می‌کند.

شمارشی

"system"

«پنجره»

"exclude"

روش‌ها

cancelChooseDesktopMedia()

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

کادر گفتگوی انتخابگر رسانه میزکار را که توسط chooseDesktopMedia()‎ نشان داده شده است پنهان می‌کند.

پارامترها

  • desktopMediaRequestId

    شماره

    شناسه برگردانده‌شده توسط chooseDesktopMedia()

chooseDesktopMedia()

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

رابط کاربری انتخاب‌گر رسانه میز کار را با مجموعه منابع مشخص‌شده نشان می‌دهد.

پارامترها

  • مجموعه منابعی که باید به کاربر نشان داده شود. ترتیب منابع در مجموعه، ترتیب برگه‌ها را در انتخابگر تعیین می‌کند.

  • targetTab

    برگه اختیاری

    برگه اختیاری که جاری‌سازی برای آن ایجاد شده است. اگر مشخص نشده باشد، فقط افزونه تماس‌گیرنده می‌تواند از جاری‌سازی حاصل استفاده کند. فقط قاب‌هایی در برگه ارائه‌شده می‌توانند از این جاری‌سازی استفاده کنند که مبدأ امنیتی آن‌ها با tab.url مطابقت داشته باشد. مبدأ برگه باید مبدأی امن باشد، مثلاً HTTPS.

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

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

    • streamId

      رشته

      رشته‌ای مات که می‌تواند به میانای برنامه‌سازی کاربردی getUserMedia() ارسال شود تا جاری‌سازی رسانه‌ای تولید کند که با منبع انتخاب‌شده توسط کاربر مطابقت دارد. اگر کاربر هیچ منبعی را انتخاب نکند (یعنی پیام‌واره را لغو کند)، فراخوانی برگشتی با streamId خالی فراخوانی می‌شود. streamId ایجادشده فقط یک‌بار قابل‌استفاده است و اگر استفاده نشود، پس‌از چند ثانیه منقضی می‌شود.

    • گزینه‌ها

      شیء

      Chrome نسخه ۵۷ و بالاتر

      حاوی ویژگی‌هایی است که جاری‌سازی را توصیف می‌کند.

      • canRequestAudioTrack

        بولی

        اگر «صدا» در منابع پارامتر گنجانده شده باشد و کاربر نهایی چارگوش انتخاب «هم‌رسانی صدا» را لغو انتخاب نکند، True (درست) است. درغیراین‌صورت، نادرست است و در این حالت، نباید ازطریق تماس getUserMedia درخواست جاری‌سازی صوتی کرد.

بازگشتی‌ها

  • شماره

    شناسه‌ای که درصورت نیاز به لغو پیام‌واره می‌تواند به cancelChooseDesktopMedia() ارسال شود.