conformal_component

Trait Component

Source
pub trait Component {
    type Processor;

    // Required method
    fn create_processor(
        &self,
        environment: &ProcessingEnvironment,
    ) -> Self::Processor;

    // Provided method
    fn parameter_infos(&self) -> Vec<Info> { ... }
}
Expand description

The main plug-in abstraction in Conformal.

Components can be wrapped in various plug-in formats for use in audio software.

Components contain information about the parameters of a processor as well as the ability to create a processor.

Note that this is not intended to be used as an internal interface for audio processors, but rather an external one that can be easily wrapped in common plug-in formats. That is to say, a plug-in should only have one Component that represents the whole plug-in - to compose parts of the plug-in you should use a different abstraction.

Required Associated Types§

Source

type Processor

The processor that this component creates.

Required Methods§

Source

fn create_processor( &self, environment: &ProcessingEnvironment, ) -> Self::Processor

Create the processor that will actually process audio.

Note any state needed to process audio should be allocated here.

Provided Methods§

Source

fn parameter_infos(&self) -> Vec<Info>

Get information about the parameters of this component

This must return the same value every time it is called.

Implementors§