Skip to content

tab-capture.md

Latest commit

 

History

History
86 lines (56 loc) · 2.75 KB

tab-capture.md

File metadata and controls

86 lines (56 loc) · 2.75 KB
Raw

tabCapture

Documentation: Chrome Tab Capture API

A promise-based wrapper for the Chrome tabCapture API to capture and retrieve tab media streams.

Methods

Events

isAvailableTabCapture

isAvailableTabCapture(method?: ApiMethodName<typeof chrome.tabCapture>): boolean

The optional method is a native function name, for example isAvailableTabCapture("capture"). Import the public ApiMethodName type from @addon-core/browser for your own typed helpers. This checks callable presence without invoking the method; permissions and argument support still require handling.

Returns true when the tabCapture namespace is present on the API selected by browser() in the current context. Returns false if the namespace or WebExtension environment is absent, or if accessing it throws. The check is synchronous, does not log, and reads the current API on every call without caching. Without an argument, it checks namespace presence only. Pass a native method name to also check that it is callable. Neither form verifies permissions, argument support, or a successful operation. See method availability.

import {isAvailableTabCapture} from "@addon-core/browser";

if (isAvailableTabCapture()) {
    // The namespace is present; handle operation-specific failures when using it.
}

createTabCapture

createTabCapture(options: chrome.tabCapture.CaptureOptions): Promise<MediaStream | null>

Captures the visible media stream of a tab based on the specified options. Resolves with the MediaStream if successful, or null otherwise.

getCapturedTabs

getCapturedTabs(): Promise<chrome.tabCapture.CaptureInfo[]>

Retrieves details of all active tab capture sessions. Resolves with an array of CaptureInfo objects.

getCaptureMediaStreamId

getCaptureMediaStreamId(options: chrome.tabCapture.GetMediaStreamOptions): Promise<string>

Generates a media stream ID for capturing a tab via navigator.mediaDevices.getUserMedia. Resolves with the stream ID.

onCaptureStatusChanged

onCaptureStatusChanged(
  callback: (info: chrome.tabCapture.CaptureInfo) => void
): () => void

Adds a listener for tab capture status changes (started, stopped, source changed). Returns an unsubscribe function.