Struct CaptureOptions 

pub struct CaptureOptions {
    pub input: String,
    pub chrome: PathBuf,
    pub width: u32,
    pub height: u32,
    pub fps: u32,
    pub duration_secs: f64,
    pub mode: Mode,
    pub no_sandbox: bool,
}

What to capture and how.

Fields

input: String

HTML file, or an http(s)/file URL.

chrome: PathBuf

Path to chrome-headless-shell.

width: u32

Viewport width in CSS pixels.

height: u32

Viewport height in CSS pixels.

fps: u32

Frames per second.

duration_secs: f64

Length of the capture in seconds.

mode: Mode

How frames are drawn and grabbed.

no_sandbox: bool

Run Chrome without its sandbox (Ubuntu 23.10+; trusted pages only). Running as root always disables it, since Chrome refuses otherwise.

Implementations

impl CaptureOptions

pub fn new(input: impl Into<String>, chrome: impl Into<PathBuf>) -> Self

512×512 at 30 fps for 2 seconds, Mode::Auto, sandbox on.

pub fn size(self, width: u32, height: u32) -> Self

pub fn fps(self, fps: u32) -> Self

pub fn duration_secs(self, secs: f64) -> Self

pub fn mode(self, mode: Mode) -> Self

pub fn no_sandbox(self, no_sandbox: bool) -> Self

pub fn frame_count(&self) -> u64

How many frames the capture produces: duration × fps, rounded.

pub fn validate(&self) -> Result<()>

Catch bad options before a browser is started.

Trait Implementations

impl Clone for CaptureOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaptureOptions

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

Formats the value using the given formatter.