chrome.tabCapture
- Description
Use the
chrome.tabCaptureAPI to interact with tab media streams. - Permissions
tabCapture - AvailabilityForeground only
Summary
- Types
- Methods
- Events
Types
CaptureInfo
Properties
- fullscreen
boolean
Whether an element in the tab being captured is in fullscreen mode.
- status
The new capture status of the tab.
- tabId
number
The id of the tab whose status changed.
CaptureOptions
Properties
- audio
boolean optional
- audioConstraints
MediaStreamConstraint optional
- video
boolean optional
- videoConstraints
MediaStreamConstraint optional
GetMediaStreamOptions
Properties
- consumerTabId
number optional
Optional tab id of the tab which will later invoke
getUserMedia()to consume the stream. If not specified then the resulting stream can be used only by the calling extension. The stream can only be used by frames in the given tab whose security origin matches the consumber tab's origin. The tab's origin must be a secure origin, e.g. HTTPS. - targetTabId
number optional
Optional tab id of the tab which will be captured. If not specified then the current active tab will be selected. Only tabs for which the extension has been granted the
activeTabpermission can be used as the target tab.
MediaStreamConstraint
Properties
- mandatory
object
- optional
object optional
TabCaptureState
Type
"pending" "active" "stopped" "error"
Methods
capture
chrome.tabCapture.capture(
options: CaptureOptions,
callback: function,
)Captures the visible area of the currently active tab. Capture can only be started on the currently active tab after the extension has been invoked, similar to the way that activeTab works. Capture is maintained across page navigations within the tab, and stops when the tab is closed, or the media stream is closed by the extension.
Parameters
- options
Configures the returned media stream.
- callback
function
The
callbackparameter looks like:(stream: LocalMediaStream) => void- stream
LocalMediaStream
getCapturedTabs
chrome.tabCapture.getCapturedTabs(
callback: function,
)Returns a list of tabs that have requested capture or are being captured, i.e. status != stopped and status != error. This allows extensions to inform the user that there is an existing tab capture that would prevent a new tab capture from succeeding (or to prevent redundant requests for the same tab).
Parameters
- callback
function
The
callbackparameter looks like:(result: CaptureInfo[]) => void- result
getMediaStreamId
chrome.tabCapture.getMediaStreamId(
options?: GetMediaStreamOptions,
callback: function,
)Creates a stream ID to capture the target tab. Similar to chrome.tabCapture.capture() method, but returns a media stream ID, instead of a media stream, to the consumer tab.
Parameters
- options
GetMediaStreamOptions optional
- callback
function
The
callbackparameter looks like:(streamId: string) => void- streamId
string
Events
onStatusChanged
chrome.tabCapture.onStatusChanged.addListener(
callback: function,
)Event fired when the capture status of a tab changes. This allows extension authors to keep track of the capture status of tabs to keep UI elements like page actions in sync.
Parameters
- callback
function
The
callbackparameter looks like:(info: CaptureInfo) => void- info