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

Side by Side Diff: chrome/common/extensions/api/tab_capture.idl

Issue 14107010: Update tabCapture API docs with browser action info. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 7 years, 8 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 unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 // An API for tab media streams. 5 // An API for tab media streams.
6 6
7 namespace tabCapture { 7 namespace tabCapture {
8 8
9 enum TabCaptureState { 9 enum TabCaptureState {
10 pending, 10 pending,
(...skipping 29 matching lines...) Expand all
40 MediaStreamConstraint? videoConstraints; 40 MediaStreamConstraint? videoConstraints;
41 }; 41 };
42 42
43 callback GetTabMediaCallback = 43 callback GetTabMediaCallback =
44 void ([instanceOf=LocalMediaStream] object stream); 44 void ([instanceOf=LocalMediaStream] object stream);
45 45
46 callback GetCapturedTabsCallback = void (CaptureInfo[] result); 46 callback GetCapturedTabsCallback = void (CaptureInfo[] result);
47 47
48 interface Functions { 48 interface Functions {
49 // Captures the visible area of the currently active tab. 49 // Captures the visible area of the currently active tab.
50 // Extensions must have the "tabCapture" permission to use this method. 50 // Extensions must have the "tabCapture" permission to use this method. Use
51 // of this method for the currently active tab must also first be "granted"
not at google - send to devlin 2013/04/18 18:29:21 must also first be -> can only be "granted" -> gr
mark a. foltz 2013/04/18 18:30:05 Might say: Use of this method requires that the u
not at google - send to devlin 2013/04/18 18:31:36 Yes - and several other user actions.
mark a. foltz 2013/04/18 18:33:23 Okay, then might say "clicking on the extension" o
justinlin 2013/04/18 20:10:00 Done. Yea, that sounds better.
justinlin 2013/04/18 20:10:00 Just "granted through a user action" like Ben sugg
52 // through a user action of clicking on the extension icon. Note that
53 // Chrome internal pages cannot be captured.
51 // |options| : Configures the returned media stream. 54 // |options| : Configures the returned media stream.
52 // |callback| : Callback with either the stream returned or null. 55 // |callback| : Callback with either the stream returned or null.
53 static void capture(CaptureOptions options, 56 static void capture(CaptureOptions options,
54 GetTabMediaCallback callback); 57 GetTabMediaCallback callback);
55 58
56 // Returns a list of tabs that have requested capture or are being 59 // Returns a list of tabs that have requested capture or are being
57 // captured, i.e. status != stopped and status != error. 60 // captured, i.e. status != stopped and status != error.
58 // This allows extensions to inform the user that there is an existing 61 // This allows extensions to inform the user that there is an existing
59 // tab capture that would prevent a new tab capture from succeeding (or 62 // tab capture that would prevent a new tab capture from succeeding (or
60 // to prevent redundant requests for the same tab). 63 // to prevent redundant requests for the same tab).
61 static void getCapturedTabs(GetCapturedTabsCallback callback); 64 static void getCapturedTabs(GetCapturedTabsCallback callback);
62 }; 65 };
63 66
64 interface Events { 67 interface Events {
65 // Event fired when the capture status of a tab changes. 68 // Event fired when the capture status of a tab changes.
66 // This allows extension authors to keep track of the capture status of 69 // This allows extension authors to keep track of the capture status of
67 // tabs to keep UI elements like page actions and infobars in sync. 70 // tabs to keep UI elements like page actions and infobars in sync.
68 static void onStatusChanged(CaptureInfo info); 71 static void onStatusChanged(CaptureInfo info);
69 }; 72 };
70 73
71 }; 74 };
OLDNEW
« 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