壁紙

導入模塊

import wallpaper from '@ohos.wallpaper';

WallpaperType7+

定義壁紙的枚舉類型。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

RgbaColor(deprecated)

定義壁紙顏色信息結構。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

wallpaper.on('colorChange')(deprecated)

on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void

訂閱壁紙顏色變化結果上報事件。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

try {
    let listener = (colors, wallpaperType) => {
        console.log(`wallpaper color changed.`);
    };
    wallpaper.on('colorChange', listener);
} catch (error) {
    console.error(`failed to on because: ${JSON.stringify(error)}`);
}

wallpaper.off('colorChange')(deprecated)

off(type: 'colorChange', callback?: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void

取消訂閱壁紙顏色變化結果上報事件。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

let listener = (colors, wallpaperType) => {
    console.log(`wallpaper color changed.`);
};
try {
    wallpaper.on('colorChange', listener);
} catch (error) {
    console.error(`failed to on because: ${JSON.stringify(error)}`);
}

try {
    // 取消訂閱listener
    wallpaper.off('colorChange', listener);
} catch (error) {
    console.error(`failed to off because: ${JSON.stringify(error)}`);
}

try {
    // 取消所有'colorChange'類型的訂閱
    wallpaper.off('colorChange');
} catch (error) {
    console.error(`failed to off because: ${JSON.stringify(error)}`);
}

wallpaper.getColors(deprecated)

getColors(wallpaperType: WallpaperType, callback: AsyncCallback<Array<RgbaColor>>): void

獲取指定類型壁紙的主要顏色信息。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

wallpaper.getColors(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
    if (error) {
        console.error(`failed to getColors because: ${JSON.stringify(error)}`);
        return;
    }
    console.log(`success to getColors: ${JSON.stringify(data)}`);
});

wallpaper.getColors(deprecated)

getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>>

獲取指定類型壁紙的主要顏色信息。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

返回值：

示例：

wallpaper.getColors(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
    console.log(`success to getColors: ${JSON.stringify(data)}`);
  }).catch((error) => {
    console.error(`failed to getColors because: ${JSON.stringify(error)}`);
});

wallpaper.getId(deprecated)

getId(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void

獲取指定類型壁紙的ID。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

wallpaper.getId(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
    if (error) {
        console.error(`failed to getId because: ${JSON.stringify(error)}`);
        return;
    }
    console.log(`success to getId: ${JSON.stringify(data)}`);
});

wallpaper.getId(deprecated)

getId(wallpaperType: WallpaperType): Promise<number>

獲取指定類型壁紙的ID。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

返回值：

示例：

wallpaper.getId(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
    console.log(`success to getId: ${JSON.stringify(data)}`);
  }).catch((error) => {
    console.error(`failed to getId because: ${JSON.stringify(error)}`);
});

wallpaper.getMinHeight(deprecated)

getMinHeight(callback: AsyncCallback<number>): void

獲取壁紙的最小高度值。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

wallpaper.getMinHeight((error, data) => {
    if (error) {
        console.error(`failed to getMinHeight because: ${JSON.stringify(error)}`);
        return;
    }
    console.log(`success to getMinHeight: ${JSON.stringify(data)}`);
});

wallpaper.getMinHeight(deprecated)

getMinHeight(): Promise<number>

獲取壁紙的最小高度值。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

返回值：

示例：

wallpaper.getMinHeight().then((data) => {
    console.log(`success to getMinHeight: ${JSON.stringify(data)}`);
}).catch((error) => {
    console.error(`failed to getMinHeight because: ${JSON.stringify(error)}`);
});

wallpaper.getMinWidth(deprecated)

getMinWidth(callback: AsyncCallback<number>): void

獲取壁紙的最小寬度值。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

wallpaper.getMinWidth((error, data) => {
    if (error) {
        console.error(`failed to getMinWidth because: ${JSON.stringify(error)}`);
        return;
    }
    console.log(`success to getMinWidth: ${JSON.stringify(data)}`);
});

wallpaper.getMinWidth(deprecated)

getMinWidth(): Promise<number>

獲取壁紙的最小寬度值。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

返回值：

示例：

wallpaper.getMinWidth().then((data) => {
    console.log(`success to getMinWidth: ${JSON.stringify(data)}`);
  }).catch((error) => {
    console.error(`failed to getMinWidth because: ${JSON.stringify(error)}`);
});

wallpaper.isChangePermitted(deprecated)

isChangePermitted(callback: AsyncCallback<boolean>): void

是否允許應用改變當前用戶的壁紙。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

wallpaper.isChangePermitted((error, data) => {
    if (error) {
        console.error(`failed to isChangePermitted because: ${JSON.stringify(error)}`);
        return;
    }
    console.log(`success to isChangePermitted: ${JSON.stringify(data)}`);
});

wallpaper.isChangePermitted(deprecated)

isChangePermitted(): Promise<boolean>

是否允許應用改變當前用戶的壁紙。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

返回值：

示例：

