Struct SCShareableContent

Source

pub struct SCShareableContent(/* private fields */);

Implementations§

Source §

impl SCShareableContent

Source

pub fn get() -> Result<Self, SCError>

Get shareable content (displays, windows, and applications)

§Examples

use screencapturekit::shareable_content::SCShareableContent;

let content = SCShareableContent::get()?;
println!("Found {} displays", content.displays().len());
println!("Found {} windows", content.windows().len());
println!("Found {} apps", content.applications().len());

§Errors

Returns an error if screen recording permission is not granted.

Source

pub fn create() -> SCShareableContentOptions

Create options builder for customizing shareable content retrieval

§Examples

use screencapturekit::shareable_content::SCShareableContent;

let content = SCShareableContent::create()
    .with_on_screen_windows_only(true)
    .with_exclude_desktop_windows(true)
    .get()?;

Source

pub fn displays(&self) -> Vec<SCDisplay>

Get all available displays

§Examples

use screencapturekit::shareable_content::SCShareableContent;

let content = SCShareableContent::get()?;
for display in content.displays() {
    println!("Display: {}x{}", display.width(), display.height());
}

Source

pub fn windows(&self) -> Vec<SCWindow>

Get all available windows

§Examples

use screencapturekit::shareable_content::SCShareableContent;

let content = SCShareableContent::get()?;
for window in content.windows() {
    if let Some(title) = window.title() {
        println!("Window: {}", title);
    }
}

Source

pub fn applications(&self) -> Vec<SCRunningApplication>

Get all available running applications

§Examples

use screencapturekit::shareable_content::SCShareableContent;

let content = SCShareableContent::get()?;
for app in content.applications() {
    println!("App: {} (PID: {})", app.application_name(), app.process_id());
}

Source

pub fn snapshot(&self) -> Option<ContentSnapshot>

Fetch every display, window, and running application in a single batched FFI round-trip — see ContentSnapshot for what’s returned.

Use this in any code path that reads more than one attribute per window / display / app. The per-element accessors (displays, windows, applications + per-attribute methods like SCWindow::title / SCWindow::frame) issue one FFI call each — a typical “list windows with title and frame” walk on a 220-window system measured at ~73 µs. snapshot() collapses that to ~5 µs (~15× faster) by going through the bridge’s packed FFI surface and copying every attribute into Rust-side plain data structs in a single pass.

Returns None if the bridge couldn’t fit the data into the static scratch buffers (extremely unlikely — limits are 64 displays, 4096 windows, 1024 apps with a 256 KiB string pool).

Source §

impl SCShareableContent

Source

pub fn current_process_is_available() -> bool

Whether SCShareableContent::current_process is usable on this machine: the crate must have been compiled against a macOS 14.4+ SDK and be running on macOS 14.4 or later.

Use this to gate UI or pick a fallback strategy before paying for the call.

Source

pub fn current_process() -> Result<Self, SCError>

Get shareable content for the current process only (macOS 14.4+)

This retrieves content that the current process can capture without requiring user authorization via TCC (Transparency, Consent, and Control).

§Errors

Returns SCError::FeatureNotAvailable when running on macOS older than 14.4, or when the crate was built against an SDK that predates the API. There is deliberately no fallback to the system-wide content query: that requires screen-recording consent and returns every window on the machine, which callers of this method are specifically trying to avoid.

Otherwise returns an error if retrieval fails.