Struct SCShareableContent 

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

Implementations

impl SCShareableContent

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.

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()?;

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());
}

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);
    }
}

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());
}

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).

impl SCShareableContent

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 an error if retrieval fails.

Trait Implementations

impl Clone for SCShareableContent

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SCShareableContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SCShareableContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for SCShareableContent

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for SCShareableContent

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SCShareableContent

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SCShareableContent

impl Send for SCShareableContent

impl Sync for SCShareableContent