// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Use the <code>chrome.mediaGalleries</code> API to access media files (audio,
// 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,
// Ask the user to manage permitted media galleries.
yes,
// Ask the user to manage permitted galleries only if the return set would
// otherwise be empty.
if_needed
};
[inline_doc] enum GetMetadataType {
// 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
};
[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
// 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.
GetMediaFileSystemsInteractivity? interactive;
};
[inline_doc] dictionary MediaMetadataOptions {
// Specifies which subset of the metadata to retrieve. Defaults to 'all'
// if the option is omitted.
GetMetadataType? metadataType;
};
callback MediaFileSystemsCallback =
void ([instanceOf=DOMFileSystem] object[] mediaFileSystems);
callback AddUserFolderCallback =
void ([instanceOf=DOMFileSystem] object[] mediaFileSystems,
DOMString selectedFileSystemName);
[inline_doc] dictionary MediaFileSystemMetadata {
// The name of the file system.
DOMString name;
// A unique and persistent id for the media gallery.
DOMString galleryId;
// If the media gallery is on a removable device, a unique id for the
// device while the device is online.
DOMString? deviceId;
// True if the media gallery is on a removable device.
boolean isRemovable;
// True if the device the media gallery is on was detected as a media
// device. i.e. a PTP or MTP device, or a DCIM directory is present.
boolean isMediaDevice;
// True if the device is currently available.
boolean isAvailable;
};
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;
// Defined for video. In pixels.
long? height;
long? width;
// Defined for audio and video. In seconds.
double? duration;
// Defined for video. In degrees.
long? rotation;
// Defined for audio and video.
DOMString? album;
DOMString? artist;
DOMString? comment;
DOMString? copyright;
long? disc;
DOMString? genre;
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);
// A dictionary that describes the add gallery watch request results.
dictionary AddGalleryWatchResult {
DOMString galleryId;
boolean success;
};
callback AddGalleryWatchCallback = void (AddGalleryWatchResult result);
interface Functions {
// Get the media galleries configured in this user agent. If none are
// configured or available, the callback will receive an empty array.
static void getMediaFileSystems(
optional MediaFileSystemsDetails details,
MediaFileSystemsCallback callback);
// Present a directory picker to the user and add the selected directory
// as a gallery. If the user cancels the picker, selectedFileSystemName
// will be empty.
// A user gesture is required for the dialog to display. Without a user
// gesture, the callback will run as though the user canceled.
[doesNotSupportPromises="Multi-parameter callback crbug.com/1313625"]
static void addUserSelectedFolder(AddUserFolderCallback callback);
// Get metadata about a specific media file system.
[nocompile] static MediaFileSystemMetadata getMediaFileSystemMetadata(
[instanceOf=DOMFileSystem] object mediaFileSystem);
// Gets the media-specific metadata for a media file. This should work
// for files in media galleries as well as other DOM filesystems.
static void getMetadata(
[instanceOf=Blob] object mediaFile,
optional MediaMetadataOptions options,
MediaMetadataCallback callback);
// Adds a gallery watch for the gallery with the specified gallery ID.
// The given callback is then fired with a success or failure result.
static void addGalleryWatch(
DOMString galleryId,
AddGalleryWatchCallback callback);
// Removes a gallery watch for the gallery with the specified gallery ID.
static void removeGalleryWatch(DOMString galleryId);
};
interface Events {
// Fired when a media gallery is changed or a gallery watch is dropped.
static void onGalleryChanged(GalleryChangeDetails details);
};
};
Codebase Browser
chromium