Skip to main content

ProcessorPlugin

Struct ProcessorPlugin 

Source
pub struct ProcessorPlugin<P> { /* private fields */ }
Expand description

Presents an audio-graph Processor as a PluginInstance.

This is the inverse adapter of HostedPluginProcessor: it pairs a bare processor with a descriptor and a held PluginState, letting any processor be hosted as a native (sim-format) plugin. State is stored on the wrapper rather than pushed into the processor.

Implementations§

Source§

impl<P> ProcessorPlugin<P>

Source

pub fn new(descriptor: PluginDescriptor, processor: P) -> Self

Pairs a descriptor with a processor, starting from empty state.

Source

pub fn processor(&self) -> &P

Returns a shared reference to the wrapped processor.

Source

pub fn processor_mut(&mut self) -> &mut P

Returns a mutable reference to the wrapped processor.

Source

pub fn into_processor(self) -> P

Consumes the wrapper and returns the wrapped processor.

Trait Implementations§

Source§

impl<P: Clone> Clone for ProcessorPlugin<P>

Source§

fn clone(&self) -> ProcessorPlugin<P>

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<P: Debug> Debug for ProcessorPlugin<P>

Source§

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

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

impl<P: Processor> PluginInstance for ProcessorPlugin<P>

Source§

fn descriptor(&self) -> &PluginDescriptor

Returns the descriptor that identifies this instance and its port and parameter layout.
Source§

fn state(&self) -> PluginState

Captures the instance’s current persistable state. Read more
Source§

fn set_state(&mut self, state: PluginState)

Restores the instance from a previously captured PluginState. Read more
Source§

fn prepare(&mut self, cfg: PrepareConfig)

Prepares the instance for processing under the given configuration.
Source§

fn reset(&mut self)

Clears any internal processing state without releasing resources.
Source§

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

Processes one audio block in place.
Source§

fn latency_frames(&self) -> u32

Returns the instance’s reported latency in frames. Read more

Auto Trait Implementations§

§

impl<P> Freeze for ProcessorPlugin<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for ProcessorPlugin<P>
where P: RefUnwindSafe,

§

impl<P> Send for ProcessorPlugin<P>
where P: Send,

§

impl<P> Sync for ProcessorPlugin<P>
where P: Sync,

§

impl<P> Unpin for ProcessorPlugin<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for ProcessorPlugin<P>
where P: UnsafeUnpin,

§

impl<P> UnwindSafe for ProcessorPlugin<P>
where P: 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.