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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 6 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/experimental.keybinding.html ('k') | chrome/common/extensions/docs/experimental.offscreenTabs.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
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
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
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
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <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>
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 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.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">chrome.experimental.mediaGalleries</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#apiReference">API reference: chrome.experimental.media Galleries</a>
196 <ol>
197 <li>
198 <a href="#global-methods">Methods</a>
199 <ol>
200 <li>
201 <a href="#method-assembleMediaFile">assembleMediaFile</a>
202 </li><li>
203 <a href="#method-extractEmbeddedThumbnails">extractEmbeddedThumb nails</a>
204 </li><li>
205 <a href="#method-getMediaFileSystems">getMediaFileSystems</a>
206 </li><li>
207 <a href="#method-openMediaGalleryManager">openMediaGalleryManage r</a>
208 </li>
209 </ol>
210 </li>
211 </ol>
212 </li>
213 </ol>
214 </div>
215 <!-- /TABLE OF CONTENTS -->
216 <!-- Standard content lead-in for experimental API pages -->
217 <p id="classSummary">
218 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
219 </p>
220 <!-- STATIC CONTENT PLACEHOLDER -->
221 <div id="static"></div>
222 <!-- API PAGE -->
223 <div class="apiPage">
224 <a name="apiReference"></a>
225 <h2>API reference: chrome.experimental.mediaGalleries</h2>
226 <!-- PROPERTIES -->
227 <!-- /apiGroup -->
228 <!-- METHODS -->
229 <div id="methodsTemplate" class="apiGroup">
230 <a name="global-methods"></a>
231 <h3>Methods</h3>
232 <!-- iterates over all functions -->
233 <div class="apiItem">
234 <a name="method-assembleMediaFile"></a> <!-- method-anchor -->
235 <h4>assembleMediaFile</h4>
236 <div class="summary">
237 <!-- Note: intentionally longer 80 columns -->
238 <span>chrome.experimental.mediaGalleries.assembleMediaFile</sp an>(<span class="optional"><span>object</span>
239 <var><span>mediaFileContents</span></var></span><span clas s="optional"><span>, </span><span>object</span>
240 <var><span>metadata</span></var></span><span class="null"> <span>, </span><span>function</span>
241 <var><span>callback</span></var></span>)</div>
242 <div class="description">
243 <p>Create a new MediaFile setting the metadata in the Blob to th e supplied values, overriding any existing metadata in the media file. If user a gent does not recognize the&nbsp;Blob as a supported file format, it will return null in the callback.</p>
244 <!-- PARAMETERS -->
245 <h4>Parameters</h4>
246 <dl>
247 <div>
248 <div>
249 <dt>
250 <var>mediaFileContents</var>
251 <em>
252 <!-- TYPE -->
253 <div style="display:inline">
254 (
255 <span class="optional">optional</span>
256 <span id="typeTemplate">
257 <span>
258 <span>object</span>
259 </span>
260 </span>
261 )
262 </div>
263 </em>
264 </dt>
265 <dd class="todo">
266 Undocumented.
267 </dd>
268 <!-- OBJECT PROPERTIES -->
269 <!-- OBJECT METHODS -->
270 <!-- OBJECT EVENT FIELDS -->
271 <!-- FUNCTION PARAMETERS -->
272 </div>
273 </div><div>
274 <div>
275 <dt>
276 <var>metadata</var>
277 <em>
278 <!-- TYPE -->
279 <div style="display:inline">
280 (
281 <span class="optional">optional</span>
282 <span id="typeTemplate">
283 <span>
284 <span>object</span>
285 </span>
286 </span>
287 )
288 </div>
289 </em>
290 </dt>
291 <dd class="todo">
292 Undocumented.
293 </dd>
294 <!-- OBJECT PROPERTIES -->
295 <!-- OBJECT METHODS -->
296 <!-- OBJECT EVENT FIELDS -->
297 <!-- FUNCTION PARAMETERS -->
298 </div>
299 </div><div>
300 <div>
301 <dt>
302 <var>callback</var>
303 <em>
304 <!-- TYPE -->
305 <div style="display:inline">
306 (
307 <span id="typeTemplate">
308 <span>
309 <span>function</span>
310 </span>
311 </span>
312 )
313 </div>
314 </em>
315 </dt>
316 <dd class="todo">
317 Undocumented.
318 </dd>
319 <!-- OBJECT PROPERTIES -->
320 <!-- OBJECT METHODS -->
321 <!-- OBJECT EVENT FIELDS -->
322 <!-- FUNCTION PARAMETERS -->
323 </div>
324 </div>
325 </dl>
326 <!-- RETURNS -->
327 <dl>
328 </dl>
329 <!-- CALLBACK -->
330 <div>
331 <div>
332 <h4>Callback function</h4>
333 <p>
334 The <em>callback</em> parameter should specify a function
335 that looks like this:
336 </p>
337 <!-- Note: intentionally longer 80 columns -->
338 <pre>function(<span>object mediaFile</span>) <span class="subd ued">{...}</span>;</pre>
339 <dl>
340 <div>
341 <div>
342 <dt>
343 <var>mediaFile</var>
344 <em>
345 <!-- TYPE -->
346 <div style="display:inline">
347 (
348 <span class="optional">optional</span>
349 <span id="typeTemplate">
350 <span>
351 <span>object</span>
352 </span>
353 </span>
354 )
355 </div>
356 </em>
357 </dt>
358 <dd class="todo">
359 Undocumented.
360 </dd>
361 <!-- OBJECT PROPERTIES -->
362 <!-- OBJECT METHODS -->
363 <!-- OBJECT EVENT FIELDS -->
364 <!-- FUNCTION PARAMETERS -->
365 </div>
366 </div>
367 </dl>
368 </div>
369 </div>
370 <!-- MIN_VERSION -->
371 </div> <!-- /description -->
372 </div><div class="apiItem">
373 <a name="method-extractEmbeddedThumbnails"></a> <!-- method-anchor -->
374 <h4>extractEmbeddedThumbnails</h4>
375 <div class="summary"><span>object</span>
376 <!-- Note: intentionally longer 80 columns -->
377 <span>chrome.experimental.mediaGalleries.extractEmbeddedThumbn ails</span>(<span class="optional"><span>object</span>
378 <var><span>mediaFile</span></var></span>)</div>
379 <div class="description">
380 <p>Get any thumbnails contained in the passed media file. The re sulting directory reader refers to a virtual directory that can not be navigated to. If there are no thumbnails in the passed file entry, the virtual directory will have no entries.</p>
381 <!-- PARAMETERS -->
382 <h4>Parameters</h4>
383 <dl>
384 <div>
385 <div>
386 <dt>
387 <var>mediaFile</var>
388 <em>
389 <!-- TYPE -->
390 <div style="display:inline">
391 (
392 <span class="optional">optional</span>
393 <span id="typeTemplate">
394 <span>
395 <span>object</span>
396 </span>
397 </span>
398 )
399 </div>
400 </em>
401 </dt>
402 <dd class="todo">
403 Undocumented.
404 </dd>
405 <!-- OBJECT PROPERTIES -->
406 <!-- OBJECT METHODS -->
407 <!-- OBJECT EVENT FIELDS -->
408 <!-- FUNCTION PARAMETERS -->
409 </div>
410 </div>
411 </dl>
412 <!-- RETURNS -->
413 <h4>Returns</h4>
414 <dl>
415 <div>
416 <div>
417 <dt>
418 <em>
419 <!-- TYPE -->
420 <div style="display:inline">
421 (
422 <span class="optional">optional</span>
423 <span id="typeTemplate">
424 <span>
425 <span>object</span>
426 </span>
427 </span>
428 )
429 </div>
430 </em>
431 </dt>
432 <dd class="todo">
433 Undocumented.
434 </dd>
435 <!-- OBJECT PROPERTIES -->
436 <!-- OBJECT METHODS -->
437 <!-- OBJECT EVENT FIELDS -->
438 <!-- FUNCTION PARAMETERS -->
439 </div>
440 </div>
441 </dl>
442 <!-- CALLBACK -->
443 <!-- MIN_VERSION -->
444 </div> <!-- /description -->
445 </div><div class="apiItem">
446 <a name="method-getMediaFileSystems"></a> <!-- method-anchor -->
447 <h4>getMediaFileSystems</h4>
448 <div class="summary">
449 <!-- Note: intentionally longer 80 columns -->
450 <span>chrome.experimental.mediaGalleries.getMediaFileSystems</ span>(<span class="null"><span>function</span>
451 <var><span>callback</span></var></span>)</div>
452 <div class="description">
453 <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>
454 <!-- PARAMETERS -->
455 <h4>Parameters</h4>
456 <dl>
457 <div>
458 <div>
459 <dt>
460 <var>callback</var>
461 <em>
462 <!-- TYPE -->
463 <div style="display:inline">
464 (
465 <span id="typeTemplate">
466 <span>
467 <span>function</span>
468 </span>
469 </span>
470 )
471 </div>
472 </em>
473 </dt>
474 <dd class="todo">
475 Undocumented.
476 </dd>
477 <!-- OBJECT PROPERTIES -->
478 <!-- OBJECT METHODS -->
479 <!-- OBJECT EVENT FIELDS -->
480 <!-- FUNCTION PARAMETERS -->
481 </div>
482 </div>
483 </dl>
484 <!-- RETURNS -->
485 <dl>
486 </dl>
487 <!-- CALLBACK -->
488 <div>
489 <div>
490 <h4>Callback function</h4>
491 <p>
492 The <em>callback</em> parameter should specify a function
493 that looks like this:
494 </p>
495 <!-- Note: intentionally longer 80 columns -->
496 <pre>function(<span>array of object mediaFileSystems</span>) < span class="subdued">{...}</span>;</pre>
497 <dl>
498 <div>
499 <div>
500 <dt>
501 <var>mediaFileSystems</var>
502 <em>
503 <!-- TYPE -->
504 <div style="display:inline">
505 (
506 <span id="typeTemplate">
507 <span>
508 <span>
509 array of <span><span>
510 <span>
511 <span>object</span>
512 </span>
513 </span></span>
514 </span>
515 </span>
516 </span>
517 )
518 </div>
519 </em>
520 </dt>
521 <dd class="todo">
522 Undocumented.
523 </dd>
524 <!-- OBJECT PROPERTIES -->
525 <!-- OBJECT METHODS -->
526 <!-- OBJECT EVENT FIELDS -->
527 <!-- FUNCTION PARAMETERS -->
528 </div>
529 </div>
530 </dl>
531 </div>
532 </div>
533 <!-- MIN_VERSION -->
534 </div> <!-- /description -->
535 </div><div class="apiItem">
536 <a name="method-openMediaGalleryManager"></a> <!-- method-anchor - ->
537 <h4>openMediaGalleryManager</h4>
538 <div class="summary">
539 <!-- Note: intentionally longer 80 columns -->
540 <span>chrome.experimental.mediaGalleries.openMediaGalleryManag er</span>()</div>
541 <div class="description">
542 <p>The user can configure which directories on their computer ar e exposed as media galleries. Calling this function will cause the UI which conf igures media galleris to be visible in the current tab.</p>
543 <!-- PARAMETERS -->
544 <dl>
545 </dl>
546 <!-- RETURNS -->
547 <dl>
548 </dl>
549 <!-- CALLBACK -->
550 <!-- MIN_VERSION -->
551 </div> <!-- /description -->
552 </div> <!-- /apiItem -->
553 </div> <!-- /apiGroup -->
554 <!-- EVENTS -->
555 <!-- /apiGroup -->
556 <!-- TYPES -->
557 <!-- /apiGroup -->
558 </div> <!-- /apiPage -->
559 </div> <!-- /gc-pagecontent -->
560 </div> <!-- /g-section -->
561 </div> <!-- /codesiteContent -->
562 <div id="gc-footer" --="">
563 <div class="text">
564 <p>
565 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
566 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
567 Attribution 3.0 License</a>, and code samples are licensed under the
568 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
569 </p>
570 <p>
571 ©2011 Google
572 </p>
573 <!-- begin analytics -->
574 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
575 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
576 <script type="text/javascript">
577 // chrome doc tracking
578 try {
579 var engdocs = _gat._getTracker("YT-10763712-2");
580 engdocs._trackPageview();
581 } catch(err) {}
582 // code.google.com site-wide tracking
583 try {
584 _uacct="UA-18071-1";
585 _uanchor=1;
586 _uff=0;
587 urchinTracker();
588 }
589 catch(e) {/* urchinTracker not available. */}
590 </script>
591 <!-- end analytics -->
592 </div>
593 </div> <!-- /gc-footer -->
594 </div> <!-- /gc-container -->
595 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.keybinding.html ('k') | chrome/common/extensions/docs/experimental.offscreenTabs.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698