Skip to main content

AudioConfig

Struct AudioConfig 

Source
#[non_exhaustive]
pub struct AudioConfig { pub sample_rate: f64, pub max_block_size: usize, pub sample_format: SampleFormat, pub mode: ProcessMode, pub configuration: Option<u64>, pub inputs: Vec<AudioBusConfig>, pub outputs: Vec<AudioBusConfig>, pub events: EventConfig, }
Expand description

Requested native buses. Buses omitted from a direction are inactive. Native layout/precision negotiation follows validation; successful preparation returns the complete negotiated map.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§sample_rate: f64

Samples per second; must be finite and greater than zero.

§max_block_size: usize

Maximum frames per processing call, from 1 through i32::MAX.

§sample_format: SampleFormat

Sample precision shared by all buses and slots.

§mode: ProcessMode

Processing mode reported to the plugin.

§configuration: Option<u64>

Native named configuration to select, or None to retain the current selection.

§inputs: Vec<AudioBusConfig>

Requested input buses; omitted buses are inactive.

§outputs: Vec<AudioBusConfig>

Requested output buses; omitted buses are inactive.

§events: EventConfig

Native event ports to activate; ports not named are left inactive where the format allows.

Implementations§

Source§

impl AudioConfig

Source

pub fn new( sample_rate: f64, max_block_size: usize, sample_format: SampleFormat, inputs: Vec<AudioBusConfig>, outputs: Vec<AudioBusConfig>, ) -> AudioConfig

One plugin’s inputs and outputs offline, keeping its current named configuration and leaving its event ports inactive.

Source

pub fn with_mode(self, mode: ProcessMode) -> AudioConfig

Reports mode to the plugin.

Source

pub fn with_configuration(self, configuration: u64) -> AudioConfig

Selects the native named configuration configuration first.

Source

pub fn with_events(self, events: EventConfig) -> AudioConfig

Activates the native event ports events names.

Source

pub fn validate(&self) -> Result<(), InputError>

Checks scalar processing values, unique bus IDs, layouts, and audio capacity limits.

Source

pub fn input_channels(&self) -> usize

Total active input channels across the requested native buses.

Source

pub fn output_channels(&self) -> usize

Total active output channels across the requested native buses.

Trait Implementations§

Source§

impl Clone for AudioConfig

Source§

fn clone(&self) -> Self

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 Debug for AudioConfig

Source§

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

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

impl PartialEq for AudioConfig

Source§

fn eq(&self, other: &Self) -> 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 AudioConfig

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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