chrome.desktopCapture

说明

Desktop Capture API 可捕获屏幕、单个窗口或单个标签页的内容。

权限

desktopCapture

类型

DesktopCaptureSourceType

用于定义 ChooseDesktopMedia() 中使用的一组桌面媒体来源的枚举。

枚举

"audio"

SelfCapturePreferenceEnum

Chrome 107 及更高版本

镜像 SelfCapturePreferenceEnum。

枚举

SystemAudioPreferenceEnum

Chrome 105 及更高版本

镜像 SystemAudioPreferenceEnum。

枚举

方法

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

隐藏 selectDesktopMedia() 显示的桌面媒体选择器对话框。

参数

  • desktopMediaRequestId

    number

    由 selectDesktopMedia() 返回的 ID

chooseDesktopMedia()

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

显示具有一组指定来源的桌面媒体选择工具界面。

参数

  • 应向用户显示的来源集。集中的来源顺序决定了选择器中的标签页顺序。

  • targetTab

    Tab 可选

    为其创建数据流的可选标签页。如果未指定，则生成的流仅供调用扩展程序使用。只有安全来源与 tab.url 匹配的指定标签页中的帧可以使用该数据流。标签页的源必须是安全源，例如 HTTPS。

  • callback

    功能

    callback 参数如下所示：

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

    • streamId

      string

      一个不透明的字符串，可传递给 getUserMedia() API 以生成与用户所选来源对应的媒体流。如果用户未选择任何来源（即取消提示），则系统会使用空的 streamId 调用回调函数。创建的 streamId 只能使用一次，并且会在几秒后过期。

    • 选项

      对象

      Chrome 57 及更高版本

      包含用于描述该数据流的属性。

      • canRequestAudioTrack

        boolean

        如果参数来源中包含“audio”，并且最终用户未取消选中“分享音频”复选框，则为 true。否则为 false，并且在这种情况下，用户不应通过 getUserMedia 调用请求音频流。

返回

  • number

    需要取消提示时，可以传递至 cancelChooseDesktopMedia() 的 ID。