Skip to main content

HostedPluginProcessor

Struct HostedPluginProcessor 

Source
pub struct HostedPluginProcessor<I> { /* private fields */ }
Expand description

Adapts a PluginInstance into an audio-graph Processor.

The wrapper forwards prepare/reset/process to the held instance and maps the instance’s reported latency onto the graph’s tail-frame contract.

Implementations§

Source§

impl<I> HostedPluginProcessor<I>

Source

pub fn new(instance: I) -> Self

Wraps an instance so it can be inserted into an audio graph.

Source

pub fn instance(&self) -> &I

Returns a shared reference to the wrapped instance.

Source

pub fn instance_mut(&mut self) -> &mut I

Returns a mutable reference to the wrapped instance.

Source

pub fn into_inner(self) -> I

Consumes the wrapper and returns the wrapped instance.

Trait Implementations§

Source§

impl<I: Clone> Clone for HostedPluginProcessor<I>

Source§

fn clone(&self) -> HostedPluginProcessor<I>

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<I: Debug> Debug for HostedPluginProcessor<I>

Source§

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

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

impl<I: PluginInstance> Processor for HostedPluginProcessor<I>

Source§

fn prepare(&mut self, cfg: PrepareConfig)

Prepares the processor for a sample rate, block size, and channel layout.
Source§

fn reset(&mut self)

Clears any internal state to a fresh start.
Source§

fn process(&mut self, block: &mut ProcessBlock<'_>)

Processes one block of audio and events in place.
Source§

fn tail_frames(&self) -> u64

Returns the processor’s release tail length in frames (defaults to 0).
Source§

fn clock_domain(&self) -> ClockDomain

Returns the processor’s clock domain (defaults to sample rate).
Source§

fn latency_class(&self) -> LatencyClass

Returns the processor’s latency class (defaults to block-local).
Source§

fn realtime_pin(&self) -> bool

Returns whether the processor must run in the realtime thread (defaults to true).
Source§

fn ports(&self, in_channels: u16, out_channels: u16) -> Vec<PortDecl>

Returns the processor’s port declarations for the given channel counts (defaults to a single audio in/out pair).
Source§

fn descriptor(&self, in_channels: u16, out_channels: u16) -> ProcessorDescriptor

Returns the full ProcessorDescriptor assembled from this processor’s clock, latency, pinning, and ports.

Auto Trait Implementations§

§

impl<I> Freeze for HostedPluginProcessor<I>
where I: Freeze,

§

impl<I> RefUnwindSafe for HostedPluginProcessor<I>
where I: RefUnwindSafe,

§

impl<I> Send for HostedPluginProcessor<I>
where I: Send,

§

impl<I> Sync for HostedPluginProcessor<I>
where I: Sync,

§

impl<I> Unpin for HostedPluginProcessor<I>
where I: Unpin,

§

impl<I> UnsafeUnpin for HostedPluginProcessor<I>
where I: UnsafeUnpin,

§

impl<I> UnwindSafe for HostedPluginProcessor<I>
where I: UnwindSafe,

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

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.