chrome/common/extensions/docs/apps/mediaGalleries.html - Issue 10832079: Update media galleries documentation.

Unified Diff: chrome/common/extensions/docs/apps/mediaGalleries.html

Issue 10832079: Update media galleries documentation. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 years, 5 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

« no previous file with comments | « chrome/common/extensions/api/media_galleries.idl ('k') | chrome/common/extensions/docs/extensions/experimental.mediaGalleries.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/apps/mediaGalleries.html

diff --git a/chrome/common/extensions/docs/apps/mediaGalleries.html b/chrome/common/extensions/docs/apps/mediaGalleries.html

new file mode 100644

index 0000000000000000000000000000000000000000..f1a03ecbf7e462e22a2f1cf829d9517c3e2c5a3a

--- /dev/null

+++ b/chrome/common/extensions/docs/apps/mediaGalleries.html

@@ -0,0 +1,421 @@

+<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

+ 1) The <head> information in this page is significant, should be uniform

+ across api docs and should be edited only with knowledge of the

+ templating mechanism.

+ 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

+ browser, it will be re-generated from the template, json schema and

+ authored overview content.

+ 4) The <body>.innerHTML is also generated by an offline step so that this

+ page may easily be indexed by search engines.

+--><html xmlns="http://www.w3.org/1999/xhtml"><head>

+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

+ <link href="../css/print.css" rel="stylesheet" type="text/css" media="print">

+ <script type="text/javascript" src="../../../../third_party/jstemplate/jstemplate_compiled.js">

+ </script>

+ <script type="text/javascript" src="../../../../../third_party/json_minify/minify-sans-regexp.js">

+ </script>

+ <script type="text/javascript" src="../js/api_page_generator.js"></script>

+ <script type="text/javascript" src="../js/bootstrap.js"></script>

+ <script type="text/javascript" src="../js/sidebar.js"></script>

+ <meta name="description" content="Documentation for the chrome.mediaGalleries module, which is part of the Google Chrome extension APIs."><title>Media Galleries - Google Chrome Extensions - Google Code</title></head>

+ <body doc-family="apps"> <link href="../css/ApiRefStyles_apps.css" rel="stylesheet" type="text/css">

+ <link href="../css/prettify.css" rel="stylesheet" type="text/css">

+ <link href="../css/shared.css" rel="stylesheet" type="text/css">

+ <div id="devModeWarning" class="displayModeWarning">

+ You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

+ </div>

+ <div id="branchWarning" class="displayModeWarning">

+ <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

+ It may not work with the stable release of Chrome.</span>

+ <select id="branchChooser">

+ <option>Choose a different version...

+ </option><option value="">Stable

+ </option><option value="beta">Beta

+ </option><option value="dev">Dev

+ </option><option value="trunk">Trunk

+ </option></select>

+ </div>

+ <div id="unofficialWarning" class="displayModeWarning">

+ <span>WARNING: This is unofficial documentation. It may not work with the

+ current release of Chrome.</span>

+ <button id="goToOfficialDocs">Go to the official docs</button>

+ </div>

+ <div id="gc-container" class="labs">

+

+ <!-- In particular, sub-templates that recurse, must be used by allowing

+ jstemplate to make a copy of the template in this section which

+ are not operated on by way of the jsskip="true" -->

+

+ <a id="top"></a>

+ <div id="skipto">

+ <a href="#gc-pagecontent">Skip to page content</a>

+ <a href="#gc-toc">Skip to main navigation</a>

+ </div>

+

+ <table id="header" width="100%" cellspacing="0" border="0">

+ <tbody><tr>

+ <td valign="middle"><a href="http://code.google.com/"><img src="../images/chrome_logo.gif" alt="Google Code" style="border:0; margin:0;"></a></td>

+ <td valign="middle" width="100%" style="padding-left:0.6em;">

+ <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

+ <div id="gsc-search-box">

+ <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

+ <input type="hidden" name="ie" value="UTF-8">

+ <input id="gsc-search-input" type="text" name="q" value="" size="55">

+ <button class="gsc-search-button" type="submit" name="sa">

+ <img class="gsc-search-button-lens" src="../images/search.png" alt="Search">

+ </button>

+ <br>

+ <span class="greytext">e.g. "event page" or "alarms"</span>

+ </div>

+ </form>

+ <script type="text/javascript" src="https://www.google.com/jsapi"></script>

+ <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

+ <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

+ <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

+ </td>

