chrome.desktopCapture

說明

桌面擷取 API 可擷取螢幕畫面、個別視窗或個別分頁的內容。

權限

desktopCapture

類型

DesktopCaptureSourceType

用於定義在 chooseDesktopMedia() 中使用的電腦媒體來源集合的列舉。

列舉

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 以上版本

鏡像 SelfCapturePreferenceEnum。

列舉

「include」

"exclude"

SystemAudioPreferenceEnum

Chrome 105 以上版本

與 SystemAudioPreferenceEnum 互通。

列舉

「include」

"exclude"

方法

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

隱藏由 chooseDesktopMedia() 顯示的桌面媒體選擇器對話方塊。

參數

• desktopMediaRequestId

  數字

  由 chooseDesktopMedia() 傳回的 ID

chooseDesktopMedia()

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

顯示桌面媒體挑選器使用者介面，其中包含指定的來源組合。

參數

• 來源

  DesktopCaptureSourceType[]

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

• targetTab

  分頁 選填

  建立串流的選用分頁。如未指定，則產生的串流只能由呼叫的擴充功能使用。該串流只能由指定分頁中的框架使用，且該分頁的安全性來源必須與 tab.url 相符。分頁的來源必須是安全來源，例如 HTTPS。

• 回呼

  函式

  callback 參數如下所示：

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

  • streamId

    字串

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

  • 選項

    物件

    Chrome 57 以上版本

    包含用於描述串流的屬性。

    • canRequestAudioTrack

      布林值

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

傳回

• 數字

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