Struct Options 

pub struct Options { /* private fields */ }

Available on crate features std or alloc only.

Options for the intensity-threshold scene detector. See the module docs for how each parameter shapes the algorithm.

Implementations

impl Options

pub const fn new() -> Self

Creates a new Options with default values.

Defaults: threshold = 12, method = Floor, fade_bias = 0.0, add_final_scene = false, min_duration = 1 s.

pub const fn threshold(&self) -> u8

Returns the mean-intensity threshold used for fade detection.

Interpreted as an 8-bit brightness value in [0, 255]. Frames with a mean below this (for Method::Floor) are considered “dark”.

pub const fn with_threshold(self, val: u8) -> Self

Set the threshold.

pub const fn set_threshold(&mut self, val: u8) -> &mut Self

Set the threshold in place.

pub const fn method(&self) -> Method

Returns the fade-detection Method.

pub const fn with_method(self, val: Method) -> Self

Set the method.

pub const fn set_method(&mut self, val: Method) -> &mut Self

Set the method in place.

pub const fn fade_bias(&self) -> f64

Returns the fade bias, clamped to [-1.0, 1.0] at use time.

Controls cut placement between the fade-out and fade-in frames: -1 = at fade-out, 0 = midpoint (default), +1 = at fade-in.

pub const fn with_fade_bias(self, val: f64) -> Self

Set the fade bias.

pub const fn set_fade_bias(&mut self, val: f64) -> &mut Self

Set the fade bias in place.

pub const fn add_final_scene(&self) -> bool

Returns whether Detector::finish will emit a final cut when the stream ends in the Out state.

pub const fn with_add_final_scene(self, val: bool) -> Self

Set whether to emit a final cut at end-of-stream when in Out state.

pub const fn set_add_final_scene(&mut self, val: bool) -> &mut Self

Set whether to emit a final cut at end-of-stream in place.

pub const fn min_duration(&self) -> Duration

Returns the minimum scene duration.

pub const fn with_min_duration(self, val: Duration) -> Self

Set the minimum scene duration.

pub const fn set_min_duration(&mut self, val: Duration) -> &mut Self

Set the minimum scene duration in place.

pub const fn with_min_frames(self, frames: u32, fps: Timebase) -> Self

Set the minimum scene length as a number of frames at a given frame rate.

See crate::histogram::Options::with_min_frames for the semantics.

pub const fn set_min_frames(&mut self, frames: u32, fps: Timebase) -> &mut Self

In-place form of Self::with_min_frames.

pub const fn initial_cut(&self) -> bool

Whether the first detected cut is allowed to fire immediately.

• true (default): the first complete fade cycle emits a cut as soon as the min-duration gate is satisfied relative to stream start.
• false: suppresses cuts until the stream has actually run for at least Self::min_duration. Matches PySceneDetect’s default.

pub const fn with_initial_cut(self, val: bool) -> Self

Sets whether the first detected cut may fire immediately.

pub const fn set_initial_cut(&mut self, val: bool) -> &mut Self

Sets initial_cut in place.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Options

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.