Struct voicemeeter::interface::parameters::bus::Bus

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

Available on crate feature interface only.

Parameters for a bus.

A bus is a output.

Returned by VoicemeeterRemote::parameters().bus(i)

Example

use voicemeeter::VoicemeeterRemote;

// Get the client.
let remote = VoicemeeterRemote::new()?;

// Get the label of bus A1 (index 0)
println!("{}", remote.parameters().bus(0)?.label().get()?);

// Mute bus A4 (index 5)
remote.parameters().bus(2)?.mute().set(true)?;

// Ensure the change is registered.
remote.is_parameters_dirty()?;

// We need to sleep here because otherwise changes won't be registered,
// in a long running program this is not needed.
std::thread::sleep(std::time::Duration::from_millis(50));

Implementations

impl<'a> Bus<'a>

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

Get the identifier for a parameter on this bus: Bus[i].{dot}

pub fn label(&self) -> StringParameter<'_>

Label

pub fn mono(&self) -> IntParameter<'_>

Mono Button

pub fn mute(&self) -> BoolParameter<'_>

Mute Button

pub fn eq_on(&self) -> BoolParameter<'_>

EQ Button

pub fn eq_ab(&self) -> BoolParameter<'_>

EQ Memory Slot

pub fn gain(&self) -> FloatParameter<'_>

Gain slider

pub fn mode(&self) -> BusModeParameter<'_>

Bus mode Normal

pub fn eq(&self, channel: usize) -> EqChannelParameter<'_>

EQ on channel

pub fn fade_to(&self) -> TupleParameter<'_, f32, usize>

Fade to

pub fn fade_by(&self) -> TupleParameter<'_, f32, usize>

Fade by

pub fn sel(&self) -> BoolParameter<'_>

BUS SEL Button

pub fn return_reverb(&self) -> IntParameter<'_>

Reverb return

pub fn return_delay(&self) -> IntParameter<'_>

Delay return

pub fn return_fx1(&self) -> IntParameter<'_>

Fx1 Return

pub fn return_fx2(&self) -> IntParameter<'_>

Fx2 Return

pub fn monitor(&self) -> BoolParameter<'_>

Monitor

pub fn device(&self) -> BusDevice<'_>

Audio Device information