@bbx-audio/nectar
    Preparing search index...

    Interface IFloatParameter

    Describes a float-based parameter object, containing a normalized value for internal calculations and a display value for showing the value to the user in a human-readable way.

    interface IFloatParameter {
        config: IFloatParameterConfig;
        displayValue: number;
        normalizedDefaultValue: number;
        normalizedValue: number;
        type: Float;
        displayToJuceNormalized(displayValue: number): number;
        displayToNormalized(displayValue: number): number;
        getValue(): number;
        resetValue(source?: ParameterChangeSource): void;
        setDisplayValue(value: number, source?: ParameterChangeSource): void;
        setNormalizedValue(
            value: number,
            shouldNotify: boolean,
            source?: ParameterChangeSource,
        ): void;
        setValue(value: number, source?: ParameterChangeSource): void;
        subscribe(listener: ParameterListener<number>): () => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    config displayValue normalizedDefaultValue normalizedValue type

    Methods

    displayToJuceNormalized displayToNormalized getValue resetValue setDisplayValue setNormalizedValue setValue subscribe

    Properties

    config: IFloatParameterConfig

    The particular configuration of this parameter.

    displayValue: number

    The internal state of this parameter represented as a display value.

    normalizedDefaultValue: number

    The default value of this parameter represented as a normalized value.

    normalizedValue: number

    The internal state of this parameter represented as a normalized value.

    type: Float

    The particular parameter type of this parameter.

    Methods

    • Converts a display value to a normalized value as expected by JUCE in the backend.

      Parameters

      • displayValue: number

      Returns number

    • Converts a display value to a normalized value.

      Parameters

      • displayValue: number

      Returns number

    Settings

    Member Visibility

    On This Page

    Properties
    Methods