wallpaper.isChangePermitted().then((data) => {
    console.log(`success to isChangePermitted: ${JSON.stringify(data)}`);
}).catch((error) => {
    console.error(`failed to isChangePermitted because: ${JSON.stringify(error)}`);
});

wallpaper.isOperationAllowed(deprecated)

isOperationAllowed(callback: AsyncCallback<boolean>): void

是否允許用戶設置壁紙。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

wallpaper.isOperationAllowed((error, data) => {
    if (error) {
        console.error(`failed to isOperationAllowed because: ${JSON.stringify(error)}`);
        return;
    }
    console.log(`success to isOperationAllowed: ${JSON.stringify(data)}`);
});

wallpaper.isOperationAllowed(deprecated)

isOperationAllowed(): Promise<boolean>

是否允許用戶設置壁紙。

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

返回值：

示例：

wallpaper.isOperationAllowed().then((data) => {
    console.log(`success to isOperationAllowed: ${JSON.stringify(data)}`);
  }).catch((error) => {
    console.error(`failed to isOperationAllowed because: ${JSON.stringify(error)}`);
});

wallpaper.reset(deprecated)

reset(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void

移除指定類型的壁紙，恢復為默認顯示的壁紙。

需要權限：ohos.permission.SET_WALLPAPER

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

wallpaper.reset(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error) => {
    if (error) {
        console.error(`failed to reset because: ${JSON.stringify(error)}`);
        return;
    }
    console.log(`success to reset.`);
});

wallpaper.reset(deprecated)

reset(wallpaperType: WallpaperType): Promise<void>

移除指定類型的壁紙，恢復為默認顯示的壁紙。

需要權限：ohos.permission.SET_WALLPAPER

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

返回值：

示例：

wallpaper.reset(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then(() => {
    console.log(`success to reset.`);
}).catch((error) => {
    console.error(`failed to reset because: ${JSON.stringify(error)}`);
});

wallpaper.setWallpaper(deprecated)

setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType, callback: AsyncCallback<void>): void

將指定資源設置為指定類型的壁紙。

需要權限：ohos.permission.SET_WALLPAPER

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

// source類型為string
let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg";
wallpaper.setWallpaper(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error) => {
    if (error) {
        console.error(`failed to setWallpaper because: ${JSON.stringify(error)}`);
       return;
       }
    console.log(`success to setWallpaper.`);
});

// source類型為image.PixelMap
import image from '@ohos.multimedia.image';
let imageSource = image.createImageSource("file://" + wallpaperPath);
let opts = {
    "desiredSize": {
        "height": 3648,
        "width": 2736
    }
};
imageSource.createPixelMap(opts).then((pixelMap) => {
    wallpaper.setWallpaper(pixelMap, wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error) => {
        if (error) {
            console.error(`failed to setWallpaper because: ${JSON.stringify(error)}`);
            return;
        }
        console.log(`success to setWallpaper.`);
    });
}).catch((error) => {
    console.error(`failed to createPixelMap because: ${JSON.stringify(error)}`);
});

wallpaper.setWallpaper(deprecated)

setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Promise<void>

將指定資源設置為指定類型的壁紙。

需要權限：ohos.permission.SET_WALLPAPER

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

返回值：

示例：

// source類型為string
let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg";
wallpaper.setWallpaper(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM).then(() => {
    console.log(`success to setWallpaper.`);
  }).catch((error) => {
    console.error(`failed to setWallpaper because: ${JSON.stringify(error)}`);
});
  
// source類型為image.PixelMap
import image from '@ohos.multimedia.image';
let imageSource = image.createImageSource("file://" + wallpaperPath);
let opts = {
    "desiredSize": {
        "height": 3648,
        "width": 2736
    }
};
imageSource.createPixelMap(opts).then((pixelMap) => {
    wallpaper.setWallpaper(pixelMap, wallpaper.WallpaperType.WALLPAPER_SYSTEM).then(() => {
        console.log(`success to setWallpaper.`);
    }).catch((error) => {
        console.error(`failed to setWallpaper because: ${JSON.stringify(error)}`);
    });
  }).catch((error) => {
    console.error(`failed to createPixelMap because: ${JSON.stringify(error)}`);
});

wallpaper.getFile(deprecated)

getFile(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void

獲取指定類型的壁紙文件。

需要權限：ohos.permission.GET_WALLPAPER

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

示例：

wallpaper.getFile(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
    if (error) {
        console.error(`failed to getFile because: ${JSON.stringify(error)}`);
        return;
    }
    console.log(`success to getFile: ${JSON.stringify(data)}`);
});

wallpaper.getFile(deprecated)

getFile(wallpaperType: WallpaperType): Promise<number>

獲取指定類型的壁紙文件。

需要權限：ohos.permission.GET_WALLPAPER

系統(tǒng)能力: SystemCapability.MiscServices.Wallpaper

參數(shù)：

返回值：

示例：

wallpaper.getFile(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
    console.log(`success to getFile: ${JSON.stringify(data)}`);
  }).catch((error) => {
    console.error(`failed to getFile because: ${JSON.stringify(error)}`);
});