chrome.desktopCapture

الوصف

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

الأذونات

desktopCapture

الأنواع

DesktopCaptureSourceType

يستخدم Enum لتحديد مجموعة من مصادر وسائط سطح المكتب المستخدمة في selectDesktopMedia().

Enum

"الشاشة"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

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

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

Enum

"تضمين"

"استبعاد"

SystemAudioPreferenceEnum

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

النسخ المطابق لـ SystemAudioPreferenceEnum.

Enum

"تضمين"

"استبعاد"

الطُرق

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

لإخفاء مربع حوار منتقي وسائط سطح المكتب الذي يعرضه selectDesktopMedia().

المعلمات

  • desktopMediaRequestId

    الرقم

    رقم التعريف الذي يعرضه selectDesktopMedia()

chooseDesktopMedia()

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

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

المعلمات

  • المصادر

    DesktopCaptureSourceType[]

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

  • targetTab

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

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

  • رد الاتصال

    دالة

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

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

    • streamId

      سلسلة

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

    • الخيارات

      كائن

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

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

      • canRequestAudioTrack

        منطقي

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

المرتجعات

  • الرقم

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