chrome.desktopCapture

ब्यौरा

डेस्कटॉप कैप्चर एपीआई, स्क्रीन, अलग-अलग विंडो या अलग-अलग टैब के कॉन्टेंट को कैप्चर करता है.

अनुमतियां

desktopCapture

टाइप

DesktopCaptureSourceType

इस enum का इस्तेमाल, chooseDesktopMedia() में इस्तेमाल किए गए डेस्कटॉप मीडिया सोर्स के सेट को तय करने के लिए किया जाता है.

Enum

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 या इसके बाद का वर्शन

SelfCapturePreferenceEnum को दिखाता है.

Enum

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 या इसके बाद का वर्शन

यह SystemAudioPreferenceEnum को दिखाता है.

Enum

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140+

यह 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

इसमें डेस्कटॉप मीडिया पिकर का यूज़र इंटरफ़ेस (यूआई) दिखाया गया है. इसमें सोर्स का तय किया गया सेट मौजूद है.

पैरामीटर

  • स्रोत

    DesktopCaptureSourceType[]

    सोर्स का वह सेट जो उपयोगकर्ता को दिखाया जाना चाहिए. सेट में सोर्स का क्रम, पिकर में टैब का क्रम तय करता है.

  • targetTab

    टैब ज़रूरी नहीं है

    वह टैब जिसके लिए स्ट्रीम बनाई गई है. यह टैब ज़रूरी नहीं है. अगर इसकी जानकारी नहीं दी जाती है, तो नतीजे के तौर पर मिली स्ट्रीम का इस्तेमाल सिर्फ़ कॉल करने वाला एक्सटेंशन कर सकता है. इस स्ट्रीम का इस्तेमाल, सिर्फ़ दिए गए टैब में मौजूद उन फ़्रेम के लिए किया जा सकता है जिनका सुरक्षा ऑरिजिन tab.url से मेल खाता है. टैब का ऑरिजिन सुरक्षित होना चाहिए. जैसे, एचटीटीपीएस.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

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

    • streamId

      स्ट्रिंग

      यह एक ओपेक स्ट्रिंग है. इसे getUserMedia() API को पास किया जा सकता है, ताकि उपयोगकर्ता की ओर से चुने गए सोर्स के हिसाब से मीडिया स्ट्रीम जनरेट की जा सके. अगर उपयोगकर्ता ने कोई सोर्स नहीं चुना है (यानी कि प्रॉम्प्ट को रद्द कर दिया है), तो कॉलबैक को खाली streamId के साथ कॉल किया जाता है. बनाया गया streamId सिर्फ़ एक बार इस्तेमाल किया जा सकता है. इस्तेमाल न करने पर, कुछ सेकंड बाद इसकी समयसीमा खत्म हो जाती है.

    • विकल्प

      ऑब्जेक्ट

      Chrome 57 या इसके बाद का वर्शन

      इसमें स्ट्रीम के बारे में बताने वाली प्रॉपर्टी होती हैं.

      • canRequestAudioTrack

        बूलियन

        अगर पैरामीटर सोर्स में "audio" शामिल है और असली उपयोगकर्ता ने "ऑडियो शेयर करें" चेकबॉक्स से सही का निशान नहीं हटाया है, तो यह वैल्यू सही होती है. अगर ऐसा नहीं है, तो यह गलत है. इस मामले में, getUserMedia कॉल के ज़रिए ऑडियो स्ट्रीम का अनुरोध नहीं करना चाहिए.

रिटर्न

  • संख्या

    यह एक ऐसा आईडी है जिसे प्रॉम्प्ट रद्द करने के लिए, cancelChooseDesktopMedia() को पास किया जा सकता है.