chrome.wallpaper

説明

chrome.wallpaper API を使用して ChromeOS の壁紙を変更します。

権限

wallpaper

対象

Chrome 43 以降 ChromeOS のみ

マニフェスト

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

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

例

たとえば、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 以降

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

列挙型

"STRETCH"

"CENTER"

"CENTER_CROPPED"

メソッド

setWallpaper()

Promise 
chrome.wallpaper.setWallpaper(
  details: object,
  callback?: function,
): Promise<ArrayBuffer | undefined>

指定されたレイアウトで、url または wallpaperData の画像を壁紙に設定します。

パラメータ

  • 詳細

    オブジェクト

    • データ

      ArrayBuffer 省略可

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

    • filename

      文字列

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

    • レイアウト

      WallpaperLayout

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

    • サムネイル

      ブール値（省略可）

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

    • URL

      文字列 省略可

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

  • callback

    関数 省略可

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

    (thumbnail?: ArrayBuffer) => void

    • サムネイル

      ArrayBuffer 省略可

      JPEG エンコードされた壁紙のサムネイル。壁紙を 128x60 にリサイズして生成されます。

戻り値

  • Promise<ArrayBuffer | undefined>

    Chrome 96 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。