screencapturekit::stream::delegate_trait

Trait SCStreamDelegateTrait

pub trait SCStreamDelegateTrait: Send {
    // Provided methods
    fn output_video_effect_did_start_for_stream(&self) { ... }
    fn output_video_effect_did_stop_for_stream(&self) { ... }
    fn stream_did_become_active(&self) { ... }
    fn stream_did_become_inactive(&self) { ... }
    fn did_stop_with_error(&self, _error: SCError) { ... }
    fn stream_did_stop(&self, _error: Option<String>) { ... }
}

Expand description

Trait for handling stream lifecycle events

Implement this trait to receive notifications about stream state changes, errors, and video effects.

§Examples

§Using a struct

use screencapturekit::stream::delegate_trait::SCStreamDelegateTrait;
use screencapturekit::error::SCError;

struct MyDelegate;

impl SCStreamDelegateTrait for MyDelegate {
    fn stream_did_stop(&self, error: Option<String>) {
        if let Some(err) = error {
            eprintln!("Stream stopped with error: {}", err);
        } else {
            println!("Stream stopped normally");
        }
    }

    fn did_stop_with_error(&self, error: SCError) {
        eprintln!("Stream error: {}", error);
    }
}

§Using closures

Use StreamCallbacks to create a delegate from closures:

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


let delegate = StreamCallbacks::new()
    .on_stop(|error| {
        if let Some(e) = error {
            eprintln!("Stream stopped with error: {}", e);
        }
    })
    .on_error(|error| eprintln!("Error: {}", error));

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

Provided Methods§

Source

fn output_video_effect_did_start_for_stream(&self)

Called when video effects start (macOS 14.0+)

Notifies when the stream’s overlay video effect (presenter overlay) has started.

Source

fn output_video_effect_did_stop_for_stream(&self)

Called when video effects stop (macOS 14.0+)

Notifies when the stream’s overlay video effect (presenter overlay) has stopped.

Source

fn stream_did_become_active(&self)

Called when the stream becomes active (macOS 15.2+)

Notifies the first time any window that was being shared in the stream is re-opened after all the windows being shared were closed. When all the windows being shared are closed, the client will receive stream_did_become_inactive.

Source