+ </tr>

+ </tbody></table>

+ <div id="codesiteContent" class="">

+ <a id="gc-topnav-anchor"></a>

+ <div id="gc-topnav">

+ <h1>Packaged Apps</h1>

+ <ul id="home" class="gc-topnav-tabs">

+ <li id="home_link">

+ <a href="about_apps.html" title="Packaged Apps home page"><span>Home</span></a>

+ </li>

+ <li id="docs_link">

+ <a href="develop_apps.html" title="Packaged apps developer documentation"><span>Docs</span></a>

+ </li>

+ <li id="samples_link">

+ <a href="https://github.com/GoogleChrome/chrome-app-samples" title="Packaged apps samples repository"><span>Samples</span></a>

+ </li>

+ <li id="group_link">

+ <a href="http://groups.google.com/a/chromium.org/group/chromium-apps" title="Google Chrome Apps developer forum"><span>Group</span></a>

+ </li>

+ <li id="so_link">

+ <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow"><span>Questions?</span></a>

+ </li>

+ </ul>

+ </div>

+ <div class="g-section g-tpl-170">

+

+ <div class="g-unit g-first" id="gc-toc">

+ <ul>

+ <li><h2>Getting Started</h2>

+ <ul>

+ <li><a href="about_apps.html">What Are Packaged Apps?</a></li>

+ <li><a href="app_architecture.html">Understand the Architecture</a></li>

+ <li><a href="first_app.html">Create Your First App</a></li>

+ </ul>

+ </li>

+ <li><h2>Developing</h2>

+ <ul>

+ <li><a href="develop_apps.html">Before You Start</a></li>

+ <li><span>The Fundamentals</span>

+ <ul>

+ <li><a href="app_lifecycle.html">Manage App Lifecycle</a></li>

+ <li><a href="app_storage.html">Manage Data</a></li>

+ <li><a href="offline_apps.html">Offline First</a></li>

+ <li><a href="app_external.html">Embed Content</a></li>

+ </ul>

+ </li>

+ <li><span>Security & Privacy</span>

+ <ul>

+ <li><a href="app_identity.html">Identify User</a></li>

+ <li><a href="app_csp.html">Comply with CSP</a></li>

+ </ul>

+ </li>

+ <li><span>Advanced Technologies</span>

+ <ul>

+ <li><a href="app_network.html">Network Communications</a></li>

+ <li><a href="app_hardware.html">Access Hardware Devices</a></li>

+ <li><a href="app_intents.html">Connect Apps with Web Intents</a></li>

+ </ul>

+ </li>

+ <li><a href="app_frameworks.html">MVC Architecture</a></li>

+ </ul>

+ </li>

+ <li><h2>Deploying</h2>

+ <ul>

+ <li><a href="publish_app.html">Publish</a></li>

+ </ul>

+ </li>

+ <li><h2>Reference</h2>

+ <ul>

+ <li><a href="manifest.html">Manifest Files</a></li>

+ <li><a href="api_index.html">Chrome JavaScript APIs</a></li>

+ <li><a href="api_other.html">Supported Libraries</a></li>

+ <li><a href="app_deprecated.html">Disabled Web Features</a></li>

+ </ul>

+ </li>

+ <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">Samples</a></h2></li>

+ <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li>

+ </ul>

+ </div>

+ <script>

+ initToggles();

+ </script>

+ <div class="g-unit" id="gc-pagecontent">

+ <div id="pageTitle">

+ <h1 class="page_title">Media Galleries</h1>

+ </div>

+

+ <div id="toc">

+ <h2>Contents</h2>

+ <ol>

+ <li>

+ <a href="#manifest">Manifest</a>

+ <ol>

+ </ol>

+ </li>

+ <li>

+ <a href="#apiReference">API reference: chrome.mediaGalleries</a>

+ <ol>

+ <li>

+ <a href="#global-methods">Methods</a>

+ <ol>

+ <li>

+ <a href="#method-getMediaFileSystems">getMediaFileSystems</a>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </div>

+

+

+

+ <div id="static"><div id="pageData-name" class="pageData">Media Galleries</div>

+

+<p>

+The media galleries API allows you to access media files (images,

+video, audio) from the user's local disks (with the user's consent).

+</p>

+<p>

+Using the API, you can prompt the user for permission to access the media

+galleries. The permission dialog will contain common media locations for

+the platform and will allow the user to add additional locations. From those

+locations, only media files will be present in the file system objects.

