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

显示具有指定来源集的桌面媒体选择器界面。

参数

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

  • targetTab

    标签页 可选

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

  • callback

    函数

    callback 参数如下所示： 

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

    • streamId

      字符串

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

    • 选项

      对象

      Chrome 57 及更高版本

      包含描述视频流的属性。

      • canRequestAudioTrack

        布尔值

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

返回

  • 数值

    一个 ID，如果需要取消提示，可以将其传递给 cancelChooseDesktopMedia()。