chrome.desktopCapture

الوصف

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

الأذونات

desktopCapture

الأنواع

DesktopCaptureSourceType

يشير هذا المصطلح إلى التعداد المستخدَم لتحديد مجموعة من مصادر وسائط سطح المكتب المستخدَمة في selectDesktopMedia().

التعداد

"audio"

SelfCapturePreferenceEnum

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

النسخ المطابقات SelfCapturePreferenceEnum.

التعداد

SystemAudioPreferenceEnum

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

النسخ المطابقات SystemAudioPreferenceEnum

التعداد

الطُرق

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

لإخفاء مربع حوار أداة اختيار الوسائط على سطح المكتب الذي يظهر من خلال selectDesktopMedia().

المَعلمات

  • desktopMediaRequestId

    الرقم

    المعرف الذي تم إرجاعه بواسطة selectDesktopMedia()

chooseDesktopMedia()

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

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

المَعلمات

  • المصادر

    DesktopCaptureSourceType[]

    مجموعة المصادر التي يجب عرضها للمستخدم. يؤدي ترتيب المصادر في المجموعة إلى تحديد ترتيب التنقل بمفتاح التبويب (Tab) في أداة الاختيار.

  • targetTab

    Tab اختيارية

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

  • معاودة الاتصال

    الوظيفة

    تبدو معلَمة callback على النحو التالي: 

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

    • streamId

      سلسلة

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

    • الخيارات

      كائن

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

      تحتوي على خصائص تصف ساحة المشاركات.

      • canRequestAudioTrack

        boolean

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

المرتجعات

  • الرقم

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