Struct FrameResult 

pub struct FrameResult { /* private fields */ }

Per-frame view of the streaming detector’s internal state.

One FrameResult is produced for every 10 ms frame consumed by crate::Vad::push_samples. The slice from the most recent non-empty push_samples call is accessible via crate::Vad::recent_frames.

Frame indices are 0-based; upstream Python uses 1-based indices and we shift on construction. speech_start_frame and speech_end_frame are the 0-based frame indices of the most-recent segment opening and closing seen so far (None until a segment has actually opened).

Implementations

impl FrameResult

pub const FRAME_SHIFT_SAMPLES: u32 = 160

Frame shift in samples (160 at 16 kHz, i.e. 10 ms).

pub const SAMPLE_RATE_HZ: u32 = 16_000

Sample rate in Hz (always 16_000).

pub const fn new( frame_index: u64, raw_prob: f32, smoothed_prob: f32, is_speech: bool, is_speech_start: bool, is_speech_end: bool, speech_start_frame: Option<u64>, speech_end_frame: Option<u64>, ) -> Self

Construct a FrameResult. Public so it is easy to assemble in tests; the Vad engine is the normal producer.

pub const fn frame_index(&self) -> u64

0-based frame index.

pub const fn raw_prob(&self) -> f32

Raw sigmoid output from the model for this frame.

pub const fn smoothed_prob(&self) -> f32

Trailing moving-average of raw_prob over the configured smooth window.

pub const fn is_speech(&self) -> bool

Whether smoothed_prob exceeds the speech threshold.

pub const fn is_speech_start(&self) -> bool

Whether this frame opened a new segment.

pub const fn is_speech_end(&self) -> bool

Whether this frame closed an open segment.

pub const fn speech_start_frame(&self) -> Option<u64>

0-based frame index of the most recent segment opening, if any.

pub const fn speech_end_frame(&self) -> Option<u64>

0-based frame index of the most recent segment closing, if any.

pub fn timestamp(&self) -> Duration

Timestamp at the start of this frame.

pub fn closed_segment(&self) -> Option<SpeechSegment>

If this frame closes a segment, return it; otherwise None.

Trait Implementations

impl Clone for FrameResult

fn clone(&self) -> FrameResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrameResult

impl Debug for FrameResult

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

Formats the value using the given formatter.

impl PartialEq for FrameResult

fn eq(&self, other: &FrameResult) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FrameResult