clipboard.setImageData()

将图像复制到剪贴板。图像在写入剪贴板之前会重新编码。如果图像无效，剪贴板将不会被修改。

图像以包含编码图像的 ArrayBuffer 的形式提供。支持 JPEG 和 PNG 格式。

虽然此 API 基于 Chrome 的 clipboard.setImageData() API，但存在一些差异

  • Chrome API 仅适用于应用程序，不适用于扩展。
  • 此 API 仅需要 "clipboardWrite" 权限，而 Chrome 版本还需要 "clipboard" 权限。
  • Chrome 的 API 使用回调，而此 API 仅支持 Promise。
  • 此 API 不支持 additionalItems 参数。

这是一个异步函数，它返回一个 Promise。

语法

js
browser.clipboard.setImageData(imageData, imageType)

参数

imageData

包含要复制到剪贴板的编码图像数据的 ArrayBuffer。

imageType

指示 imageData 中包含的图像类型的字符串："png" 或 "jpeg"。

返回值

一个 Promise，如果操作成功，则将使用无参数解析，如果出现错误（例如，因为数据不代表有效的图像），则将拒绝。

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

示例

复制远程图像

js
// requires:
// * the host permission for "https://cdn.mdn.mozilla.net/*"
// * the API permission "clipboardWrite"

fetch("https://cdn.mdn.mozilla.net/static/img/favicon144.png")
  .then((response) => response.arrayBuffer())
  .then((buffer) => browser.clipboard.setImageData(buffer, "png"));

复制与扩展捆绑在一起的图像

js
// requires the API permission "clipboardWrite"

fetch(browser.runtime.getURL("image.png"))
  .then((response) => response.arrayBuffer())
  .then((buffer) => browser.clipboard.setImageData(buffer, "png"));

注意：此 API 基于 Chromium 的 chrome.clipboard API。