chrome.mediaGalleries

说明

使用 chrome.mediaGalleries API 从用户的本地磁盘访问媒体文件（音频、图片、视频）（需经用户同意）。

权限

mediaGalleries

类型

AddGalleryWatchResult

属性

  • galleryId

    string

  • 成功

    boolean

GalleryChangeDetails

属性

  • galleryId

    string

    标识修改后的图库。

  • 更改事件的类型。

GalleryChangeType

枚举

"contents_changed"
图库内容已更改。

"watch_dropped"
由于设备已分离、图库权限已被移除或任何其他原因，手表已被丢弃。

GetMediaFileSystemsInteractivity

枚举

"no"
请勿进行互动。

"yes"
让用户管理允许的媒体库。

"if_needed"
只有在返回集为空时，才要求用户管理允许的图库。

GetMetadataType

枚举

"all"
检索 MIME 类型、元数据标记和附加的图片。

"mimeTypeAndTags"
仅检索 MIME 类型和元数据标记。

"mimeTypeOnly"
仅检索 MIME 类型。

MediaFileSystemMetadata

属性

  • deviceId

    字符串（可选）

    如果媒体库在可移动设备上，则为设备在线时的设备的唯一 ID。

  • galleryId

    string

    媒体库的唯一永久 ID。

  • isAvailable

    boolean

    如果设备目前可用，则为“true”。

  • isMediaDevice

    boolean

    如果媒体库所在的设备被检测为媒体设备（即 PTP 或 MTP 设备或存在 DCIM 目录），则为 true。

  • isRemovable

    boolean

    如果媒体库在可移动设备上，则为 true。

  • name

    string

    文件系统的名称。

MediaFileSystemsDetails

属性

  • interactive

    GetMediaFileSystemsInteractivity 可选

    是否在返回允许的集合之前提示用户授予访问其他媒体库的权限。默认为静音。如果传递了值“yes”，或者未授予应用访问任何媒体库的权限，但传递了值“if_needed”，则会显示媒体库配置对话框。

MediaMetadata

属性

  • album

    字符串（可选）

    针对音频和视频定义。

  • 艺术家

    字符串（可选）

  • attachedImages

    Blob[]

    嵌入在媒体文件元数据中的图片。这最常用于专辑封面或视频缩略图。

  • 条评论

    字符串（可选）

  • 版权

    字符串（可选）

  • disc

    数字可选

  • 时长

    数字可选

    针对音频和视频定义。以秒为单位。

  • 流派

    字符串（可选）

  • 高度

    数字可选

    针对视频而定义。以像素为单位。

  • language

    字符串（可选）

  • mimeType

    string

    浏览器检测到了 MIME 类型。

  • rawTags

    StreamInfo[]

    媒体文件中的所有元数据。对于具有多个视频流的格式，将保留视频流顺序。容器元数据是第一个元素。

  • 旋转

    数字可选

    针对视频而定义。以度为单位。

  • title

    字符串（可选）

  • 轨道

    数字可选

  • 宽度

    数字可选

MediaMetadataOptions

属性

  • metadataType

    GetMetadataType 可选

    指定要检索的元数据的哪个子集。如果省略此选项，则默认为“all”。

StreamInfo

属性

  • tags

    对象

    数据流标记的未过滤字符串->字符串字典。

  • 类型

    string

    说明视频流的容器或编解码器的格式，即“mp3”“h264”。

方法

addGalleryWatch()

Promise 
chrome.mediaGalleries.addGalleryWatch(
  galleryId: string,
  callback?: function,
)

为具有指定图库 ID 的图库添加图库监控。然后，系统将触发指定的回调函数，并显示成功或失败结果。

参数

返回

  • Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

addUserSelectedFolder()

chrome.mediaGalleries.addUserSelectedFolder(
  callback: function,
)

向用户显示目录选择器，并将所选目录添加为图库。如果用户取消选择器，selectedFileSystemName 将为空。对话框需要使用用户手势才会显示。如果没有用户手势，回调将像用户已取消一样运行。

参数

  • callback

    功能

    callback 参数如下所示：

    (mediaFileSystems: DOMFileSystem[],selectedFileSystemName: string)=>void

    • mediaFileSystems

      DOMFileSystem[]

    • selectedFileSystemName

      string

getMediaFileSystemMetadata()

chrome.mediaGalleries.getMediaFileSystemMetadata(
  mediaFileSystem: DOMFileSystem,
)

获取特定媒体文件系统的相关元数据。

参数

  • mediaFileSystem

    DOMFileSystem

返回

getMediaFileSystems()

Promise 
chrome.mediaGalleries.getMediaFileSystems(
  details?: MediaFileSystemsDetails,
  callback?: function,
)

获取在此用户代理中配置的媒体库。如果没有配置或不可用，回调将收到一个空数组。

参数

  • 明细

    MediaFileSystemsDetails 可选

  • callback

    函数（可选）

    callback 参数如下所示：

    (mediaFileSystems: DOMFileSystem[])=>void

    • mediaFileSystems

      DOMFileSystem[]

返回

  • Promise<DOMFileSystem[]>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getMetadata()

Promise 
chrome.mediaGalleries.getMetadata(
  mediaFile: Blob,
  options?: MediaMetadataOptions,
  callback?: function,
)

获取媒体文件的媒体特定元数据。这应该适用于媒体库以及其他 DOM 文件系统中的文件。

参数

返回

  • Promise<MediaMetadata>

    Chrome 116 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

removeGalleryWatch()

chrome.mediaGalleries.removeGalleryWatch(
  galleryId: string,
)

移除具有指定图库 ID 的图库手表。

参数

  • galleryId

    string

活动

onGalleryChanged

chrome.mediaGalleries.onGalleryChanged.addListener(
  callback: function,
)

在更改媒体库或丢失图库手表时触发。

参数