OLD | NEW |
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> |
(...skipping 157 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
168 <ol> | 168 <ol> |
169 <li> | 169 <li> |
170 <a href="#global-methods">Methods</a> | 170 <a href="#global-methods">Methods</a> |
171 <ol> | 171 <ol> |
172 <li> | 172 <li> |
173 <a href="#method-assembleMediaFile">assembleMediaFile</a> | 173 <a href="#method-assembleMediaFile">assembleMediaFile</a> |
174 </li><li> | 174 </li><li> |
175 <a href="#method-extractEmbeddedThumbnails">extractEmbeddedThumb
nails</a> | 175 <a href="#method-extractEmbeddedThumbnails">extractEmbeddedThumb
nails</a> |
176 </li><li> | 176 </li><li> |
177 <a href="#method-getMediaFileSystems">getMediaFileSystems</a> | 177 <a href="#method-getMediaFileSystems">getMediaFileSystems</a> |
178 </li><li> | |
179 <a href="#method-openMediaGalleryManager">openMediaGalleryManage
r</a> | |
180 </li> | 178 </li> |
181 </ol> | 179 </ol> |
182 </li> | 180 </li> |
183 </ol> | 181 </ol> |
184 </li> | 182 </li> |
185 </ol> | 183 </ol> |
186 </div> | 184 </div> |
187 <!-- /TABLE OF CONTENTS --> | 185 <!-- /TABLE OF CONTENTS --> |
188 <!-- Standard content lead-in for experimental API pages --> | 186 <!-- Standard content lead-in for experimental API pages --> |
189 <p id="classSummary"> | 187 <p id="classSummary"> |
(...skipping 10 matching lines...) Expand all Loading... |
200 <!-- METHODS --> | 198 <!-- METHODS --> |
201 <div id="methodsTemplate" class="apiGroup"> | 199 <div id="methodsTemplate" class="apiGroup"> |
202 <a name="global-methods"></a> | 200 <a name="global-methods"></a> |
203 <h3>Methods</h3> | 201 <h3>Methods</h3> |
204 <!-- iterates over all functions --> | 202 <!-- iterates over all functions --> |
205 <div class="apiItem"> | 203 <div class="apiItem"> |
206 <a name="method-assembleMediaFile"></a> <!-- method-anchor --> | 204 <a name="method-assembleMediaFile"></a> <!-- method-anchor --> |
207 <h4>assembleMediaFile</h4> | 205 <h4>assembleMediaFile</h4> |
208 <div class="summary"> | 206 <div class="summary"> |
209 <!-- Note: intentionally longer 80 columns --> | 207 <!-- Note: intentionally longer 80 columns --> |
210 <span>chrome.experimental.mediaGalleries.assembleMediaFile</sp
an>(<span class="optional"><span>object</span> | 208 <span>chrome.experimental.mediaGalleries.assembleMediaFile</sp
an>(<span class="null"><span>Blob</span> |
211 <var><span>mediaFileContents</span></var></span><span clas
s="optional"><span>, </span><span>object</span> | 209 <var><span>mediaFileContents</span></var></span><span clas
s="null"><span>, </span><span>object</span> |
212 <var><span>metadata</span></var></span><span class="null">
<span>, </span><span>function</span> | 210 <var><span>metadata</span></var></span><span class="null">
<span>, </span><span>function</span> |
213 <var><span>callback</span></var></span>)</div> | 211 <var><span>AssembleMediaFileCallback</span></var></span>)<
/div> |
214 <div class="description"> | 212 <div class="description"> |
215 <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 Blob as a supported file format, it will return
null in the callback.</p> | 213 <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 Blob as a supported file format, it will fail.</p> |
216 <!-- PARAMETERS --> | 214 <!-- PARAMETERS --> |
217 <h4>Parameters</h4> | 215 <h4>Parameters</h4> |
218 <dl> | 216 <dl> |
219 <div> | 217 <div> |
220 <div> | 218 <div> |
221 <dt> | 219 <dt> |
222 <var>mediaFileContents</var> | 220 <var>mediaFileContents</var> |
223 <em> | 221 <em> |
224 <!-- TYPE --> | 222 <!-- TYPE --> |
225 <div style="display:inline"> | 223 <div style="display:inline"> |
226 ( | 224 ( |
227 <span class="optional">optional</span> | |
228 <span id="typeTemplate"> | 225 <span id="typeTemplate"> |
229 <span> | 226 <span> |
230 <span>object</span> | 227 <span>Blob</span> |
231 </span> | 228 </span> |
232 </span> | 229 </span> |
233 ) | 230 ) |
234 </div> | 231 </div> |
235 </em> | 232 </em> |
236 </dt> | 233 </dt> |
237 <dd class="todo"> | 234 <dd>the media bytes.</dd> |
238 Undocumented. | |
239 </dd> | |
240 <!-- OBJECT PROPERTIES --> | 235 <!-- OBJECT PROPERTIES --> |
241 <!-- OBJECT METHODS --> | 236 <!-- OBJECT METHODS --> |
242 <!-- OBJECT EVENT FIELDS --> | 237 <!-- OBJECT EVENT FIELDS --> |
243 <!-- FUNCTION PARAMETERS --> | 238 <!-- FUNCTION PARAMETERS --> |
244 </div> | 239 </div> |
245 </div><div> | 240 </div><div> |
246 <div> | 241 <div> |
247 <dt> | 242 <dt> |
248 <var>metadata</var> | 243 <var>metadata</var> |
249 <em> | 244 <em> |
250 <!-- TYPE --> | 245 <!-- TYPE --> |
251 <div style="display:inline"> | 246 <div style="display:inline"> |
252 ( | 247 ( |
253 <span class="optional">optional</span> | |
254 <span id="typeTemplate"> | 248 <span id="typeTemplate"> |
255 <span> | 249 <span> |
256 <span>object</span> | 250 <span>object</span> |
257 </span> | 251 </span> |
258 </span> | 252 </span> |
259 ) | 253 ) |
260 </div> | 254 </div> |
261 </em> | 255 </em> |
262 </dt> | 256 </dt> |
263 <dd class="todo"> | 257 <dd>the metadata. TODO(estade): this should be [instanceOf=Metafile].<
/dd> |
264 Undocumented. | |
265 </dd> | |
266 <!-- OBJECT PROPERTIES --> | 258 <!-- OBJECT PROPERTIES --> |
267 <!-- OBJECT METHODS --> | 259 <!-- OBJECT METHODS --> |
268 <!-- OBJECT EVENT FIELDS --> | 260 <!-- OBJECT EVENT FIELDS --> |
269 <!-- FUNCTION PARAMETERS --> | 261 <!-- FUNCTION PARAMETERS --> |
270 </div> | 262 </div> |
271 </div><div> | 263 </div><div> |
272 <div> | 264 <div> |
273 <dt> | 265 <dt> |
274 <var>callback</var> | 266 <var>AssembleMediaFileCallback</var> |
275 <em> | 267 <em> |
276 <!-- TYPE --> | 268 <!-- TYPE --> |
277 <div style="display:inline"> | 269 <div style="display:inline"> |
278 ( | 270 ( |
279 <span id="typeTemplate"> | 271 <span id="typeTemplate"> |
280 <span> | 272 <span> |
281 <span>function</span> | 273 <span>function</span> |
282 </span> | 274 </span> |
283 </span> | 275 </span> |
284 ) | 276 ) |
285 </div> | 277 </div> |
286 </em> | 278 </em> |
287 </dt> | 279 </dt> |
288 <dd class="todo"> | 280 <dd class="todo"> |
289 Undocumented. | 281 Undocumented. |
290 </dd> | 282 </dd> |
291 <!-- OBJECT PROPERTIES --> | 283 <!-- OBJECT PROPERTIES --> |
292 <!-- OBJECT METHODS --> | 284 <!-- OBJECT METHODS --> |
293 <!-- OBJECT EVENT FIELDS --> | 285 <!-- OBJECT EVENT FIELDS --> |
294 <!-- FUNCTION PARAMETERS --> | 286 <!-- FUNCTION PARAMETERS --> |
| 287 <dd> |
| 288 <div> |
| 289 <h5>Parameters</h5> |
| 290 <dl> |
| 291 <div> |
| 292 <div> |
| 293 <dt> |
| 294 <var>mediaFile</var> |
| 295 <em> |
| 296 <!-- TYPE --> |
| 297 <div style="display:inline"> |
| 298 ( |
| 299 <span class="optional">optional</span> |
| 300 <span id="typeTemplate"> |
| 301 <span> |
| 302 <span>Blob</span> |
| 303 </span> |
| 304 </span> |
| 305 ) |
| 306 </div> |
| 307 </em> |
| 308 </dt> |
| 309 <dd class="todo"> |
| 310 Undocumented. |
| 311 </dd> |
| 312 <!-- OBJECT PROPERTIES --> |
| 313 <!-- OBJECT METHODS --> |
| 314 <!-- OBJECT EVENT FIELDS --> |
| 315 <!-- FUNCTION PARAMETERS --> |
295 </div> | 316 </div> |
| 317 </div> |
| 318 </dl> |
| 319 </div> |
| 320 </dd> |
| 321 </div> |
296 </div> | 322 </div> |
297 </dl> | 323 </dl> |
298 <!-- RETURNS --> | 324 <!-- RETURNS --> |
299 <dl> | 325 <dl> |
300 </dl> | 326 </dl> |
301 <!-- CALLBACK --> | 327 <!-- CALLBACK --> |
302 <!-- MIN_VERSION --> | 328 <!-- MIN_VERSION --> |
303 </div> <!-- /description --> | 329 </div> <!-- /description --> |
304 </div><div class="apiItem"> | 330 </div><div class="apiItem"> |
305 <a name="method-extractEmbeddedThumbnails"></a> <!-- method-anchor
--> | 331 <a name="method-extractEmbeddedThumbnails"></a> <!-- method-anchor
--> |
306 <h4>extractEmbeddedThumbnails</h4> | 332 <h4>extractEmbeddedThumbnails</h4> |
307 <div class="summary"><span>object</span> | 333 <div class="summary"> |
308 <!-- Note: intentionally longer 80 columns --> | 334 <!-- Note: intentionally longer 80 columns --> |
309 <span>chrome.experimental.mediaGalleries.extractEmbeddedThumbn
ails</span>(<span class="optional"><span>object</span> | 335 <span>chrome.experimental.mediaGalleries.extractEmbeddedThumbn
ails</span>(<span class="null"><span>object</span> |
310 <var><span>mediaFile</span></var></span>)</div> | 336 <var><span>mediaFile</span></var></span>)</div> |
311 <div class="description"> | 337 <div class="description"> |
312 <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> | 338 <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. TODO(estade): The return type should be Directory. The arg
ument type should be [instanceOf=FileEntry].</p> |
313 <!-- PARAMETERS --> | 339 <!-- PARAMETERS --> |
314 <h4>Parameters</h4> | 340 <h4>Parameters</h4> |
315 <dl> | 341 <dl> |
316 <div> | 342 <div> |
317 <div> | 343 <div> |
318 <dt> | 344 <dt> |
319 <var>mediaFile</var> | 345 <var>mediaFile</var> |
320 <em> | 346 <em> |
321 <!-- TYPE --> | 347 <!-- TYPE --> |
322 <div style="display:inline"> | 348 <div style="display:inline"> |
323 ( | 349 ( |
324 <span class="optional">optional</span> | |
325 <span id="typeTemplate"> | 350 <span id="typeTemplate"> |
326 <span> | 351 <span> |
327 <span>object</span> | 352 <span>object</span> |
328 </span> | 353 </span> |
329 </span> | 354 </span> |
330 ) | 355 ) |
331 </div> | 356 </div> |
332 </em> | 357 </em> |
333 </dt> | 358 </dt> |
334 <dd class="todo"> | 359 <dd class="todo"> |
335 Undocumented. | 360 Undocumented. |
336 </dd> | 361 </dd> |
337 <!-- OBJECT PROPERTIES --> | 362 <!-- OBJECT PROPERTIES --> |
338 <!-- OBJECT METHODS --> | 363 <!-- OBJECT METHODS --> |
339 <!-- OBJECT EVENT FIELDS --> | 364 <!-- OBJECT EVENT FIELDS --> |
340 <!-- FUNCTION PARAMETERS --> | 365 <!-- FUNCTION PARAMETERS --> |
341 </div> | 366 </div> |
342 </div> | 367 </div> |
343 </dl> | 368 </dl> |
344 <!-- RETURNS --> | 369 <!-- RETURNS --> |
345 <h4>Returns</h4> | 370 <dl> |
| 371 </dl> |
| 372 <!-- CALLBACK --> |
| 373 <!-- MIN_VERSION --> |
| 374 </div> <!-- /description --> |
| 375 </div><div class="apiItem"> |
| 376 <a name="method-getMediaFileSystems"></a> <!-- method-anchor --> |
| 377 <h4>getMediaFileSystems</h4> |
| 378 <div class="summary"> |
| 379 <!-- Note: intentionally longer 80 columns --> |
| 380 <span>chrome.experimental.mediaGalleries.getMediaFileSystems</
span>(<span class="optional"><span>object</span> |
| 381 <var><span>details</span></var></span><span class="null"><
span>, </span><span>function</span> |
| 382 <var><span>MediaFileSystemsCallback</span></var></span>)</
div> |
| 383 <div class="description"> |
| 384 <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> |
| 385 <!-- PARAMETERS --> |
| 386 <h4>Parameters</h4> |
346 <dl> | 387 <dl> |
347 <div> | 388 <div> |
348 <div> | 389 <div> |
349 <dt> | 390 <dt> |
| 391 <var>details</var> |
350 <em> | 392 <em> |
351 <!-- TYPE --> | 393 <!-- TYPE --> |
352 <div style="display:inline"> | 394 <div style="display:inline"> |
353 ( | 395 ( |
354 <span class="optional">optional</span> | 396 <span class="optional">optional</span> |
355 <span id="typeTemplate"> | 397 <span id="typeTemplate"> |
356 <span> | 398 <span> |
357 <span>object</span> | 399 <span>object</span> |
358 </span> | 400 </span> |
359 </span> | 401 </span> |
360 ) | 402 ) |
361 </div> | 403 </div> |
362 </em> | 404 </em> |
363 </dt> | 405 </dt> |
364 <dd class="todo"> | 406 <dd class="todo"> |
365 Undocumented. | 407 Undocumented. |
366 </dd> | 408 </dd> |
367 <!-- OBJECT PROPERTIES --> | 409 <!-- OBJECT PROPERTIES --> |
| 410 <dd> |
| 411 <dl> |
| 412 <div> |
| 413 <div> |
| 414 <dt> |
| 415 <var>interactive</var> |
| 416 <em> |
| 417 <!-- TYPE --> |
| 418 <div style="display:inline"> |
| 419 ( |
| 420 <span class="optional">optional</span> |
| 421 <span class="enum">enumerated</span> |
| 422 <span id="typeTemplate"> |
| 423 <span> |
| 424 <span>string</span> |
| 425 <span>["no", "yes", "if_needed"]</span> |
| 426 </span> |
| 427 </span> |
| 428 ) |
| 429 </div> |
| 430 </em> |
| 431 </dt> |
| 432 <dd>Whether to prompt the user for additional media galleries before r
eturning the permitted set. Default is silent.</dd> |
| 433 <!-- OBJECT PROPERTIES --> |
368 <!-- OBJECT METHODS --> | 434 <!-- OBJECT METHODS --> |
369 <!-- OBJECT EVENT FIELDS --> | 435 <!-- OBJECT EVENT FIELDS --> |
370 <!-- FUNCTION PARAMETERS --> | 436 <!-- FUNCTION PARAMETERS --> |
371 </div> | 437 </div> |
372 </div> | 438 </div> |
373 </dl> | 439 </dl> |
374 <!-- CALLBACK --> | 440 </dd> |
375 <!-- MIN_VERSION --> | 441 <!-- OBJECT METHODS --> |
376 </div> <!-- /description --> | 442 <!-- OBJECT EVENT FIELDS --> |
377 </div><div class="apiItem"> | 443 <!-- FUNCTION PARAMETERS --> |
378 <a name="method-getMediaFileSystems"></a> <!-- method-anchor --> | 444 </div> |
379 <h4>getMediaFileSystems</h4> | 445 </div><div> |
380 <div class="summary"> | |
381 <!-- Note: intentionally longer 80 columns --> | |
382 <span>chrome.experimental.mediaGalleries.getMediaFileSystems</
span>(<span class="null"><span>function</span> | |
383 <var><span>callback</span></var></span>)</div> | |
384 <div class="description"> | |
385 <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> | |
386 <!-- PARAMETERS --> | |
387 <h4>Parameters</h4> | |
388 <dl> | |
389 <div> | |
390 <div> | 446 <div> |
391 <dt> | 447 <dt> |
392 <var>callback</var> | 448 <var>MediaFileSystemsCallback</var> |
393 <em> | 449 <em> |
394 <!-- TYPE --> | 450 <!-- TYPE --> |
395 <div style="display:inline"> | 451 <div style="display:inline"> |
396 ( | 452 ( |
397 <span id="typeTemplate"> | 453 <span id="typeTemplate"> |
398 <span> | 454 <span> |
399 <span>function</span> | 455 <span>function</span> |
400 </span> | 456 </span> |
401 </span> | 457 </span> |
402 ) | 458 ) |
403 </div> | 459 </div> |
404 </em> | 460 </em> |
405 </dt> | 461 </dt> |
406 <dd class="todo"> | 462 <dd class="todo"> |
407 Undocumented. | 463 Undocumented. |
408 </dd> | 464 </dd> |
409 <!-- OBJECT PROPERTIES --> | 465 <!-- OBJECT PROPERTIES --> |
410 <!-- OBJECT METHODS --> | 466 <!-- OBJECT METHODS --> |
411 <!-- OBJECT EVENT FIELDS --> | 467 <!-- OBJECT EVENT FIELDS --> |
412 <!-- FUNCTION PARAMETERS --> | 468 <!-- FUNCTION PARAMETERS --> |
| 469 <dd> |
| 470 <div> |
| 471 <h5>Parameters</h5> |
| 472 <dl> |
| 473 <div> |
| 474 <div> |
| 475 <dt> |
| 476 <var>mediaFileSystems</var> |
| 477 <em> |
| 478 <!-- TYPE --> |
| 479 <div style="display:inline"> |
| 480 ( |
| 481 <span class="optional">optional</span> |
| 482 <span id="typeTemplate"> |
| 483 <span> |
| 484 <span> |
| 485 array of <span><span> |
| 486 <span> |
| 487 <span>LocalFileSystem</span> |
| 488 </span> |
| 489 </span></span> |
| 490 </span> |
| 491 </span> |
| 492 </span> |
| 493 ) |
| 494 </div> |
| 495 </em> |
| 496 </dt> |
| 497 <dd class="todo"> |
| 498 Undocumented. |
| 499 </dd> |
| 500 <!-- OBJECT PROPERTIES --> |
| 501 <!-- OBJECT METHODS --> |
| 502 <!-- OBJECT EVENT FIELDS --> |
| 503 <!-- FUNCTION PARAMETERS --> |
413 </div> | 504 </div> |
| 505 </div> |
| 506 </dl> |
| 507 </div> |
| 508 </dd> |
| 509 </div> |
414 </div> | 510 </div> |
415 </dl> | 511 </dl> |
416 <!-- RETURNS --> | 512 <!-- RETURNS --> |
417 <dl> | 513 <dl> |
418 </dl> | 514 </dl> |
419 <!-- CALLBACK --> | 515 <!-- CALLBACK --> |
420 <!-- MIN_VERSION --> | 516 <!-- MIN_VERSION --> |
421 </div> <!-- /description --> | 517 </div> <!-- /description --> |
422 </div><div class="apiItem"> | |
423 <a name="method-openMediaGalleryManager"></a> <!-- method-anchor -
-> | |
424 <h4>openMediaGalleryManager</h4> | |
425 <div class="summary"> | |
426 <!-- Note: intentionally longer 80 columns --> | |
427 <span>chrome.experimental.mediaGalleries.openMediaGalleryManag
er</span>()</div> | |
428 <div class="description"> | |
429 <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> | |
430 <!-- PARAMETERS --> | |
431 <dl> | |
432 </dl> | |
433 <!-- RETURNS --> | |
434 <dl> | |
435 </dl> | |
436 <!-- CALLBACK --> | |
437 <!-- MIN_VERSION --> | |
438 </div> <!-- /description --> | |
439 </div> <!-- /apiItem --> | 518 </div> <!-- /apiItem --> |
440 </div> <!-- /apiGroup --> | 519 </div> <!-- /apiGroup --> |
441 <!-- EVENTS --> | 520 <!-- EVENTS --> |
442 <!-- /apiGroup --> | 521 <!-- /apiGroup --> |
443 <!-- TYPES --> | 522 <!-- TYPES --> |
444 <!-- /apiGroup --> | 523 <!-- /apiGroup --> |
445 </div> <!-- /apiPage --> | 524 </div> <!-- /apiPage --> |
446 </div> <!-- /gc-pagecontent --> | 525 </div> <!-- /gc-pagecontent --> |
447 </div> <!-- /g-section --> | 526 </div> <!-- /g-section --> |
448 </div> <!-- /codesiteContent --> | 527 </div> <!-- /codesiteContent --> |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
482 _uff=0; | 561 _uff=0; |
483 urchinTracker(); | 562 urchinTracker(); |
484 } | 563 } |
485 catch(e) {/* urchinTracker not available. */} | 564 catch(e) {/* urchinTracker not available. */} |
486 </script> | 565 </script> |
487 <!-- end analytics --> | 566 <!-- end analytics --> |
488 </div> | 567 </div> |
489 </div> <!-- /gc-footer --> | 568 </div> <!-- /gc-footer --> |
490 </div> <!-- /gc-container --> | 569 </div> <!-- /gc-container --> |
491 </body></html> | 570 </body></html> |
OLD | NEW |