Struct SCScreenshotManager 

pub struct SCScreenshotManager;

Manager for capturing single screenshots

Available on macOS 14.0+. Provides a simpler API than SCStream for one-time captures.

Examples

use screencapturekit::screenshot_manager::SCScreenshotManager;
use screencapturekit::stream::{content_filter::SCContentFilter, configuration::SCStreamConfiguration};
use screencapturekit::shareable_content::SCShareableContent;

let content = SCShareableContent::get()?;
let display = &content.displays()[0];
let filter = SCContentFilter::builder().display(display).exclude_windows(&[]).build();
let mut config = SCStreamConfiguration::default();
config.set_width(1920);
config.set_height(1080);

let image = SCScreenshotManager::capture_image(&filter, &config)?;
println!("Captured screenshot: {}x{}", image.width(), image.height());

Implementations

impl SCScreenshotManager

pub fn capture_image( content_filter: &SCContentFilter, configuration: &SCStreamConfiguration, ) -> Result<CGImage, SCError>

Capture a single screenshot as a CGImage

Errors

Returns an error if:

• The system is not macOS 14.0+
• Screen recording permission is not granted
• The capture fails for any reason

Panics

Panics if the internal mutex is poisoned.

pub fn capture_sample_buffer( content_filter: &SCContentFilter, configuration: &SCStreamConfiguration, ) -> Result<CMSampleBuffer, SCError>

Capture a single screenshot as a CMSampleBuffer

Returns the sample buffer for advanced processing.

Errors

Returns an error if:

• The system is not macOS 14.0+
• Screen recording permission is not granted
• The capture fails for any reason

Panics

Panics if the internal mutex is poisoned.