AsyncSCScreenshotManager

Struct AsyncSCScreenshotManager 

Source
pub struct AsyncSCScreenshotManager;
Expand description

Async wrapper for SCScreenshotManager

Provides async methods for single-frame screenshot capture. Executor-agnostic - works with any async runtime.

Requires the macos_14_0 feature flag.

§Examples

use screencapturekit::async_api::{AsyncSCShareableContent, AsyncSCScreenshotManager};
use screencapturekit::stream::configuration::SCStreamConfiguration;
use screencapturekit::stream::content_filter::SCContentFilter;

let content = AsyncSCShareableContent::get().await?;
let display = &content.displays()[0];
let filter = SCContentFilter::create().with_display(display).with_excluding_windows(&[]).build();
let config = SCStreamConfiguration::new()
    .with_width(1920)
    .with_height(1080);

let image = AsyncSCScreenshotManager::capture_image(&filter, &config).await?;
println!("Screenshot: {}x{}", image.width(), image.height());

Implementations§

Source§

impl AsyncSCScreenshotManager

Source

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

Capture a single screenshot as a CGImage asynchronously

§Errors

Returns an error if:

  • Screen recording permission is not granted
  • The capture fails for any reason
Source

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

Capture a single screenshot as a CMSampleBuffer asynchronously

§Errors

Returns an error if:

  • Screen recording permission is not granted
  • The capture fails for any reason
Source

pub fn capture_image_in_rect(rect: CGRect) -> AsyncScreenshotFuture<CGImage>

Capture a screenshot of a specific screen region asynchronously (macOS 15.2+)

This method captures the content within the specified rectangle, which can span multiple displays.

§Arguments
  • rect - The rectangle to capture, in screen coordinates (points)
§Errors

Returns an error if:

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

pub fn capture_screenshot( content_filter: &SCContentFilter, configuration: &SCScreenshotConfiguration, ) -> AsyncScreenshotFuture<SCScreenshotOutput>

Capture a screenshot with advanced configuration asynchronously (macOS 26.0+)

This method uses the new SCScreenshotConfiguration for more control over the screenshot output, including HDR support and file saving.

§Arguments
  • content_filter - The content filter specifying what to capture
  • configuration - The screenshot configuration
§Errors

Returns an error if the capture fails

Source

pub fn capture_screenshot_in_rect( rect: CGRect, configuration: &SCScreenshotConfiguration, ) -> AsyncScreenshotFuture<SCScreenshotOutput>

Capture a screenshot of a specific region with advanced configuration asynchronously (macOS 26.0+)

§Arguments
  • rect - The rectangle to capture, in screen coordinates (points)
  • configuration - The screenshot configuration
§Errors

Returns an error if the capture fails

Trait Implementations§

Source§

impl Clone for AsyncSCScreenshotManager

Source§

fn clone(&self) -> AsyncSCScreenshotManager

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AsyncSCScreenshotManager

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for AsyncSCScreenshotManager

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.