chrome.tabCapture

描述 使用 chrome.tabCapture API 与标签页的媒体流交互。
可用版本 从 Chrome 31 开始支持。
权限 "tabCapture"

摘要

类型
CaptureInfo
MediaStreamConstraint
方法
capture chrome.tabCapture.capture(object options, function callback)
getCapturedTabs chrome.tabCapture.getCapturedTabs(function callback)
事件
onStatusChanged

类型

CaptureInfo

属性
integer tabId

状态更改的标签页标识符。

enum of "pending", "active", "stopped", or "error" status

新的标签页捕获状态。

boolean fullscreen

正在捕获的标签页中的元素是否处于全屏模式。

MediaStreamConstraint

属性
object mandatory
object (可选)
optional

从 Chrome 32 开始支持。

方法

capture

chrome.tabCapture.capture(object options, function callback)

捕获当前活动标签页的可视区域。该方法只能在扩展程序被调用之后在当前活动网页上使用,与 activeTab 的工作方式类似。

参数
object options

配置返回的流媒体。

boolean (可选)
audio
boolean (可选)
video
MediaStreamConstraint (可选)
audioConstraints
MediaStreamConstraint (可选)
videoConstraints
function callback

传递返回的流媒体或 null 的回调函数。

callback 参数应该是一个如下形式的函数:

function(LocalMediaStream stream) {...};
LocalMediaStream stream

getCapturedTabs

chrome.tabCapture.getCapturedTabs(function callback)

返回已经请求捕获或者正在捕获的标签页列表,即 status != "stopped" 并且 status != "error"。这样扩展程序就能告知用户已经存在标签页捕获,使新的标签页捕获不能成功(或者防止同一个标签页的重复请求)。

参数
function callback

callback 参数应该是一个如下形式的函数:

function(array of CaptureInfo result) {...};
array of CaptureInfo result

事件

onStatusChanged

标签页的捕获状态更改时产生该事件,这样扩展程序就能跟踪标签页的捕获状态,使用户界面元素(例如页面按钮及信息栏)保持同步。

addListener

chrome.tabCapture.onStatusChanged.addListener(function callback)
参数
function callback

callback 参数应该是一个如下形式的函数:

function( CaptureInfo info) {...};
CaptureInfo info