screencapturekit 1.5.4

Safe Rust bindings for Apple's ScreenCaptureKit framework - screen and audio capture on macOS
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

use core::fmt;
use std::ffi::c_void;

use crate::utils::ffi_string::ffi_string_owned_or_empty;

/// Wrapper around `SCRunningApplication` from `ScreenCaptureKit`
///
/// Represents a running application that can be captured.
///
/// # Examples
///
/// ```no_run
/// use screencapturekit::shareable_content::SCShareableContent;
///
/// # fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let content = SCShareableContent::get()?;
/// for app in content.applications() {
///     println!("App: {} (PID: {})",
///         app.application_name(),
///         app.process_id()
///     );
/// }
/// # Ok(())
/// # }
/// ```
#[repr(transparent)]
pub struct SCRunningApplication(*const c_void);

impl PartialEq for SCRunningApplication {
    fn eq(&self, other: &Self) -> bool {
        self.0 == other.0
    }
}

impl Eq for SCRunningApplication {}

impl std::hash::Hash for SCRunningApplication {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.0.hash(state);
    }
}

impl SCRunningApplication {
    /// Create from raw pointer (used internally by shareable content)
    pub(crate) unsafe fn from_ptr(ptr: *const c_void) -> Self {
        Self(ptr)
    }

    /// Create from FFI-owned pointer (caller transfers ownership)
    #[allow(dead_code)]
    pub(crate) fn from_ffi_owned(ptr: *const c_void) -> Self {
        Self(ptr)
    }

    /// Get the raw pointer (used internally)
    pub(crate) fn as_ptr(&self) -> *const c_void {
        self.0
    }

    /// Get process ID
    pub fn process_id(&self) -> i32 {
        unsafe { crate::ffi::sc_running_application_get_process_id(self.0) }
    }

    /// Get application name
    pub fn application_name(&self) -> String {
        unsafe {
            ffi_string_owned_or_empty(|| {
                crate::ffi::sc_running_application_get_application_name_owned(self.0)
            })
        }
    }

    /// Get bundle identifier
    pub fn bundle_identifier(&self) -> String {
        unsafe {
            ffi_string_owned_or_empty(|| {
                crate::ffi::sc_running_application_get_bundle_identifier_owned(self.0)
            })
        }
    }
}

impl Drop for SCRunningApplication {
    fn drop(&mut self) {
        if !self.0.is_null() {
            unsafe {
                crate::ffi::sc_running_application_release(self.0);
            }
        }
    }
}

impl Clone for SCRunningApplication {
    fn clone(&self) -> Self {
        unsafe { Self(crate::ffi::sc_running_application_retain(self.0)) }
    }
}

impl fmt::Debug for SCRunningApplication {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("SCRunningApplication")
            .field("bundle_identifier", &self.bundle_identifier())
            .field("application_name", &self.application_name())
            .field("process_id", &self.process_id())
            .finish()
    }
}

impl fmt::Display for SCRunningApplication {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{} ({}) [PID: {}]",
            self.application_name(),
            self.bundle_identifier(),
            self.process_id()
        )
    }
}

unsafe impl Send for SCRunningApplication {}
unsafe impl Sync for SCRunningApplication {}