browser.desktopCapture

說明

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

權限

desktopCapture

類型

DesktopCaptureSourceType

用於定義 chooseDesktopMedia() 中所用電腦媒體來源組合的列舉。

列舉

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 以上版本 Chrome 148 起為 browser.*

鏡像 SelfCapturePreferenceEnum。

列舉

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 以上版本 Chrome 148 以上版本為 browser.*

鏡像 SystemAudioPreferenceEnum。

列舉

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140 以上版本 瀏覽器 (自 Chrome 148 起)。*

鏡像 WindowAudioPreferenceEnum。

列舉

"system"

"window"

"exclude"

方法

cancelChooseDesktopMedia()

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

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

參數

  • desktopMediaRequestId

    數字

    chooseDesktopMedia() 傳回的 ID

chooseDesktopMedia()

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

顯示電腦版媒體選擇器使用者介面，其中包含一組指定來源。

參數

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

  • targetTab

    分頁 選填

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

  • callback

    函式

    callback 參數如下： 

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

    • streamId

      字串

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

    • 選項

      物件

      Chrome 57 以上版本 Chrome 148 以上版本支援 browser.*

      包含描述串流的屬性。

      • canRequestAudioTrack

        布林值

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

傳回

  • 數字

    如果需要取消提示，可以將 ID 傳遞至 cancelChooseDesktopMedia()。