Struct PluginDescriptor 

pub struct PluginDescriptor {
    pub id: PluginId,
    pub name: String,
    pub vendor: String,
    pub version: String,
    pub ports: Vec<PortDecl>,
    pub parameters: Vec<ParameterDescriptor>,
    pub latency_frames: u32,
}

A plugin’s full static description: identity, metadata, ports, parameters, and reported latency.

Fields

id: PluginId

The plugin’s stable identity.

name: String

The human-readable plugin name.

vendor: String

The vendor string.

version: String

The version string.

ports: Vec<PortDecl>

The plugin’s declared audio and event ports.

parameters: Vec<ParameterDescriptor>

The plugin’s automatable parameters.

latency_frames: u32

The reported processing latency in frames.

Implementations

impl PluginDescriptor

pub fn new( id: PluginId, name: impl Into<String>, vendor: impl Into<String>, version: impl Into<String>, ) -> Result<Self>

Builds a descriptor with no ports, no parameters, and zero latency.

Errors

Returns an error when name is empty after trimming.

pub fn audio_effect( format: PluginFormat, stable_id: impl Into<String>, name: impl Into<String>, channels: u16, ) -> Result<Self>

Builds a stereo-capable audio-effect descriptor with the standard port layout.

Adds channels-wide audio-in/audio-out ports plus single-channel events-in/events-out ports, and sets the vendor to "sim" and the version to this crate’s package version.

Errors

Returns an error when stable_id or name is empty after trimming.

pub fn with_parameter(self, parameter: ParameterDescriptor) -> Self

Returns the descriptor with parameter appended to its parameter list.

pub fn parameter(&self, id: u32) -> Option<&ParameterDescriptor>

Returns the parameter whose ParameterDescriptor::id matches id, if any.

Trait Implementations

impl Clone for PluginDescriptor

fn clone(&self) -> PluginDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginDescriptor

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

Formats the value using the given formatter.

impl PartialEq for PluginDescriptor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PluginDescriptor