Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(670)

Unified Diff: chrome/common/extensions/api/tab_capture.idl

Issue 503503003: Documentation updates for chrome.tabCapture. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Clarify activeTab comment. Created 6 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/api/tab_capture.idl
diff --git a/chrome/common/extensions/api/tab_capture.idl b/chrome/common/extensions/api/tab_capture.idl
index 7e3e2a2567f560f3dcc4939ebe1eb080e538d149..978c23581de0f101fd7435aa04bd4bf16b0c21ad 100644
--- a/chrome/common/extensions/api/tab_capture.idl
+++ b/chrome/common/extensions/api/tab_capture.idl
@@ -47,12 +47,15 @@ namespace tabCapture {
callback GetCapturedTabsCallback = void (CaptureInfo[] result);
interface Functions {
- // Captures the visible area of the currently active tab.
- // This method can only be used on the currently active page after the
- // extension has been <em>invoked</em>, similar to the way that
- // <a href="activeTab.html">activeTab</a> works.
+ // Captures the visible area of the currently active tab. Capture can
+ // only be started on the currently active tab after the extension has been
+ // <em>invoked</em>. 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.
- // |callback| : Callback with either the stream returned or null.
+ // |callback| : Callback with either the tab capture stream or
+ // <code>null</code>.
static void capture(CaptureOptions options,
GetTabMediaCallback callback);
@@ -61,6 +64,7 @@ namespace tabCapture {
// 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).
+ // |callback| : Callback invoked with CaptureInfo[] for captured tabs.
static void getCapturedTabs(GetCapturedTabsCallback callback);
};
@@ -68,6 +72,7 @@ namespace tabCapture {
// 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 and infobars in sync.
+ // |info| : CaptureInfo with new capture status for the tab.
static void onStatusChanged(CaptureInfo info);
};
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698