Upstream version 9.38.198.0

[platform/framework/web/crosswalk.git] / src / chrome / common / extensions / api / media_galleries.idl

diff --git a/src/chrome/common/extensions/api/media_galleries.idl b/src/chrome/common/extensions/api/media_galleries.idl
index 1916ed3..02d21d1 100644 (file)
--- a/src/chrome/common/extensions/api/media_galleries.idl
+++ b/src/chrome/common/extensions/api/media_galleries.idl
@@ -6,6 +6,14 @@
 // images, video) from the user's local disks (with the user's consent).
 namespace mediaGalleries {
 
+  [inline_doc] enum GalleryChangeType {
+    // The contents of the gallery have changed.
+    contents_changed,
+    // The watch has been dropped because the device has been detached,
+    // the gallery permission has been removed, or any other reason.
+    watch_dropped
+  };
+
   [inline_doc] enum GetMediaFileSystemsInteractivity {
     // Do not act interactively.
     no,
@@ -17,8 +25,10 @@ namespace mediaGalleries {
   };
 
   [inline_doc] enum GetMetadataType {
-    // Retrieve all available metadata.
+    // Retrieve the mime type, metadata tags, and attached images.
     all,
+    // Retrieve only the mime type and the metadata tags.
+    mimeTypeAndTags,
     // Retrieve only the mime type.
     mimeTypeOnly
   };
@@ -34,6 +44,14 @@ namespace mediaGalleries {
     // The scan encountered an error and could not proceed.
     error
   };
+  
+  [inline_doc] dictionary GalleryChangeDetails {
+    // Type of change event.
+    GalleryChangeType type;
+    
+    // Identifies the modified gallery.
+    DOMString galleryId;
+  };
 
   [inline_doc] dictionary MediaFileSystemsDetails {
     // Whether to prompt the user for permission to additional media galleries
@@ -51,12 +69,14 @@ namespace mediaGalleries {
   };
 
   callback MediaFileSystemsCallback =
-      void ([instanceOf=DOMFileSystem] optional object[] mediaFileSystems);
+      void ([instanceOf=DOMFileSystem] object[] mediaFileSystems);
 
   callback AddUserFolderCallback =
       void ([instanceOf=DOMFileSystem] object[] mediaFileSystems,
             DOMString selectedFileSystemName);
 
+  callback DropPermissionForMediaFileSystemCallback = void ();
+
   [inline_doc] dictionary MediaFileSystemMetadata {
     // The name of the file system.
     DOMString name;
@@ -96,6 +116,14 @@ namespace mediaGalleries {
   callback MediaFileSystemsMetadataCallback =
       void (MediaFileSystemMetadata[] metadata);
 
+  dictionary StreamInfo {
+    // Describes format of container or codec of stream, i.e. "mp3", "h264".
+    DOMString type;
+    
+    // An unfiltered string->string dictionary of tags for the stream.
+    object tags;
+  };
+
   dictionary MediaMetadata {
     // The browser sniffed mime type.
     DOMString mimeType;
@@ -104,13 +132,26 @@ namespace mediaGalleries {
     long? height;
     long? width;
 
+    // Defined for images only.
+    double? xResolution;
+    double? yResolution;
+
     // Defined for audio and video. In seconds.
     double? duration;
     
     // Defined for images and video. In degrees.
     long? rotation;
 
-    // Generic metadata tags.
+    // Defined for images only.
+    DOMString? cameraMake;
+    DOMString? cameraModel;
+    double? exposureTimeSeconds;
+    boolean? flashFired;
+    double? fNumber;
+    double? focalLengthMm;
+    double? isoEquivalent;
+
+    // Defined for audio and video only.
     DOMString? album;
     DOMString? artist;
     DOMString? comment;
@@ -120,6 +161,14 @@ namespace mediaGalleries {
     DOMString? language;
     DOMString? title;
     long? track;
+
+    // All the metadata in the media file. For formats with multiple streams,
+    // stream order will be preserved. Container metadata is the first element.
+    StreamInfo[] rawTags;
+
+    // The images embedded in the media file's metadata. This is most often
+    // used for album art or video thumbnails.
+    [instanceOf=Blob] object[] attachedImages;
   };
 
   callback MediaMetadataCallback = void (MediaMetadata metadata);
@@ -137,6 +186,11 @@ namespace mediaGalleries {
     // gesture, the callback will run as though the user canceled.
     static void addUserSelectedFolder(AddUserFolderCallback callback);
 
+    // Give up access to a given media gallery.
+    static void dropPermissionForMediaFileSystem(
+        DOMString galleryId,
+        optional DropPermissionForMediaFileSystemCallback callback);
+
     // Start a scan of the user's hard disks for directories containing media.
     // The scan may take a long time so progress and completion is communicated
     // by events. No permission is granted as a result of the scan, see
@@ -149,7 +203,7 @@ namespace mediaGalleries {
 
     // Show the user the scan results and let them add any or all of them as
     // galleries. This should be used after the 'finish' onScanProgress()
-    // event has happened. A galleries the app has access to are returned, not
+    // event has happened. All galleries the app has access to are returned, not
     // just the newly added galleries.
     static void addScanResults(MediaFileSystemsCallback callback);
 
@@ -169,6 +223,9 @@ namespace mediaGalleries {
   };
 
   interface Events {
+    // Fired when a media gallery is changed or a gallery watch is dropped.
+    static void onGalleryChanged(GalleryChangeDetails details);
+
     // The pending media scan has changed state. See details for more
     // information.
     static void onScanProgress(ScanProgressDetails details);