Struct AsyncSCStream 

pub struct AsyncSCStream { /* private fields */ }

Async wrapper for SCStream with integrated frame iteration

Provides async methods for stream lifecycle and frame iteration. Executor-agnostic - works with any async runtime.

Examples

use screencapturekit::async_api::{AsyncSCShareableContent, AsyncSCStream};
use screencapturekit::stream::configuration::SCStreamConfiguration;
use screencapturekit::stream::content_filter::SCContentFilter;
use screencapturekit::stream::output_type::SCStreamOutputType;

let content = AsyncSCShareableContent::get().await?;
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 stream = AsyncSCStream::new(&filter, &config, 30, SCStreamOutputType::Screen);
stream.start_capture()?;

// Process frames asynchronously
while let Some(frame) = stream.next().await {
    println!("Got frame!");
}

Implementations

impl AsyncSCStream

pub fn new( filter: &SCContentFilter, config: &SCStreamConfiguration, buffer_capacity: usize, output_type: SCStreamOutputType, ) -> Self

Create a new async stream

Arguments

• filter - Content filter specifying what to capture
• config - Stream configuration
• buffer_capacity - Max frames to buffer (oldest dropped when full)
• output_type - Type of output (Screen, Audio, Microphone)

pub fn next(&self) -> NextSample<'_>

Get the next sample buffer asynchronously

Returns None when the stream is closed.

pub fn try_next(&self) -> Option<CMSampleBuffer>

Try to get a sample without waiting

pub fn is_closed(&self) -> bool

Check if the stream has been closed

pub fn buffered_count(&self) -> usize

Get the number of buffered samples

pub fn clear_buffer(&self)

Clear all buffered samples

pub fn start_capture(&self) -> Result<(), SCError>

Start capture (synchronous - returns immediately)

Errors

Returns an error if capture fails to start.

pub fn stop_capture(&self) -> Result<(), SCError>

Stop capture (synchronous - returns immediately)

Errors

Returns an error if capture fails to stop.

pub fn update_configuration( &self, config: &SCStreamConfiguration, ) -> Result<(), SCError>

Update stream configuration

Errors

Returns an error if the update fails.

pub fn update_content_filter( &self, filter: &SCContentFilter, ) -> Result<(), SCError>

Update content filter

Errors

Returns an error if the update fails.

pub fn inner(&self) -> &SCStream

Get a reference to the underlying stream