chrome.desktopCapture

說明

桌面擷取 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

        布林值

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

傳回

  • 數字

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