chrome.desktopCapture

تاریخ به‌روزرسانی: 2026-09-25 ربات‌ها: noindex

توضیحات

رابط برنامه‌نویسی کاربردی (API) ضبط دسکتاپ، محتوای صفحه نمایش، پنجره‌های مجزا یا تب‌های مجزا را ضبط می‌کند.

مجوزها

desktopCapture

انواع

DesktopCaptureSourceType

Enum برای تعریف مجموعه‌ای از منابع رسانه‌ای دسکتاپ که در تابع chooseDesktopMedia() استفاده می‌شوند، استفاده می‌شود.

شمارشی

"صفحه نمایش"

«پنجره»

"تب"

"صوتی"

SelfCapturePreferenceEnum

کروم ۱۰۷+

آینه‌ها SelfCapturePreferenceEnum .

شمارشی

"شامل کردن"

"استثنا کردن"

SystemAudioPreferenceEnum

کروم ۱۰۵+

آینه‌ها SystemAudioPreferenceEnum .

شمارشی

"شامل کردن"

"استثنا کردن"

WindowAudioPreferenceEnum

کروم ۱۴۰+

آینه‌ها، پنجره، صدا، ترجیحات عددی .

شمارشی

«سیستم»

«پنجره»

"استثنا کردن"

روش‌ها

cancelChooseDesktopMedia()

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

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

پارامترها

  • شناسه درخواست رسانه دسکتاپ

    شماره

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

chooseDesktopMedia()

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

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

پارامترها

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

  • تارگت تب

    تب اختیاری

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

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

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

    • استریم آیدی

      رشته

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

    • گزینه‌ها

      شیء

      کروم ۵۷+

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

      • canRequestAudioTrack

        بولی

        اگر "audio" در منابع پارامتر گنجانده شده باشد، و کاربر نهایی علامت کادر انتخاب "Share audio" را برنداشته باشد، مقدار true را برمی‌گرداند. در غیر این صورت false است، و در این حالت، نباید از طریق فراخوانی getUserMedia درخواست پخش صدا کرد.

بازگشت‌ها

  • شماره

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