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

    Interface IFloatParameterConfig

    Describes the properties by which a float-based parameter can be configured.

    interface IFloatParameterConfig {
        defaultValue: number;
        fractionDigits?: number;
        id: string;
        interval?: number;
        max: number;
        midpoint?: number;
        min: number;
        name: string;
        scale?: Scale;
        type: Float;
        unit?: string;
    }

    Hierarchy

    • IBaseParameterConfig
      • IFloatParameterConfig
    Index

    Properties

    defaultValue fractionDigits? id interval? max midpoint? min name scale? type unit?

    Properties

    defaultValue: number

    The default (scaled) value for this parameter.

    fractionDigits?: number

    The degree of precision to use to when displaying this parameter's value(s).

    id: string

    The identifier associated with this parameter. This MUST be one of the plugin's defined parameter IDs in the C++ backend.

    interval?: number

    An optional value indicating the amount by which this parameter will snap to values within its specified range.

    max: number

    The maximum (scaled) value that this parameter can be.

    midpoint?: number

    An optional (scaled) value that indicates what value should be displayed when the slider is in its 12 o'clock position. Internally, this is adjusting the skew such that a normalized value of 0.5 will return this display value.

    min: number

    The minimum (scaled) value that this parameter can be.

    name: string

    The display name of the parameter as it will appear to the user both in the plugin's user interface and the native Ableton interface.

    scale?: Scale

    An optional scale that defines what mathematical curve is used when mapping values.

    type: Float

    The specific type definition for this parameter.

    unit?: string

    An optional string representing the unit of measurement of this parameter's values.

    Settings

    Member Visibility

    On This Page

    Properties