Struct volume::Volume

pub struct Volume {
    pub current: f32,
    pub interpolation_ms: Ms,
    // some fields omitted
}

A simple dsp node for multiplying the amplitude of its inputs by the held multiplier.

Fields

current: f32

interpolation_ms: Ms

Methods

impl Volume

fn new() -> Volume

Constructor for a new default volume. The default volume is 1.0, having no impact on the input signal. The default interpolation_ms is 10ms to avoid clipping.

fn volume(self, volume: f32) -> Volume

Builder for constructing a Volume with some given volume.

fn interpolation_ms(self, ms: Ms) -> Volume

Builder for constructing a Volume with some given interpolation length in Ms. The interpolation length is how long it takes the volume to progress from some previous volume to a new current volume. It is mainly used to avoid clipping.

The default interpolation_ms is 10ms - just enough to avoid clipping.

fn set(&mut self, volume: f32)

Set the new current volume.

Trait Implementations

impl Copy for Volume

impl Clone for Volume

fn clone(&self) -> Volume

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Volume

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

Formats the value using the given formatter.

impl<F> Node<F> for Volume where
    F: Frame, 

fn audio_requested(&mut self, buffer: &mut [F], sample_hz: f64)

Request audio from the Node given some sample_hz (aka sample rate in hertz). If the Node has no inputs, the buffer will be zeroed. If the Node has some inputs, the buffer will consist of the inputs summed together.

fn dry(&self) -> <<F as Frame>::Sample as Sample>::Float

Following the call to the Node's audio_requested method, the Graph will sum together some of the original (dry) signal with some of the processed (wet) signal.

fn wet(&self) -> <<F as Frame>::Sample as Sample>::Float

Following the call to the Node's audio_requested method, the Graph will sum together some of the original (dry) signal with some of the processed (wet) signal.