Struct noise_gate::NoiseGate

pub struct NoiseGate<S> {
    pub open_threshold: S,
    pub release_time: usize,
    // some fields omitted
}

A Noise Gate which can be used to split a stream of audio based on volume, skipping periods of silence.

Fields

open_threshold: S

The volume level at which the gate will open (begin recording).

release_time: usize

The amount of time (in samples) the gate takes to go from open to fully closed.

Methods

impl<S> NoiseGate<S>

pub const fn new(open_threshold: S, release_time: usize) -> Self

Create a new NoiseGate.

pub fn is_open(&self) -> bool

Is the gate currently passing samples through to the Sink?

pub fn is_closed(&self) -> bool

Is the gate currently ignoring silence?

impl<S: Sample> NoiseGate<S>

pub fn process_frames<K, F>(&mut self, frames: &[F], sink: &mut K) where
    F: Frame<Sample = S>,
    K: Sink<F>, 

Process a batch of frames, passing spans of noise through to a sink.

Trait Implementations

impl<S: Clone> Clone for NoiseGate<S>

fn clone(&self) -> NoiseGate<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: PartialEq> PartialEq<NoiseGate<S>> for NoiseGate<S>

fn eq(&self, other: &NoiseGate<S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &NoiseGate<S>) -> bool

This method tests for !=.

impl<S: Debug> Debug for NoiseGate<S>

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

Formats the value using the given formatter.