chrome.desktopCapture

الوصف

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

الأذونات

desktopCapture

الأنواع

DesktopCaptureSourceType

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

Enum

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

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

تعكس SelfCapturePreferenceEnum.

Enum

"include"

"exclude"

SystemAudioPreferenceEnum

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

تعكس SystemAudioPreferenceEnum.

Enum

"include"

"exclude"

الطُرق

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

يخفي مربّع حوار أداة اختيار الوسائط على سطح المكتب الذي يعرضه chooseDesktopMedia().

المعلمات

  • desktopMediaRequestId

    الرقم

    المعرّف الذي تعرضه الدالة chooseDesktopMedia()‎

chooseDesktopMedia()

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

تعرِض واجهة مستخدِم أداة اختيار الوسائط على الكمبيوتر المكتبي المجموعة المحدّدة من المصادر.

المعلمات

  • المصادر

    DesktopCaptureSourceType[]

    مجموعة المصادر التي يجب عرضها للمستخدم يحدّد ترتيب المصادر في المجموعة ترتيب علامات التبويب في أداة الاختيار.

  • targetTab

    علامة تبويب اختيارية

    علامة تبويب اختيارية يتم إنشاء البث لها. في حال عدم تحديده، لا يمكن استخدام البث الناتج إلا من خلال إضافة الاتصال. لا يمكن استخدام البث إلا من خلال الإطارات في علامة التبويب المحدّدة التي يتطابق مصدر أمانها مع tab.url. يجب أن يكون مصدر علامة التبويب آمنًا، مثل HTTPS.

  • ردّ الاتصال

    دالة

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

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

    • streamId

      سلسلة

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

    • الخيارات

      عنصر

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

      يحتوي على سمات تصف البث.

      • canRequestAudioTrack

        قيمة منطقية

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

المرتجعات

  • الرقم

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