pinray-core 0.2.0

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

/// Opaque identifier for a capturable source.
///
/// Formats are platform-specific (e.g. `display:\\.\DISPLAY1`,
/// `window:1234`, `audio:system-mix`); treat them as opaque strings from
/// [`CaptureSource`] enumeration. The special value `"auto"` selects the
/// primary display without enumerating. Window ids are only valid while the
/// window exists — re-enumerate before building a session.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct SourceId(pub String);

impl SourceId {
    pub fn new(value: impl Into<String>) -> Self {
        Self(value.into())
    }
}

/// A capturable display/monitor.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DisplaySource {
    pub id: SourceId,
    pub name: String,
    pub width: u32,
    pub height: u32,
    /// Display scale × 1000 (e.g. 2000 = 2× HiDPI). Best-effort; 1000 where
    /// the platform has no reliable per-monitor scale.
    pub scale_factor_milli: u32,
    pub is_primary: bool,
}

/// A capturable application window.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WindowSource {
    pub id: SourceId,
    pub title: String,
    /// Owning application, when the platform exposes it.
    pub app_name: Option<String>,
}

/// A capturable audio endpoint.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AudioDeviceSource {
    pub id: SourceId,
    pub name: String,
    pub is_default: bool,
}

/// Anything [`enumerate_sources`](crate::CaptureSession) can return.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CaptureSource {
    Display(DisplaySource),
    Window(WindowSource),
    SystemAudio(AudioDeviceSource),
    Microphone(AudioDeviceSource),
}