Trait ParameterStore

Source

pub trait ParameterStore: Send + Sync {
    // Required methods
    fn count(&self) -> usize;
    fn info(&self, index: usize) -> Option<&ParameterInfo>;
    fn get_normalized(&self, id: ParameterId) -> ParameterValue;
    fn set_normalized(&self, id: ParameterId, value: ParameterValue);
    fn normalized_to_string(
        &self,
        id: ParameterId,
        normalized: ParameterValue,
    ) -> String;
    fn string_to_normalized(
        &self,
        id: ParameterId,
        string: &str,
    ) -> Option<ParameterValue>;
    fn normalized_to_plain(
        &self,
        id: ParameterId,
        normalized: ParameterValue,
    ) -> ParameterValue;
    fn plain_to_normalized(
        &self,
        id: ParameterId,
        plain: ParameterValue,
    ) -> ParameterValue;

    // Provided method
    fn info_by_id(&self, id: ParameterId) -> Option<&ParameterInfo> { ... }
}

Expand description

Low-level trait for plugin parameter collections (host interface).

Implement this trait to declare your plugin’s parameters. The format wrappers (VST3, AU, CLAP) use this to communicate parameter information and values to the host.

§Example

use std::sync::atomic::{AtomicU64, Ordering};
use beamer_core::{ParameterStore, ParameterInfo, ParameterId, ParameterValue};

pub struct MyParameters {
    gain: AtomicU64,
    gain_info: ParameterInfo,
}

impl ParameterStore for MyParameters {
    fn count(&self) -> usize { 1 }

    fn info(&self, index: usize) -> Option<&ParameterInfo> {
        match index {
            0 => Some(&self.gain_info),
            _ => None,
        }
    }

    fn get_normalized(&self, id: ParameterId) -> ParameterValue {
        match id {
            0 => f64::from_bits(self.gain.load(Ordering::Relaxed)),
            _ => 0.0,
        }
    }

    fn set_normalized(&self, id: ParameterId, value: ParameterValue) {
        match id {
            0 => self.gain.store(value.to_bits(), Ordering::Relaxed),
            _ => {}
        }
    }

    // ... implement other methods
}