chrome.desktopCapture

refresh date: 2026-09-25 robots: noindex

الوصف

تلتقط واجهة برمجة التطبيقات Desktop Capture محتوى الشاشة أو النوافذ الفردية أو علامات التبويب الفردية.

الأذونات

desktopCapture

الأنواع

DesktopCaptureSourceType

تعداد يُستخدَم لتحديد مجموعة مصادر وسائط سطح المكتب المستخدَمة في chooseDesktopMedia().

Enum

"screen"

"window"

"علامة تبويب"

"audio"

SelfCapturePreferenceEnum

الإصدار 107 من Chrome والإصدارات الأحدث

يعكس SelfCapturePreferenceEnum.

Enum

"include"

"exclude"

SystemAudioPreferenceEnum

الإصدار 105 من Chrome أو الإصدارات الأحدث

يعكس SystemAudioPreferenceEnum.

Enum

"include"

"exclude"

WindowAudioPreferenceEnum

الإصدار 140 من Chrome والإصدارات الأحدث

يعكس WindowAudioPreferenceEnum.

Enum

"system"

"window"

"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

    دالة

    تظهر المَعلمة callback على النحو التالي:

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

    • streamId

      سلسلة

      سلسلة مبهمة يمكن تمريرها إلى واجهة برمجة التطبيقات getUserMedia() لإنشاء بث وسائط يتوافق مع المصدر الذي اختاره المستخدم. إذا لم يختار المستخدم أي مصدر (أي ألغى الطلب)، يتم استدعاء دالة الاستدعاء باستخدام streamId فارغ. يمكن استخدام streamId الذي تم إنشاؤه مرة واحدة فقط وتنتهي صلاحيته بعد بضع ثوانٍ في حال عدم استخدامه.

    • الخيارات

      عنصر

      الإصدار 57 من Chrome أو الإصدارات الأحدث

      يحتوي على خصائص تصف البث.

      • canRequestAudioTrack

        قيمة منطقية

        تكون القيمة "صحيح" إذا تم تضمين "الصوت" في مصادر المَعلمات، ولم يزِل المستخدم النهائي العلامة من مربّع الاختيار "مشاركة الصوت". وإذا لم يكن الأمر كذلك، تكون القيمة "خطأ"، وفي هذه الحالة، يجب عدم طلب بث صوتي من خلال طلب getUserMedia.

المرتجعات

  • الرقم

    رقم تعريف يمكن تمريره إلى cancelChooseDesktopMedia()‎ في حال الحاجة إلى إلغاء الطلب.