Skip to main content

BusLayout

Struct BusLayout 

Source
pub struct BusLayout {
    pub main_in: Option<ChannelConfig>,
    pub main_out: ChannelConfig,
    pub sidechain_in: Option<ChannelConfig>,
    pub aux_out: Option<ChannelConfig>,
}
Expand description

One complete I/O layout (main in/out + optional sidechain in + optional aux out).

Instruments can use Self::output_only. Effects use Self::mono / Self::stereo / Self::stereo_and_mono. Add buses via Self::with_sidechain / Self::with_aux.

Fields§

§main_in: Option<ChannelConfig>

Main input width. None = no audio input (generator / instrument).

§main_out: ChannelConfig

Main output width.

§sidechain_in: Option<ChannelConfig>

Optional sidechain input bus. None = no sidechain.

§aux_out: Option<ChannelConfig>

Optional aux output bus. None = no aux out.

Implementations§

Source§

impl BusLayout

Source

pub const fn mono() -> BusLayout

Source

pub const fn stereo() -> BusLayout

Source

pub const fn output_only(out: ChannelConfig) -> BusLayout

Output-only layout (instrument / generator).

Source

pub const fn with_sidechain(self, sidechain: ChannelConfig) -> BusLayout

Return a copy of this layout with the given sidechain input bus.

Source

pub const fn with_aux(self, aux: ChannelConfig) -> BusLayout

Return a copy of this layout with the given aux output bus.

Source

pub fn stereo_and_mono() -> Vec<BusLayout>

Default effect set: stereo first (host default), then mono.

Source

pub const fn main_input_channels(self) -> u32

Source

pub const fn sidechain_input_channels(self) -> u32

Source

pub const fn aux_output_channels(self) -> u32

Source

pub const fn input_port_count(self) -> u32

CLAP/VST3 input port count (main + optional sidechain), not channels.

Stereo sidechain is still one port with two channels. Using Self::sidechain_input_channels here advertises extra ports with duplicate ids and breaks host routing (Bitwig dry-passthrough).

Source

pub const fn output_port_count(self) -> u32

CLAP/VST3 output port count (main + optional aux), not channels.

Source

pub const fn total_input_channels(self) -> u32

Total audio input channels passed to AudioBuffer: main inputs followed by sidechain inputs.

Source

pub const fn main_output_channels(self) -> u32

Source

pub const fn total_output_channels(self) -> u32

Total audio output channels: main outputs followed by aux outputs.

Source

pub fn config_name(self) -> String

Human-readable config name for host menus (clap.audio-ports-config).

Trait Implementations§

Source§

impl Clone for BusLayout

Source§

fn clone(&self) -> BusLayout

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BusLayout

Source§

impl Debug for BusLayout

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Eq for BusLayout

Source§

impl PartialEq for BusLayout

Source§

fn eq(&self, other: &BusLayout) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BusLayout

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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