tauri-plugin-screenshots 2.0.0

Get screenshots of windows and monitors.
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# tauri-plugin-screenshots

> This plugin only works on tauri v2, if you need the v1 plugin, feel free to submit a PR!

Get screenshots of windows and monitors.

## Install

```shell
cargo add tauri-plugin-screenshots
```

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

```shell
pnpm add tauri-plugin-screenshots-api
```

## Usage

`src-tauri/src/lib.rs`

```diff
pub fn run() {
    tauri::Builder::default()
+       .plugin(tauri_plugin_screenshots::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}
```

`src-tauri/capabilities/default.json`

```diff
{
    ...
    "permissions": [
        ...
+       "screenshots:default"
    ]
}
```

Afterwards all the plugin's APIs are available through the JavaScript guest bindings:

```ts
import { getScreenshotableWindows } from "tauri-plugin-screenshots-api";

const windows = await getScreenshotableWindows();
console.log(windows);
```

## Methods

| Method                      | Description                                             |
| --------------------------- | ------------------------------------------------------- |
| `getScreenshotableWindows`  | Get all windows that can take screenshots.              |
| `getScreenshotableMonitors` | Get all monitors that can take screenshots.             |
| `getWindowScreenshot`       | Get a screenshot of the window with the specified id.   |
| `getMonitorScreenshot`      | Get a screenshot of the monitors with the specified id. |

## Example

```shell
git clone https://github.com/ayangweb/tauri-plugin-screenshots.git
```

```shell
pnpm install

pnpm build

cd examples/tauri-app

pnpm install

pnpm tauri dev
```

## Thanks

- Use [xcap](https://github.com/nashaofu/xcap) to get window and monitor screenshots.