WallpaperApi class

Constructors

WallpaperApi({BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})

Constructor for WallpaperApi. The binaryMessenger named argument is available for dependency injection. If it is left null, the default BinaryMessenger will be used which routes to the host platform.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

pigeonVar_binaryMessenger → BinaryMessenger?

final

pigeonVar_messageChannelSuffix → String

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

applyOpenGlWallpaper(OpenGlWallpaperRequestData request) → Future<OperationResultData>

Applies a shader-based OpenGL live wallpaper.

applyWallpaper(StaticWallpaperRequestData request) → Future<OperationResultData>

Applies a static wallpaper using the structured 3.2 transport contract.

checkMaterialYouSupport() → Future<MaterialYouSupportData>

downloadWallpaper(String url) → Future<bool>

getCapabilities() → Future<WallpaperCapabilitiesData>

Returns the platform's structured wallpaper capabilities.

getPlatformVersion() → Future<String>

getWallpaperRotationStatus() → Future<WallpaperRotationStatusData>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

openLiveWallpaperPreview(VideoWallpaperRequestData request) → Future<OperationResultData>

Opens the live-wallpaper UI and reports that distinct outcome.

openWallpaperChooser() → Future<bool>

prepareVideoWallpaper(VideoWallpaperRequestData request) → Future<OperationResultData>

Prepares a video live wallpaper without claiming that it was applied.

rotateWallpaperNow() → Future<bool>

setBothWallpaperFromFile(String filePath, bool goToHome) → Future<bool>

setBothWallpaperFromUrl(String url, bool goToHome) → Future<bool>

setHomeWallpaperFromFile(String filePath, bool goToHome) → Future<bool>

setHomeWallpaperFromUrl(String url, bool goToHome) → Future<bool>

Legacy 3.1 endpoints remain until their facade adapters migrate in Task 5.

setLiveWallpaper(String filePath, bool goToHome) → Future<bool>

setLockWallpaperFromFile(String filePath, bool goToHome) → Future<bool>

setLockWallpaperFromUrl(String url, bool goToHome) → Future<bool>

setMaterialYouWallpaper(String url, bool goToHome, bool enableEffects) → Future<bool>

setWallpaper(String url, bool goToHome) → Future<bool>

setWallpaperFromFile(String filePath, bool goToHome) → Future<bool>

startWallpaperRotation(WallpaperRotationConfigData config) → Future<bool>

stopWallpaperRotation() → Future<bool>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

pigeonChannelCodec → const MessageCodec<Object?>