chrome.desktopCapture

說明

Desktop Capture API 會擷取螢幕、個別視窗或個別分頁的內容。

權限

desktopCapture

類型

DesktopCaptureSourceType

這個列舉用於定義 chooseDesktopMedia() 中使用的桌面媒體來源集。

列舉

「screen」

「window」

「tab」

「audio」

SelfCapturePreferenceEnum

Chrome 107 以上版本

鏡子 SelfCapturePreferenceEnum。

列舉

「include」

「exclude」

SystemAudioPreferenceEnum

Chrome 105 以上版本

鏡像 SystemAudioPreferenceEnum。

列舉

「include」

「exclude」

WindowAudioPreferenceEnum

Chrome 140 以上版本

鏡像 WindowAudioPreferenceEnum。

列舉

「system」

「window」

「exclude」

方法

cancelChooseDesktopMedia()

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

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

參數

  • desktopMediaRequestId

    數字

    chooseDesktopMedia() 傳回的 ID

chooseDesktopMedia()

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

顯示指定來源組合的電腦媒體挑選器 UI。

參數

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

  • targetTab

    分頁 選填

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

  • callback

    函式

    callback 參數如下： 

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

    • streamId

      字串

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

    • 選項

      物件

      Chrome 57 以上版本

      包含描述串流的屬性。

      • canRequestAudioTrack

        布林值

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

傳回

  • 數字

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