Struct voicemeeter::interface::parameters::strip::StripGate

pub struct StripGate<'a> { /* private fields */ }

Available on crate feature interface only.

Gate detailed parameters/settings

Only works on Voicemeeter Potato

Implementations

impl<'a> StripGate<'a>

pub fn param(&self, dot: impl ToString) -> Cow<'static, ParameterNameRef>

Get the identifier for a gate parameter on this strip: Strip[i].gate.{dot}

pub fn threshold(&self) -> FloatParameter<'a, true, true>

Threshold

If input gain is below this level the gate is closing, above this level the gate is opening.

pub fn damping(&self) -> FloatParameter<'a, true, true>

Damping Max

Allows limiting the gain reduction when the gate is closing. Per default OFF = -inf, the gate completely remove the signal when closing.

pub fn bp_sidechain(&self) -> FloatParameter<'a, true, true>

Band Pass Sidechain (hz)

This parameters allows to define a Band Pass frequency (1,5 octave) in the sidechain (input signal controlling the gate). Then the gate will react on specific frequency range only.

pub fn attack(&self) -> FloatParameter<'a, true, true>

Attack Time (ms)

Define how long it takes to open the gate (gain increasing time).

pub fn hold(&self) -> FloatParameter<'a, true, true>

Hold Time (ms)

Define the minimal time the gate stays opened anyway (whatever the input gain).

pub fn release(&self) -> FloatParameter<'a, true, true>

Release Time (ms)

Define how long it takes to close the gate (gain decreasing time).