pub struct Parameters<'a> { /* private fields */ }
Available on crate feature interface only.
Expand description

Parameter abstraction

§Examples

println!(
    "Strip 1: {}",
    remote.parameters().strip(0)?.device()?.name().get()?
);

Implementations§

source§

impl<'a> Parameters<'a>

source

pub fn strip(&self, index: impl StripIndex) -> Result<Strip<'a>, ParameterError>

Parameters of a strip.

A strip is a input that can be physical or virtual

§Availability

On each Voicemeeter application, there are different amounts of strips

ApplicationStripsPhysicalVirtual
Voicemeetertotal: 3total: 2 (starting on strip #0)total: 1 (starting on strip #2)
Voicemeeter Bananatotal: 5total: 3 (starting on strip #0)total: 2 (starting on strip #3)
Voicemeeter Potatototal: 8total: 5 (starting on strip #0)total: 3 (starting on strip #5)
source

pub fn bus(&self, index: impl BusIndex) -> Result<Bus<'a>, ParameterError>

Parameters of a bus.

A bus is a output. In the interface, these are called A1, A2, A3, B1, etc.

§Availability

On each Voicemeeter application, there are different amounts of busses

ApplicationBussesPhysicalVirtual
Voicemeetertotal: 2total: 2 (starting on bus #0)total: 0
Voicemeeter Bananatotal: 5total: 3 (starting on bus #0)total: 2 (starting on bus #3)
Voicemeeter Potatototal: 8total: 5 (starting on bus #0)total: 3 (starting on bus #5)
source

pub fn option(&self) -> VoicemeeterOption<'a>

Options for Voicemeeter

source

pub fn recorder(&self) -> Result<VoicemeeterRecorder<'a>, ParameterError>

Voicemeeter recorder with playback

source

pub fn fx(&self) -> Result<VoicemeeterFx<'a>, ParameterError>

Voicemeeter FX

source

pub fn vban(&self) -> VoicemeeterVban<'a>

Voicemeeter VBAN

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for Parameters<'a>

§

impl<'a> Send for Parameters<'a>

§

impl<'a> Sync for Parameters<'a>

§

impl<'a> Unpin for Parameters<'a>

§

impl<'a> UnwindSafe for Parameters<'a>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more