chrome.desktopCapture

الوصف

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

الأذونات

desktopCapture

الأنواع

DesktopCaptureSourceType

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

تعداد

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

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

المرايا SelfCapturePreferenceEnum

تعداد

"include"

"exclude"

SystemAudioPreferenceEnum

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

تعكس هذه السمة قيمة SystemAudioPreferenceEnum.

تعداد

"include"

"exclude"

WindowAudioPreferenceEnum

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

تعكس هذه السمة WindowAudioPreferenceEnum.

تعداد

"system"

"window"

"exclude"

الطُرق

cancelChooseDesktopMedia()

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

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

المعلمات

  • desktopMediaRequestId

    الرقم

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

chooseDesktopMedia()

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

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

المعلمات

  • المصادر

    DesktopCaptureSourceType[]

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

  • targetTab

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

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

  • callback

    دالة

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

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

    • streamId

      سلسلة

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

    • الخيارات

      عنصر

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

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

      • canRequestAudioTrack

        قيمة منطقية

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

المرتجعات

  • الرقم

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