Protocol

set

Transition the desktop to a new wallpaper.

CALLcrownpaper.set
Rust
let pending = client.set(path, 0.8)?;
client.wait(pending, Some(Duration::from_secs(5)))?;
CLI output
wallpaper set to /home/you/Pictures/dunes.webp

Replies as soon as the image is known to be decodable and the transition is queued — not when it finishes. The wallpaper that actually lands arrives as a Changed event.

Parameters

pathStringrequired

Absolute path to a still image or video. The daemon may run in a different working directory, so resolve relative paths before sending them.

durationf32required

Transition length in seconds. 0 swaps the wallpaper without a transition.

Reply

()unit

Empty reply once the transition is queued. An undecodable file returns an error instead.