+</p>

+<h2 id="manifest">Manifest</h2>

+<p>You must declare the type of access to the media gallery you require

+in your extension's manifest to use the API. Currently only the

+"mediaGalleriesRead" permission is allowed. This permission does not

+currently trigger an install time permission prompt because it requires

battre 2012/07/31 08:00:02 You cannot say "does not *currently* trigger an in

vandebo (ex-Chrome) 2012/07/31 16:43:43 Rephrased.

+the user to grant permission at runtime.</p>

+<p>

+You may also specify the "mediaGalleriesAllGalleries" permission to get

battre 2012/07/31 08:00:02 This contradicts to the statement "only the 'media

vandebo (ex-Chrome) 2012/07/31 16:43:43 Rephrased.

+access to all auto-detected media galleries on the user's computer. This

+permission displays an install time prompt indicating that the extension

+will have access to all of the user's media files.

+</p>

+

+</div>

+

+ <div class="apiPage">

+ <a name="apiReference"></a>

+ <h2>API reference: chrome.mediaGalleries</h2>

+

+

+

+ <div id="methodsTemplate" class="apiGroup">

+ <a name="global-methods"></a>

+ <h3>Methods</h3>

+

+ <div class="apiItem">

+ <a name="method-getMediaFileSystems"></a>

+ <h4>getMediaFileSystems</h4>

+ <div class="summary">

+

+ <span>chrome.mediaGalleries.getMediaFileSystems</span>(<span class="optional"><span>object</span>

+ <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span>

+ <var><span>MediaFileSystemsCallback</span></var></span>)</div>

+ <div class="description">

+ <p>Get the media galleries configured in this user agent. If none are configured or available, the callback will receive an empty array.</p>

+

+ <h4>Parameters</h4>

+ <dl>

+ <div>

+ <dt>

+ <var>details</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional">optional</span>

+ <span id="typeTemplate">

+ <span>

+ <span>object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo">

+ Undocumented.

+ </dd>

+

+ <dd>

+ <dl>

+ <div>

+ <dt>

+ <var>interactive</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional">optional</span>

+ <span class="enum">enumerated</span>

+ <span id="typeTemplate">

+ <span>

+ <span>string</span>

+ <span>["no", "yes", "if_needed"]</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd>Whether to prompt the user for permission to additional media galleries 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 galleries and the value 'if_needed' is passed, then the media gallery configuration dialog will be displayed.</dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div>

+ <div>

+ <dt>

+ <var>MediaFileSystemsCallback</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <span>function</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo">

+ Undocumented.

+ </dd>

+

+

+

+

+ <dd>

+ <div>

+ <h5>Parameters</h5>

+ <dl>

+ <div>

+ <dt>

+ <var>mediaFileSystems</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional">optional</span>

+ <span id="typeTemplate">

+ <span>

+ array of <span><span>

+ <span>

+ <span>LocalFileSystem</span>

battre 2012/07/31 08:00:02 Why is this no link? What is a LocalFileSystem obj

vandebo (ex-Chrome) 2012/07/31 16:43:43 It's not an extension object. It refers to http:/

+ </span>

+ </span></span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </div>

+ </dd>

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+

+ </div>

+ </div>

+ </div>

+

+

+

+

+ </div>

+ </div>

+ </div>

+ </div>

+ <div id="gc-footer" --="">

+ <div class="text">

+ <p>

+ Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,

+ the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons

+ Attribution 3.0 License</a>, and code samples are licensed under the

+ <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

+ </p>

+ <p>

+ </p>

+

+<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

+<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>

+<script src="../js/prettify.js" type="text/javascript"></script>

+<script>

+ // Auto syntax highlight all pre tags.

+ var pres = document.querySelectorAll('pre');

+ for (var i = 0, pre; pre = pres[i]; ++i) {

+ pre.className += ' prettyprint';

+ };

+ prettyPrint();

+</script>

+<script type="text/javascript">

+ // chrome doc tracking

+ try {

+ var engdocs = _gat._getTracker("YT-10763712-2");

+ engdocs._trackPageview();

+ } catch(err) {}

+ // code.google.com site-wide tracking

+ try {

+ _uacct="UA-18071-1";

+ _uanchor=1;

+ _uff=0;

+ urchinTracker();

+ }

+ catch(e) {/* urchinTracker not available. */}

+</script>

+

+ </div>

+ </div>

+ </div>

+</body></html>