pinray 0.1.1

Multi-platform screen capture library for Rust
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

# pinray

> Cross-platform screen and audio capture for Rust

[![Crates.io](https://img.shields.io/crates/v/pinray.svg)](https://crates.io/crates/pinray)
[![Documentation](https://docs.rs/pinray/badge.svg)](https://docs.rs/pinray)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

Raw screen and audio capture with a clean backend trait boundary. Capture first, encode separately.

- Native backends: Wayland (XDG Portal + PipeWire), macOS (ScreenCaptureKit), Windows (DXGI + WGC)
- Rich frame model with stride, pixel format, color space, timestamps
- Source enumeration before capture
- Restore tokens to skip permission dialogs

## Install

```console
cargo add pinray
```

## Example

```rust
use pinray::{SessionBuilder, PixelFormat, CursorMode};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let sources = pinray::enumerate_sources()?;

    let mut session = SessionBuilder::new()
        .video_target(sources.first().expect("no sources"))
        .pixel_format(PixelFormat::Bgra8888)
        .cursor_mode(CursorMode::Embedded)
        .build()?;

    session.start()?;

    loop {
        match session.next_event(None)? {
            pinray::CaptureEvent::Video(frame) => {
                println!("{}×{} stride={}", frame.width, frame.height, frame.stride);
            }
            pinray::CaptureEvent::End => break,
            _ => {}
        }
    }

    session.stop()?;
    Ok(())
}
```

## Platform Support

| Platform | Video | Audio |
|----------|-------|-------|
| Linux Wayland | Done | — |
| Linux X11 | planned | — |
| macOS | planned | planned |
| Windows | planned | planned |

## Requirements

**Linux:** Wayland session with XDG Desktop Portal, PipeWire, D-Bus

**macOS:** ScreenCaptureKit (macOS 12.3+)

**Windows:** Windows 10 1903+ for WGC

## License

Licensed under the [MIT License](LICENSE). For any inquiries, contact: rupamgolui@proton.me