Initial extension bindings for Media Gallery API.

chrome/common/extensions/api/experimental.mediaGalleries.json

+[

[Aaron Boodman, 2012/03/29 05:28:30]

license header

[vandebo (ex-Chrome), 2012/03/29 18:45:02]

Done.

+  {
+    "namespace": "experimental.mediaGalleries",
+    "nodoc": true,

[Aaron Boodman, 2012/03/29 05:28:30]

Not necessary.

[vandebo (ex-Chrome), 2012/03/29 18:45:02]

Done.

+    "types": [
+      {
+        "id": "MediaGallery",
+        "type": "object",
+        "description": "A class representing a media gallery on the user's machines."

[Aaron Boodman, 2012/03/29 05:28:30]

You can say: isInstanceOf: "MediaGallery" to declare that the object returned is
of that DOM type.

[vandebo (ex-Chrome), 2012/03/29 18:45:02]

Not sure what you're getting at here.  Eventually I'll fill out all the types
here so that the extension documentation system will describe the entire API -
even those bits which we implement with custom IPCs and IDL.

[Aaron Boodman, 2012/03/30 22:14:57]

It doesn't seem like a great idea to me to duplicate all that information. I
think it is OK for the docs to simply refer to the webplatform-style
documentation elsewhere.

+      },
+      {
+        "id": "MediaFileMetadata",
+        "type": "object",
+        "description": "A class representing a metadata for a media file."
+      }
+    ],
+    "functions": [
+      {
+        "name": "getMediaGalleries",
+        "type": "function",
+        "description": "Get the media galleries configured in this user agent.",
+        "parameters": [
+          {
+            "type": "function",
+            "name": "callback",
+            "parameters": [
+              {
+                "name": "galleries",
+                "type": "array",
+                "items": { "$ref": "MediaGallery"}
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "name": "openMediaGalleryManager",
+        "type": "function",
+        "description": "Open the user agent’s UI to configure galleries. Calling openMediaGalleryManager will trigger a permission prompt for any origin that has not yet been granted permission.",

[Aaron Boodman, 2012/03/29 05:28:30]

Is this comment right? Extension and App APIs don't typically work this way
(with runtime prompting).

[vandebo (ex-Chrome), 2012/03/29 18:45:02]

No, I copy and pasted from my initial description of the API.  As an OWP
implementation there would be a permission prompt for this call, but not as an
extension.  Removed that part.

+        "parameters": []
+      },
+      {
+        "name": "assembleMediaFile",
+        "type": "function",
+        "description": "Create a new MediaFile setting the metadata in the Blob to the supplied values, overriding any existing metadata in the media file.  If user agent does not recognize the  Blob as a supported file format, it will return null in the callback.",
+        "parameters": [
+          {
+            "type": "object",
+            "optional": true,
+            "description": "A Blob - marked as optional object until bug 119372 is resolved.",

[Aaron Boodman, 2012/03/29 05:28:30]

These files support comments, so you can just have a regular TODO here.

[vandebo (ex-Chrome), 2012/03/29 18:45:02]

Done.

+            "name": "mediaFileContents"
+          },
+          {
+            "$ref": "MediaFileMetadata",
+            "name": "metadata"
+          },
+          {
+            "type": "function",
+            "name": "callback",
+            "parameters": [
+              {
+                "name": "mediaFile",
+                "choices": [
+                  { "type": "Blob" },
+                  { "type": "null" }
+                ]
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "name": "parseMediaFileMetadata",
+        "type": "function",
+        "description": "Parse the metadata in a given Blob. If the user agent does not recognize the Blob as a supported file format, it will return null in the callback.",
+        "parameters": [
+          {
+            "type": "object",
+            "optional": true,
+            "description": "A Blob - marked as optional object until bug 119372 is resolved.",
+            "name": "mediaFile"
+          },
+          {
+            "type": "function",
+            "name": "callback",
+            "parameters": [
+              {
+                "name": "metadata",
+                "choices": [
+                  {"$ref": "MediaFileMetadata"},
+                  { "type": "null" }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+]