pub struct Vst3PluginDescriptor {
pub class_id: String,
pub name: String,
pub vendor: String,
pub version: String,
pub buses: Vec<Vst3Bus>,
pub parameters: Vec<Vst3ParamInfo>,
}Expand description
A VST3-shaped plugin descriptor.
Collects the class identity, bus layout, and parameter set of a VST3 export;
to_plugin_descriptor lowers
it into the shared plugin-core PluginDescriptor consumed by the host.
Fields§
§class_id: StringThe VST3 class id identifying the plugin.
name: StringThe plugin display name.
vendor: StringThe vendor name (defaults to sim).
version: StringThe plugin version (defaults to this crate’s package version).
buses: Vec<Vst3Bus>The declared input and output buses.
parameters: Vec<Vst3ParamInfo>The declared parameters.
Implementations§
Source§impl Vst3PluginDescriptor
impl Vst3PluginDescriptor
Sourcepub fn new(class_id: impl Into<String>, name: impl Into<String>) -> Result<Self>
pub fn new(class_id: impl Into<String>, name: impl Into<String>) -> Result<Self>
Builds an empty descriptor with the given class_id and name.
Validates that both are non-empty, sets vendor to sim and version
to this crate’s package version, and starts with no buses or parameters.
Sourcepub fn with_bus(self, bus: Vst3Bus) -> Self
pub fn with_bus(self, bus: Vst3Bus) -> Self
Appends bus to the descriptor and returns it, for builder chaining.
Sourcepub fn with_parameter(self, parameter: Vst3ParamInfo) -> Self
pub fn with_parameter(self, parameter: Vst3ParamInfo) -> Self
Appends parameter to the descriptor and returns it, for builder
chaining.
Sourcepub fn port_decls(&self) -> Vec<PortDecl>
pub fn port_decls(&self) -> Vec<PortDecl>
Lowers every declared bus into a graph PortDecl.
Sourcepub fn to_plugin_descriptor(&self) -> Result<PluginDescriptor>
pub fn to_plugin_descriptor(&self) -> Result<PluginDescriptor>
Lowers this descriptor into a plugin-core PluginDescriptor.
Builds a Vst3-format PluginId from the class id and populates the
resulting descriptor’s ports and parameters from this descriptor’s buses
and parameter set. Returns an error if any conversion fails.
Trait Implementations§
Source§impl Clone for Vst3PluginDescriptor
impl Clone for Vst3PluginDescriptor
Source§fn clone(&self) -> Vst3PluginDescriptor
fn clone(&self) -> Vst3PluginDescriptor
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for Vst3PluginDescriptor
impl Debug for Vst3PluginDescriptor
Source§impl PartialEq for Vst3PluginDescriptor
impl PartialEq for Vst3PluginDescriptor
Source§fn eq(&self, other: &Vst3PluginDescriptor) -> bool
fn eq(&self, other: &Vst3PluginDescriptor) -> bool
self and other values to be equal, and is used by ==.