Struct Stats

#[repr(C)]
pub struct Stats {
    pub has_voice: OptionalBool,
    pub has_echo: OptionalBool,
    pub rms_dbfs: OptionalInt,
    pub speech_probability: OptionalDouble,
    pub residual_echo_return_loss: OptionalDouble,
    pub echo_return_loss: OptionalDouble,
    pub echo_return_loss_enhancement: OptionalDouble,
    pub a_nlp: OptionalDouble,
    pub delay_median_ms: OptionalInt,
    pub delay_standard_deviation_ms: OptionalInt,
    pub delay_fraction_poor_delays: OptionalDouble,
}

Statistics about the processor state.

Fields

has_voice: OptionalBool

True if voice is detected in the current frame.

has_echo: OptionalBool

False if the current frame almost certainly contains no echo and true if it _might_ contain echo.

rms_dbfs: OptionalInt

Root mean square (RMS) level in dBFs (decibels from digital full-scale), or alternately dBov. It is computed over all primary stream frames since the last call to |get_stats()|. The returned value is constrained to [-127, 0], where -127 indicates muted.

speech_probability: OptionalDouble

Prior speech probability of the current frame averaged over output channels, internally computed by noise suppressor.

residual_echo_return_loss: OptionalDouble

RERL = ERL + ERLE

echo_return_loss: OptionalDouble

ERL = 10log_10(P_far / P_echo)

echo_return_loss_enhancement: OptionalDouble

ERLE = 10log_10(P_echo / P_out)

a_nlp: OptionalDouble

(Pre non-linear processing suppression) A_NLP = 10log_10(P_echo / P_a)

delay_median_ms: OptionalInt

Median of the measured delay in ms. The values are aggregated until the first call to |get_stats()| and afterwards aggregated and updated every second.

delay_standard_deviation_ms: OptionalInt

Standard deviation of the measured delay in ms. The values are aggregated until the first call to |get_stats()| and afterwards aggregated and updated every second.

delay_fraction_poor_delays: OptionalDouble

The fraction of delay estimates that can make the echo cancellation perform poorly.

Trait Implementations

impl Clone for Stats

fn clone(&self) -> Stats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stats

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

Formats the value using the given formatter.

impl Default for Stats

fn default() -> Stats

Returns the “default value” for a type.

impl PartialEq for Stats

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Stats

impl StructuralPartialEq for Stats