chrome.wallpaper

説明

ChromeOS の壁紙を変更するには、chrome.wallpaper API を使用します。

権限

wallpaper

壁紙 API を使用するには、アプリのマニフェストで「壁紙」権限を宣言する必要があります。次に例を示します。

{
  "name": "My extension",
  ...
  "permissions": [
    "wallpaper"
  ],
  ...
}

対象

Chrome 43 以降 ChromeOS のみ

例

たとえば、https://example.com/a_file.png の画像として壁紙を設定するには、chrome.wallpaper.setWallpaper を次のように呼び出します。

chrome.wallpaper.setWallpaper(
  {
    'url': 'https://example.com/a_file.jpg',
    'layout': 'CENTER_CROPPED',
    'filename': 'test_wallpaper'
  },
  function() {}
);

型

WallpaperLayout

Chrome 44 以降

サポートされている壁紙レイアウト。

Enum

"CENTER"

Methods

setWallpaper()

Promise 
chrome.wallpaper.setWallpaper(
  details: object,
  callback?: function,
)

指定された layout で、url または wallpaperData の画像に壁紙を設定します。

パラメータ

  • 詳細

    オブジェクト

    • data

      ArrayBuffer 省略可

      ArrayBuffer として jpeg または png でエンコードされた壁紙画像。

    • filename

      文字列

      保存した壁紙のファイル名。

    • サポートされている壁紙レイアウト。

    • サムネイル

      ブール値（省略可）

      128x60 のサムネイルを生成する必要がある場合は true に設定します。レイアウトと比率はまだサポートされていません。

    • URL

      string（省略可）

      設定する壁紙の URL（相対 URL でも可）。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (thumbnail?: ArrayBuffer)=>void

    • サムネイル

      ArrayBuffer 省略可

      JPEG エンコードの壁紙サムネイル。壁紙を 128x60 にサイズ変更することで生成されます。

戻り値

  • Promise<ArrayBuffer|未定義>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。