browser.desktopCapture

说明

屏幕内容截取 API 可截取屏幕、单个窗口或单个标签页的内容。

权限

desktopCapture

类型

DesktopCaptureSourceType

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

枚举

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 及更高版本 browser.*（自 Chrome 148 起）

镜像 SelfCapturePreferenceEnum。

枚举

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 及更高版本 browser.*（自 Chrome 148 起）

镜像 SystemAudioPreferenceEnum。

枚举

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140 及更高版本 browser.*（自 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 及更高版本 browser.*（自 Chrome 148 起）

      包含描述直播的属性。

      • canRequestAudioTrack

        布尔值

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

返回

  • 数值

    一个可传递给 cancelChooseDesktopMedia() 的 ID，以防需要取消提示。