Skip to main content

DetectorConfig

Struct DetectorConfig 

Source
pub struct DetectorConfig {
    pub c1: f64,
    pub c2: f64,
    pub c3: f64,
    pub tick_interval: Duration,
    pub n1: u8,
    pub n2: u8,
    pub n3: u8,
}
Expand description

Tunable constants for the dominant-speaker election.

Defaults match mediasoup’s production constants exactly.

§Example

use dominant_speaker::{ActiveSpeakerDetector, DetectorConfig};
use core::time::Duration;

// Use defaults (mediasoup-identical behaviour).
let default_detector: ActiveSpeakerDetector<u64> = ActiveSpeakerDetector::new();

// Raise C1/C2 for a low-bitrate / mobile deployment: fewer speaker switches.
let config = DetectorConfig {
    c1: 5.0,
    c2: 4.0,
    tick_interval: Duration::from_millis(500),
    ..DetectorConfig::default()
};
let tuned_detector: ActiveSpeakerDetector<u64> = ActiveSpeakerDetector::with_config(config);

§Serde

Enable the serde feature to serialize/deserialize this struct. tick_interval is serialized as milliseconds (u64).

// Requires `dominant_speaker` with `serde` feature and `serde_json` dev-dep.
use dominant_speaker::DetectorConfig;
let config = DetectorConfig::default();
let json = serde_json::to_string(&config).unwrap();
let back: DetectorConfig = serde_json::from_str(&json).unwrap();
assert!((back.c1 - config.c1).abs() < f64::EPSILON);

Fields§

§c1: f64

Immediate-window log-ratio threshold (mediasoup: C1).

§c2: f64

Medium-window log-ratio threshold (mediasoup: C2).

§c3: f64

Long-window log-ratio threshold; zero = long window disabled (mediasoup: C3).

§tick_interval: Duration

Evaluation cadence. Recommend 300 ms.

§n1: u8

Immediate-window subband count (mediasoup: N1).

The subband width is derived automatically via ceil(128 / n1). The default of 13 gives a subband width of 10, matching mediasoup.

§n2: u8

Medium-window subband count (mediasoup: N2).

§n3: u8

Long-window subband count (mediasoup: N3).

Trait Implementations§

Source§

impl Clone for DetectorConfig

Source§

fn clone(&self) -> DetectorConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DetectorConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DetectorConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.