chrome.desktopCapture

說明

Desktop Capture API 會擷取畫面、個別視窗或個別分頁的內容,

權限

desktopCapture

類型

DesktopCaptureSourceType

用於定義 ChooseDesktopMedia() 中所使用的電腦媒體來源組合。

列舉

SelfCapturePreferenceEnum

Chrome 107 以上版本

鏡像:SelfCapturePreferenceEnum

列舉

SystemAudioPreferenceEnum

Chrome 105 以上版本

鏡像 SystemAudioPreferenceEnum

列舉

方法

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

隱藏 ChooseDesktopMedia() 顯示的電腦媒體選擇器對話方塊。

參數

  • desktopMediaRequestId

    號碼

    ChooseDesktopMedia() 傳回的 ID

chooseDesktopMedia()

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

顯示包含指定來源的電腦媒體選擇器 UI。

參數

  • 應該向使用者顯示的一組來源。組合中的來源順序會決定挑選器中的分頁順序。

  • targetTab

    Tab 選用

    此為選用分頁,用於建立串流。如未指定,產生的串流只能由呼叫擴充功能使用。只有指定分頁的安全性來源與 tab.url 相符,才能使用這個串流。分頁的來源必須是安全來源,例如 HTTPS。

  • 回呼

    功能

    callback 參數如下所示:

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

    • streamId

      字串

      可傳遞至 getUserMedia() API 的不透明字串,用於產生與使用者所選來源相對應的媒體串流。如果使用者未選取任何來源 (也就是取消提示),系統會以空白 streamId 呼叫回呼。建立的 streamId 只能使用一次,且閒置幾秒後就會失效。

    • 選項

      物件

      Chrome 57 以上版本

      包含描述串流的屬性。

      • canRequestAudioTrack

        boolean

        如果參數來源含有「音訊」,且使用者未取消勾選「分享音訊」核取方塊,則為 True。否則為 false,在這種情況下,不應透過 getUserMedia 呼叫要求音訊串流。

傳回

  • 號碼

    可在提示需要取消時,傳遞至 cancelChooseDesktopMedia() 的 ID。