chrome.tabCapture

Description

使用 chrome.tabCapture API 与选项卡媒体流交互。

Permissions

tabCapture

Availability

Foreground only(仅前景)

Summary

Types

• CaptureInfo

  CaptureOptions

  GetMediaStreamOptions

  MediaStreamConstraint

  TabCaptureState

Methods

• capture

  getCapturedTabs

  getMediaStreamId

Events

• onStatusChanged

Types

CaptureInfo

PROPERTIES

• fullscreen

  boolean

  正在捕获的选项卡中的元素是否处于全屏模式。

• status

  TabCaptureState

  选项卡的新捕获状态。

• tabId

  number

  状态更改的选项卡的 ID。

CaptureOptions

PROPERTIES

• audio

  boolean optional

• audioConstraints

  MediaStreamConstraint optional

• video

  boolean optional

• videoConstraints

  MediaStreamConstraint optional

GetMediaStreamOptions

Chrome 71+

PROPERTIES

• consumerTabId

  number optional

  选项卡的可选选项卡 ID，稍后将调用 getUserMedia() 来使用流。如果未指定，则结果流只能由调用扩展使用。该流只能由给定选项卡中的帧使用，其安全来源与消费者选项卡的来源相匹配。标签的来源必须是安全来源，例如HTTPS。

• targetTabId

  number optional

  将被捕获的选项卡的可选选项卡 ID。如果未指定，则将选择当前活动选项卡。只有扩展程序已被授予 activeTab 权限的选项卡才能用作目标选项卡。

MediaStreamConstraint

PROPERTIES

• mandatory

  object

• optional

  object optional

TabCaptureState

TYPE

"pending", "active", "stopped", or "error"

Methods

capture

chrome.tabCapture.capture( options: CaptureOptions, callback: function, )

捕获当前活动选项卡的可见区域。 Capture 只能在调用扩展后在当前活动的选项卡上启动，类似于 activeTab 的工作方式。捕获在选项卡内的页面导航之间维护，并在选项卡关闭或媒体流被扩展程序关闭时停止。

PARAMETERS

• options

  CaptureOptions

  配置返回的媒体流。

• callback

  function

  回调参数如下所示：

  (stream: LocalMediaStream) => void

  • stream

    LocalMediaStream

getCapturedTabs

chrome.tabCapture.getCapturedTabs(
  callback: function,
)

返回已请求捕获或正在捕获的选项卡列表，即状态 != 停止和状态 != 错误(status != stopped and status != error)。这允许扩展通知用户有一个现有的选项卡捕获会阻止新的选项卡捕获成功（或防止对同一选项卡的冗余请求）。

PARAMETERS

• callback

  function

  回调参数如下所示：

  (result: CaptureInfo[]) => void

  • result

    CaptureInfo[]

getMediaStreamId

chrome.tabCapture.getMediaStreamId( options?: GetMediaStreamOptions, callback: function, )

Chrome 71+

创建流 ID 以捕获目标选项卡。类似于 chrome.tabCapture.capture() 方法，但向消费者选项卡返回媒体流 ID，而不是媒体流。

PARAMETERS

• options

  GetMediaStreamOptions optional

• callback

  function

  回调参数如下所示：

  (streamId: string) => void

  • streamId

    string

Events

onStatusChanged

chrome.tabCapture.onStatusChanged.addListener(
  callback: function,
)

选项卡的捕获状态更改时触发的事件。这允许扩展作者跟踪选项卡的捕获状态，以保持页面操作等 UI 元素同步。

PARAMETERS

• callback

  function

  回调参数如下所示：

  (info: CaptureInfo) => void

  • info

    CaptureInfo

By.一粒技术服务.