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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/apps/experimental.mediaGalleries.html

Issue 10823193: Move MediaGalleries.getMediaFileSystems back to experimental for M22 (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 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 unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/apps/api_index.html ('k') | chrome/common/extensions/docs/apps/mediaGalleries.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="../css/print.css" rel="stylesheet" type="text/css" media="print" > 12 <link href="../css/print.css" rel="stylesheet" type="text/css" media="print" >
13 <script type="text/javascript" src="../../../../third_party/jstemplate/jstem plate_compiled.js"> 13 <script type="text/javascript" src="../../../../third_party/jstemplate/jstem plate_compiled.js">
14 </script> 14 </script>
15 <script type="text/javascript" src="../../../../../third_party/json_minify/m inify-sans-regexp.js"> 15 <script type="text/javascript" src="../../../../../third_party/json_minify/m inify-sans-regexp.js">
16 </script> 16 </script>
17 <script type="text/javascript" src="../js/api_page_generator.js"></script> 17 <script type="text/javascript" src="../js/api_page_generator.js"></script>
18 <script type="text/javascript" src="../js/bootstrap.js"></script> 18 <script type="text/javascript" src="../js/bootstrap.js"></script>
19 <script type="text/javascript" src="../js/sidebar.js"></script> 19 <script type="text/javascript" src="../js/sidebar.js"></script>
20 <meta name="description" content="Documentation for the chrome.experimental.me diaGalleries module, which is part of the Google Chrome extension APIs."><title >chrome.experimental.mediaGalleries - Google Chrome Extensions - Google Code</ti tle></head> 20 <meta name="description" content="Documentation for the chrome.experimental.me diaGalleries module, which is part of the Google Chrome extension APIs."><title >Media Galleries - Google Chrome Extensions - Google Code</title></head>
21 <body doc-family="apps"> <link href="../css/ApiRefStyles.css" rel="stylesheet " type="text/css"> 21 <body doc-family="apps"> <link href="../css/ApiRefStyles.css" rel="stylesheet " type="text/css">
22 <link href="../css/prettify.css" rel="stylesheet" type="text/css"> 22 <link href="../css/prettify.css" rel="stylesheet" type="text/css">
23 <link href="../css/shared.css" rel="stylesheet" type="text/css"> 23 <link href="../css/shared.css" rel="stylesheet" type="text/css">
24 <div id="devModeWarning" class="displayModeWarning"> 24 <div id="devModeWarning" class="displayModeWarning">
25 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files. 25 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
26 </div> 26 </div>
27 <div id="branchWarning" class="displayModeWarning"> 27 <div id="branchWarning" class="displayModeWarning">
28 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. 28 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
29 It may not work with the stable release of Chrome.</span> 29 It may not work with the stable release of Chrome.</span>
30 <select id="branchChooser"> 30 <select id="branchChooser">
(...skipping 119 matching lines...) Expand 10 before | Expand all | Expand 10 after
150 </li> 150 </li>
151 <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">S amples</a></h2></li> 151 <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">S amples</a></h2></li>
152 <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li> 152 <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li>
153 </ul> 153 </ul>
154 </div> 154 </div>
155 <script> 155 <script>
156 initToggles(); 156 initToggles();
157 </script> 157 </script>
158 <div class="g-unit" id="gc-pagecontent"> 158 <div class="g-unit" id="gc-pagecontent">
159 <div id="pageTitle"> 159 <div id="pageTitle">
160 <h1 class="page_title">chrome.experimental.mediaGalleries</h1> 160 <h1 class="page_title">Media Galleries</h1>
161 </div> 161 </div>
162 <!-- TABLE OF CONTENTS --> 162 <!-- TABLE OF CONTENTS -->
163 <div id="toc"> 163 <div id="toc">
164 <h2>Contents</h2> 164 <h2>Contents</h2>
165 <ol> 165 <ol>
166 <li>
167 <a href="#manifest">Manifest</a>
168 <ol>
169 </ol>
170 </li>
166 <li> 171 <li>
167 <a href="#apiReference">API reference: chrome.experimental.media Galleries</a> 172 <a href="#apiReference">API reference: chrome.experimental.media Galleries</a>
168 <ol> 173 <ol>
169 <li> 174 <li>
170 <a href="#global-methods">Methods</a> 175 <a href="#global-methods">Methods</a>
171 <ol> 176 <ol>
172 <li> 177 <li>
173 <a href="#method-assembleMediaFile">assembleMediaFile</a> 178 <a href="#method-assembleMediaFile">assembleMediaFile</a>
174 </li><li> 179 </li><li>
175 <a href="#method-extractEmbeddedThumbnails">extractEmbeddedThumb nails</a> 180 <a href="#method-extractEmbeddedThumbnails">extractEmbeddedThumb nails</a>
181 </li><li>
182 <a href="#method-getMediaFileSystems">getMediaFileSystems</a>
176 </li> 183 </li>
177 </ol> 184 </ol>
178 </li> 185 </li>
179 </ol> 186 </ol>
180 </li> 187 </li>
181 </ol> 188 </ol>
182 </div> 189 </div>
183 <!-- /TABLE OF CONTENTS --> 190 <!-- /TABLE OF CONTENTS -->
184 <!-- Standard content lead-in for experimental API pages --> 191 <!-- Standard content lead-in for experimental API pages -->
185 <p id="classSummary">
186 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
187 </p>
188 <!-- STATIC CONTENT PLACEHOLDER --> 192 <!-- STATIC CONTENT PLACEHOLDER -->
189 <div id="static"></div> 193 <div id="static"><div id="pageData-name" class="pageData">Media Gallerie s</div>
194 <!-- BEGIN AUTHORED CONTENT -->
195 <p>
196 The media galleries API allows you to access media files (images,
197 video, audio) from the user's local disks (with the user's consent).
198 </p>
199 <p>
200 Using the API, you can prompt the user for permission to access the media
201 galleries. The permission dialog will contain common media locations for
202 the platform and will allow the user to add additional locations. From those
203 locations, only media files will be present in the file system objects.
204 </p>
205 <h2 id="manifest">Manifest</h2>
206 <p>The media galleries API has two axes of permissions; the locations that
207 can be accessed, and the type of access (read-only, read-write, add-files).</p>
208 <p>On the location axis, specifying no location-type permission means that
209 no media galleries are accessible until the user grants permission to
210 specific media galleries at runtime using the media gallery configuration
211 dialog. This dialog can be programmatically triggered. Alternatively,
212 specifying the "mediaGalleriesAllGalleries" permission grants access to all
213 auto-detected media galleries on the user's computer. However, this
214 permission displays an install time prompt indicating that the extension
215 will have access to all of the user's media files.</p>
216 <p>On the access type axis, the "mediaGalleriesRead" permission grants the
217 extension the right to read files. This permission does not trigger an install
218 time permission prompt because the user must still grant access to particular
219 galleries, either with the "mediaGalleriesAllGalleries" permission or at
220 runtime by using the media gallery management dialog. For example:</p>
221 <pre>{
222 "name": "My extension",
223 ...
224 "permissions": [
225 <b>"mediaGalleriesAllGalleries"</b>
226 <b>"mediaGalleriesRead"</b>
227 ],
228 ...
229 }</pre>
230 <p>This set of permissions will trigger an install time permission prompt
231 and let the extension read from all auto-detected media galleries on the
232 user's computer. The user may add or remove galleries using the
233 media gallery management dialog, after which the extension will be able
234 to read all the media files from galleries that the user has selected.</p>
235 <p>Currently "mediaGalleriesRead" is the only access type supported by
236 this API. Read-write and add-file access with be implemented soon.</p>
237 <!-- END AUTHORED CONTENT -->
238 </div>
190 <!-- API PAGE --> 239 <!-- API PAGE -->
191 <div class="apiPage"> 240 <div class="apiPage">
192 <a name="apiReference"></a> 241 <a name="apiReference"></a>
193 <h2>API reference: chrome.experimental.mediaGalleries</h2> 242 <h2>API reference: chrome.experimental.mediaGalleries</h2>
194 <!-- PROPERTIES --> 243 <!-- PROPERTIES -->
195 <!-- /apiGroup --> 244 <!-- /apiGroup -->
196 <!-- METHODS --> 245 <!-- METHODS -->
197 <div id="methodsTemplate" class="apiGroup"> 246 <div id="methodsTemplate" class="apiGroup">
198 <a name="global-methods"></a> 247 <a name="global-methods"></a>
199 <h3>Methods</h3> 248 <h3>Methods</h3>
(...skipping 163 matching lines...) Expand 10 before | Expand all | Expand 10 after
363 <!-- FUNCTION PARAMETERS --> 412 <!-- FUNCTION PARAMETERS -->
364 </div> 413 </div>
365 </div> 414 </div>
366 </dl> 415 </dl>
367 <!-- RETURNS --> 416 <!-- RETURNS -->
368 <dl> 417 <dl>
369 </dl> 418 </dl>
370 <!-- CALLBACK --> 419 <!-- CALLBACK -->
371 <!-- MIN_VERSION --> 420 <!-- MIN_VERSION -->
372 </div> <!-- /description --> 421 </div> <!-- /description -->
422 </div><div class="apiItem">
423 <a name="method-getMediaFileSystems"></a> <!-- method-anchor -->
424 <h4>getMediaFileSystems</h4>
425 <div class="summary">
426 <!-- Note: intentionally longer 80 columns -->
427 <span>chrome.experimental.mediaGalleries.getMediaFileSystems</ span>(<span class="optional"><span>object</span>
428 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
429 <var><span>MediaFileSystemsCallback</span></var></span>)</ div>
430 <div class="description">
431 <p>Get the media galleries configured in this user agent. If non e are configured or available, the callback will receive an empty array.</p>
432 <!-- PARAMETERS -->
433 <h4>Parameters</h4>
434 <dl>
435 <div>
436 <div>
437 <dt>
438 <var>details</var>
439 <em>
440 <!-- TYPE -->
441 <div style="display:inline">
442 (
443 <span class="optional">optional</span>
444 <span id="typeTemplate">
445 <span>
446 <span>object</span>
447 </span>
448 </span>
449 )
450 </div>
451 </em>
452 </dt>
453 <dd class="todo">
454 Undocumented.
455 </dd>
456 <!-- OBJECT PROPERTIES -->
457 <dd>
458 <dl>
459 <div>
460 <div>
461 <dt>
462 <var>interactive</var>
463 <em>
464 <!-- TYPE -->
465 <div style="display:inline">
466 (
467 <span class="optional">optional</span>
468 <span class="enum">enumerated</span>
469 <span id="typeTemplate">
470 <span>
471 <span>string</span>
472 <span>["no", "yes", "if_needed"]</span>
473 </span>
474 </span>
475 )
476 </div>
477 </em>
478 </dt>
479 <dd>Whether to prompt the user for permission to additional media gall eries before returning the permitted set. Default is silent. If the value 'yes' is passed, or if the application has not been granted access to any media galle ries and the value 'if_needed' is passed, then the media gallery configuration d ialog will be displayed.</dd>
480 <!-- OBJECT PROPERTIES -->
481 <!-- OBJECT METHODS -->
482 <!-- OBJECT EVENT FIELDS -->
483 <!-- FUNCTION PARAMETERS -->
484 </div>
485 </div>
486 </dl>
487 </dd>
488 <!-- OBJECT METHODS -->
489 <!-- OBJECT EVENT FIELDS -->
490 <!-- FUNCTION PARAMETERS -->
491 </div>
492 </div><div>
493 <div>
494 <dt>
495 <var>MediaFileSystemsCallback</var>
496 <em>
497 <!-- TYPE -->
498 <div style="display:inline">
499 (
500 <span id="typeTemplate">
501 <span>
502 <span>function</span>
503 </span>
504 </span>
505 )
506 </div>
507 </em>
508 </dt>
509 <dd class="todo">
510 Undocumented.
511 </dd>
512 <!-- OBJECT PROPERTIES -->
513 <!-- OBJECT METHODS -->
514 <!-- OBJECT EVENT FIELDS -->
515 <!-- FUNCTION PARAMETERS -->
516 <dd>
517 <div>
518 <h5>Parameters</h5>
519 <dl>
520 <div>
521 <div>
522 <dt>
523 <var>mediaFileSystems</var>
524 <em>
525 <!-- TYPE -->
526 <div style="display:inline">
527 (
528 <span class="optional">optional</span>
529 <span id="typeTemplate">
530 <span>
531 <span>
532 array of <span><span>
533 <span>
534 <span>LocalFileSystem</span>
535 </span>
536 </span></span>
537 </span>
538 </span>
539 </span>
540 )
541 </div>
542 </em>
543 </dt>
544 <dd class="todo">
545 Undocumented.
546 </dd>
547 <!-- OBJECT PROPERTIES -->
548 <!-- OBJECT METHODS -->
549 <!-- OBJECT EVENT FIELDS -->
550 <!-- FUNCTION PARAMETERS -->
551 </div>
552 </div>
553 </dl>
554 </div>
555 </dd>
556 </div>
557 </div>
558 </dl>
559 <!-- RETURNS -->
560 <dl>
561 </dl>
562 <!-- CALLBACK -->
563 <!-- MIN_VERSION -->
564 </div> <!-- /description -->
373 </div> <!-- /apiItem --> 565 </div> <!-- /apiItem -->
374 </div> <!-- /apiGroup --> 566 </div> <!-- /apiGroup -->
375 <!-- EVENTS --> 567 <!-- EVENTS -->
376 <!-- /apiGroup --> 568 <!-- /apiGroup -->
377 <!-- TYPES --> 569 <!-- TYPES -->
378 <!-- /apiGroup --> 570 <!-- /apiGroup -->
379 </div> <!-- /apiPage --> 571 </div> <!-- /apiPage -->
380 </div> <!-- /gc-pagecontent --> 572 </div> <!-- /gc-pagecontent -->
381 </div> <!-- /g-section --> 573 </div> <!-- /g-section -->
382 </div> <!-- /codesiteContent --> 574 </div> <!-- /codesiteContent -->
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
416 _uff=0; 608 _uff=0;
417 urchinTracker(); 609 urchinTracker();
418 } 610 }
419 catch(e) {/* urchinTracker not available. */} 611 catch(e) {/* urchinTracker not available. */}
420 </script> 612 </script>
421 <!-- end analytics --> 613 <!-- end analytics -->
422 </div> 614 </div>
423 </div> <!-- /gc-footer --> 615 </div> <!-- /gc-footer -->
424 </div> <!-- /gc-container --> 616 </div> <!-- /gc-container -->
425 </body></html> 617 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/apps/api_index.html ('k') | chrome/common/extensions/docs/apps/mediaGalleries.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698