chrome.desktopCapture

说明

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

权限

desktopCapture

类型

DesktopCaptureSourceType

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

枚举

"屏幕"

"窗口"

“制表符”

"audio"

SelfCapturePreferenceEnum

Chrome 107 及更高版本

镜像 SelfCapturePreferenceEnum。

枚举

“包含”

"排除"

SystemAudioPreferenceEnum

Chrome 105 及更高版本

镜像 SystemAudioPreferenceEnum。

枚举

“包含”

"排除"

方法

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

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

参数

  • 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

      字符串

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

    • 选项

      对象

      Chrome 57 及更高版本

      包含描述数据流的属性。

      • canRequestAudioTrack

        布尔值

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

返回

  • number

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