wayle-wallpaper 0.1.3

Wallpaper management with cycling and color extraction
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# Wallpaper D-Bus Interface

Control wallpapers, cycling, and theming.

- **Service:** `com.wayle.Wallpaper1`
- **Path:** `/com/wayle/Wallpaper`

## Monitor Targeting

Methods accepting `monitor`:

- **Empty string `""`** - Targets all monitors
- **Monitor name** - Targets a specific monitor (e.g., "DP-1", "HDMI-A-1")

## Methods

### Wallpaper Control

| Method                | Arguments           | Returns | Description                      |
| --------------------- | ------------------- | ------- | -------------------------------- |
| `SetWallpaper`        | `s path, s monitor` | -       | Set wallpaper from file path     |
| `SetFitMode`          | `s mode`            | -       | Set scaling mode                 |
| `WallpaperForMonitor` | `s monitor`         | `s`     | Get wallpaper path for a monitor |
| `GetFitMode`          | -                   | `s`     | Get current fit mode             |

Fit modes: `fill`, `fit`, `stretch`, `center`, `tile`

### Cycling Control

| Method         | Arguments                              | Returns | Description                |
| -------------- | -------------------------------------- | ------- | -------------------------- |
| `StartCycling` | `s directory, u interval_secs, s mode` | -       | Start cycling wallpapers   |
| `StopCycling`  | -                                      | -       | Stop wallpaper cycling     |
| `Next`         | -                                      | -       | Advance to next wallpaper  |
| `Previous`     | -                                      | -       | Go back to previous        |
| `GetIsCycling` | -                                      | `b`     | Check if cycling is active |

Cycling modes: `sequential`, `random`

### Theming

| Method              | Arguments   | Returns | Description                           |
| ------------------- | ----------- | ------- | ------------------------------------- |
| `ExtractColors`     | -           | -       | Extract colors from current wallpaper |
| `SetThemingMonitor` | `s monitor` | -       | Set monitor for color extraction      |

### Monitor Management

| Method              | Arguments   | Returns | Description              |
| ------------------- | ----------- | ------- | ------------------------ |
| `ListMonitors`      | -           | `as`    | List registered monitors |
| `RegisterMonitor`   | `s monitor` | -       | Register a monitor       |
| `UnregisterMonitor` | `s monitor` | -       | Unregister a monitor     |

## Properties

| Property         | Type | Access | Description                       |
| ---------------- | ---- | ------ | --------------------------------- |
| `FitMode`        | `s`  | read   | Current wallpaper scaling mode    |
| `IsCycling`      | `b`  | read   | Whether cycling is active         |
| `ThemingMonitor` | `s`  | read   | Monitor used for color extraction |