Struct ParamInfo 

pub struct ParamInfo {
    pub id: ParamId,
    pub name: &'static str,
    pub short_name: &'static str,
    pub units: &'static str,
    pub default_normalized: ParamValue,
    pub step_count: i32,
    pub flags: ParamFlags,
    pub unit_id: UnitId,
}

Metadata describing a single parameter.

Fields

id: ParamId

Unique parameter identifier.

name: &'static str

Full parameter name (e.g., “Master Volume”).

short_name: &'static str

Short parameter name for constrained UIs (e.g., “Vol”).

units: &'static str

Unit label (e.g., “dB”, “%”, “Hz”).

default_normalized: ParamValue

Default value in normalized form (0.0 to 1.0).

step_count: i32

Number of discrete steps. 0 = continuous, 1 = toggle, >1 = discrete.

flags: ParamFlags

Behavioral flags.

unit_id: UnitId

VST3 Unit ID (parameter group). ROOT_UNIT_ID (0) for ungrouped parameters.

Implementations

impl ParamInfo

pub const fn new(id: ParamId, name: &'static str) -> Self

Create a new continuous parameter with default flags.

pub const fn with_short_name(self, short_name: &'static str) -> Self

Set the short name.

pub const fn with_units(self, units: &'static str) -> Self

Set the unit label.

pub const fn with_default(self, default: ParamValue) -> Self

Set the default normalized value.

pub const fn with_steps(self, steps: i32) -> Self

Set the step count (0 = continuous).

pub const fn with_flags(self, flags: ParamFlags) -> Self

Set parameter flags.

pub const fn bypass(id: ParamId) -> Self

Create a bypass toggle parameter with standard configuration.

This creates a parameter pre-configured as a bypass switch:

• Toggle (step_count = 1)
• Automatable
• Marked with is_bypass = true flag
• Default value = 0.0 (not bypassed)

Example

const PARAM_BYPASS: u32 = 0;

struct MyParams {
    bypass: AtomicU64,
    bypass_info: ParamInfo,
}

impl MyParams {
    fn new() -> Self {
        Self {
            bypass: AtomicU64::new(0.0f64.to_bits()),
            bypass_info: ParamInfo::bypass(PARAM_BYPASS),
        }
    }
}

pub const fn with_unit(self, unit_id: UnitId) -> Self

Set the unit ID (parameter group).

Trait Implementations

impl Clone for ParamInfo

fn clone(&self) -> ParamInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamInfo

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

Formats the value using the given formatter.