Struct Screencast 

pub struct Screencast { /* private fields */ }

Live frame-streaming entry point. Obtained from Page::screencast.

Implementations

impl Screencast

pub async fn start(&self, options: ScreencastStartOptions) -> Result<()>

Begin streaming. Frames arrive on handlers registered via on_frame; register them before calling start so no frames are missed.

If options.path is set, the screencast is also recorded to disk; the file is written when stop is called.

pub async fn stop(&self) -> Result<()>

Stop the screencast. If start was called with a path, the recorded file is written to that path before this call returns.

pub fn on_frame<F, Fut>(&self, handler: F)

where F: Fn(ScreencastFrame) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Register a handler for incoming frames. Multiple handlers may be registered; they fire in order for each frame.

pub async fn show_actions(&self, options: ShowActionsOptions) -> Result<()>

Overlay action labels on the streamed frames as actions occur. Pair with hide_actions to stop.

pub async fn hide_actions(&self) -> Result<()>

Stop overlaying action labels. No-op if not currently shown.

pub async fn show_chapter( &self, title: &str, options: ChapterOptions, ) -> Result<()>

Show a chapter card with the given title (and optional description). Useful for splitting a session into named phases for an agent’s video log.

pub async fn show_overlay( &self, html: &str, options: ShowOverlayOptions, ) -> Result<OverlayId>

Render arbitrary HTML as an overlay. Returns an OverlayId you can pass to remove_overlay to dismiss it early; otherwise it dismisses itself after options.duration (if set) or stays until removed.

pub async fn remove_overlay(&self, id: OverlayId) -> Result<()>

Remove an overlay previously created via show_overlay. Idempotent.

pub async fn set_overlay_visible(&self, visible: bool) -> Result<()>

Toggle visibility of all currently-shown overlays without removing them. Useful for hiding overlays during a section the agent considers “noise” and re-showing them later.

Trait Implementations

impl Clone for Screencast

fn clone(&self) -> Screencast

Returns a duplicate of the value.

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

Performs copy-assignment from source.