chromex.ext.tab-capture — binaryage/chromex 0.6.5

clj

Use the chrome.tabCapture API to interact with tab media streams.

• available since Chrome 31
• https://developer.chrome.com/extensions/tabCapture

api-table clj

capture clj/s macro

(capture options)

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.

|options| - Configures the returned media stream.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [stream] where:

|stream| - https://developer.chrome.com/extensions/tabCapture#property-callback-stream.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/tabCapture#method-capture.

capture* cljs

(capture* config options)

capture-offscreen-tab clj/s macro

(capture-offscreen-tab start-url options)

Creates an off-screen tab and navigates it to the given |startUrl|. Then, capture is started and a MediaStream is returned via |callback|.Off-screen tabs are isolated from the user's normal browser experience. They do not show up in the browser window or tab strip, nor are they visible to extensions (e.g., via the chrome.tabs.* APIs).An off-screen tab remains alive until one of three events occurs: 1. All MediaStreams providing its captured content are closed; 2. the page self-closes (e.g., via window.close()); 3. the extension that called captureOffscreenTab() is unloaded.Sandboxing: The off-screen tab does not have any access whatsoever to the local user profile (including cookies, HTTP auth, etc.). Instead, it is provided its own sandboxed profile. Also, it cannot access any interactive resources such as keyboard/mouse input, media recording devices (e.g., web cams), copy/paste to/from the system clipboard, etc.Note: This is a new API, currently only available in Canary/Dev channel, and may change without notice.

|start-url| - https://developer.chrome.com/extensions/tabCapture#property-captureOffscreenTab-startUrl. |options| - Constraints for the capture and returned MediaStream.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [stream] where:

|stream| - https://developer.chrome.com/extensions/tabCapture#property-callback-stream.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/tabCapture#method-captureOffscreenTab.

capture-offscreen-tab* cljs

(capture-offscreen-tab* config start-url options)

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-captured-tabs clj/s macro

(get-captured-tabs)

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).

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [result] where:

|result| - https://developer.chrome.com/extensions/tabCapture#property-callback-result.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/tabCapture#method-getCapturedTabs.

get-captured-tabs* cljs

(get-captured-tabs* config)

get-media-stream-id clj/s macro

(get-media-stream-id)

(get-media-stream-id options)

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.

|options| - https://developer.chrome.com/extensions/tabCapture#property-getMediaStreamId-options.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [stream-id] where:

|stream-id| - https://developer.chrome.com/extensions/tabCapture#property-callback-streamId.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/tabCapture#method-getMediaStreamId.

get-media-stream-id* cljs

(get-media-stream-id* config options)

on-status-changed* cljs

(on-status-changed* config channel & args)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.tab-capture namespace.

tap-on-status-changed-events clj/s macro

(tap-on-status-changed-events channel & args)

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.

Events will be put on the |channel| with signature [::on-status-changed [info]] where:

|info| - CaptureInfo with new capture status for the tab.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/tabCapture#event-onStatusChanged.