Struct StreamCallbacks 

pub struct StreamCallbacks { /* private fields */ }

Builder for closure-based stream delegate

Provides a convenient way to create a stream delegate using closures instead of implementing the SCStreamDelegateTrait trait.

Examples

use screencapturekit::prelude::*;
use screencapturekit::stream::delegate_trait::StreamCallbacks;


// Create delegate with multiple callbacks
let delegate = StreamCallbacks::new()
    .on_stop(|error| {
        if let Some(e) = error {
            eprintln!("Stream stopped with error: {}", e);
        } else {
            println!("Stream stopped normally");
        }
    })
    .on_error(|error| eprintln!("Stream error: {}", error))
    .on_active(|| println!("Stream became active"))
    .on_inactive(|| println!("Stream became inactive"));

let stream = SCStream::new_with_delegate(&filter, &config, delegate);

Implementations

impl StreamCallbacks

pub fn new() -> Self

Create a new empty callbacks builder

pub fn on_stop<F>(self, f: F) -> Self

where F: Fn(Option<String>) + Send + Sync + 'static,

Set the callback for when the stream stops.

The closure receives Some(message) describing the error that stopped the stream. Because ScreenCaptureKit only reports error stops to the delegate, this fires alongside on_error on an error stop; a clean stop you requested via SCStream::stop_capture is not delivered here. Prefer on_error when you want the typed SCError.

pub fn on_error<F>(self, f: F) -> Self

where F: Fn(SCError) + Send + Sync + 'static,

Set the callback for when the stream encounters an error

pub fn on_active<F>(self, f: F) -> Self

where F: Fn() + Send + Sync + 'static,

Set the callback for when the stream becomes active (macOS 15.2+)

pub fn on_inactive<F>(self, f: F) -> Self

where F: Fn() + Send + Sync + 'static,

Set the callback for when the stream becomes inactive (macOS 15.2+)

pub fn on_video_effect_start<F>(self, f: F) -> Self

where F: Fn() + Send + Sync + 'static,

Set the callback for when video effects start (macOS 14.0+)

pub fn on_video_effect_stop<F>(self, f: F) -> Self

where F: Fn() + Send + Sync + 'static,

Set the callback for when video effects stop (macOS 14.0+)

Trait Implementations

impl Debug for StreamCallbacks

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

Formats the value using the given formatter.

impl Default for StreamCallbacks

fn default() -> Self

Returns the “default value” for a type.

impl SCStreamDelegateTrait for StreamCallbacks

fn stream_did_stop(&self, error: Option<String>)

👎Deprecated:

ScreenCaptureKit reports stops only via did_stop_with_error; the stream engine no longer invokes this method. Implement did_stop_with_error instead.

Called when stream stops.

fn did_stop_with_error(&self, error: SCError)

Called when the stream stops with an error.

fn stream_did_become_active(&self)

Called when the stream becomes active (macOS 15.2+)

fn stream_did_become_inactive(&self)

Called when the stream becomes inactive (macOS 15.2+)

fn output_video_effect_did_start_for_stream(&self)

Called when video effects start (macOS 14.0+)

fn output_video_effect_did_stop_for_stream(&self)

Called when video effects stop (macOS 14.0+)