Skip to main content

Config

Struct Config 

Source
pub struct Config {
Show 14 fields pub name: &'static str, pub category: Category, pub vendor: &'static str, pub url: &'static str, pub email: &'static str, pub version: &'static str, pub has_editor: bool, pub subcategories: &'static [Subcategory], pub manufacturer: FourCharCode, pub subtype: FourCharCode, pub vst3_id: Option<[u32; 4]>, pub vst3_controller_id: Option<[u32; 4]>, pub sysex_slots: usize, pub sysex_buffer_size: usize,
}
Expand description

Unified plugin configuration.

Contains all plugin metadata: shared fields (name, vendor, category), plugin identity (AU four-char codes), and format-specific settings (VST3 component UIDs). The VST3 component UID is derived automatically from the AU codes via FNV-1a hash unless explicitly overridden.

§Example

use beamer_core::{Config, config::Category};

pub static CONFIG: Config = Config::new("My Plugin", Category::Effect, "Mfgr", "plgn")
    .with_vendor("My Company")
    .with_version(env!("CARGO_PKG_VERSION"));

Fields§

§name: &'static str

Plugin name displayed in the DAW.

§category: Category

Plugin category (effect, instrument, etc.)

§vendor: &'static str

Vendor/company name.

§url: &'static str

Vendor URL.

§email: &'static str

Vendor email.

§version: &'static str

Plugin version string.

§has_editor: bool

Whether this plugin has an editor/GUI.

§subcategories: &'static [Subcategory]

Plugin subcategories for more specific classification.

§manufacturer: FourCharCode

Manufacturer code (4-character identifier for your company/brand).

§subtype: FourCharCode

Subtype code (4-character identifier for this specific plugin).

§vst3_id: Option<[u32; 4]>

Explicit VST3 component UID override. When None, the UID is derived from the manufacturer and subtype codes via FNV-1a hash.

§vst3_controller_id: Option<[u32; 4]>

Explicit VST3 controller UID. When None, the plugin uses the combined component pattern (processor + controller in one object).

§sysex_slots: usize

Number of SysEx output slots per process block (AU and VST3).

§sysex_buffer_size: usize

Maximum size of each SysEx message in bytes (AU and VST3).

Implementations§

Source§

impl Config

Source

pub const fn new( name: &'static str, category: Category, manufacturer_code: &str, plugin_code: &str, ) -> Self

Create a new plugin configuration.

§Arguments
  • name - Plugin name displayed in the DAW
  • category - Plugin category (effect, instrument, etc.)
  • manufacturer_code - 4-character manufacturer code (e.g., “Bmer”)
  • plugin_code - 4-character plugin code (e.g., “gain”)
§Panics

Panics at compile time if manufacturer_code or plugin_code are not exactly 4 ASCII characters.

§Example
pub static CONFIG: Config = Config::new("My Plugin", Category::Effect, "Mfgr", "plgn")
    .with_vendor("My Company")
    .with_version(env!("CARGO_PKG_VERSION"));
Source

pub const fn vst3_uid_parts(&self) -> [u32; 4]

Get VST3 component UID as [u32; 4].

Returns the explicit override if set via with_vst3_id(), otherwise derives a UID from the manufacturer and subtype codes via FNV-1a hash.

Source

pub const fn vst3_controller_uid_parts(&self) -> Option<[u32; 4]>

Get VST3 controller UID as [u32; 4], if split component/controller mode is enabled.

Source

pub const fn manufacturer_u32(&self) -> u32

Get the manufacturer code as a u32.

Source

pub const fn subtype_u32(&self) -> u32

Get the subtype code as a u32.

Source

pub fn vst3_subcategories(&self) -> String

Build the VST3 subcategories string.

Combines the main category with subcategories using pipe separators. For example: Category::Effect with [Subcategory::Dynamics] becomes "Fx|Dynamics".

Source

pub fn au_tags(&self) -> Vec<&'static str>

Get AU tags derived from subcategories.

Returns tags for subcategories that have AU equivalents. Subcategories without AU mappings are skipped.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

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.