@audiotool/nexus - v0.0.12
    Preparing search index...

    Type Alias Helmholtz

    key value
    type entity
    key "helmholtz"
    is

    The Helmholtz is a device that has up to 5 short delay lines that can be tuned to make certain frequencies resonate, resulting in something akin to a comb filter, i.e. a filter that filters out frequencies that are multiples of a certain frequency.

    The filter frequencies can be set to specific notes such as C4, D3, etc.

    Because it's implemented with delay lines, the Helmholtz sounds like it's "resonating" and highlighting certain frequencies and their overtones, and the resonance frequencies will sound after the incoming signal has become quiet.

    type Helmholtz = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        decayTime: PrimitiveField<number, "mut">;
        displayName: PrimitiveField<string, "mut">;
        filters: ArrayField<NexusObject<HelmholtzFilter>, 5>;
        gain: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        microTuning: PrimitiveField<NexusLocation, "mut">;
        mix: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    audioInput: NexusObject<Empty>

    Audio input.

    key value
    is api.TargetType.AudioInput
    audioOutput: NexusObject<Empty>

    Audio output.

    key value
    is api.TargetType.AudioOutput
    decayTime: PrimitiveField<number, "mut">

    The decay time of the delay lines. Increasing this value will make the Helmholtz resonate for longer and louder after the incoming signal has become quiet. No unit.

    key value
    default 0.75
    range [0, 1]
    is api.TargetType.AutomatableParameter
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    The 5 filters/delay lines of the Helmholtz.

    gain: PrimitiveField<number, "mut">

    This device's output gain. Equivalent to a dB range of [-inf, 0.0].

    key value
    default 0.7079399824142456
    range [0, 1]
    is api.TargetType.AutomatableParameter
    isActive: PrimitiveField<boolean, "mut">

    Whether the device is active or not. When is_active=false, audio signal bypasses the device.

    key value
    default true
    is api.TargetType.AutomatableParameter
    microTuning: PrimitiveField<NexusLocation, "mut">

    Reference to the microtuning.

    key value
    default empty location
    required false
    targets api.TargetType.MicroTuning, meaning one of:
    entities.MicroTuningOctave
    mix: PrimitiveField<number, "mut">

    Controls the mix between the incoming and the effect signal. 0 ("dry") means 0% effect applied, 1 ("wet") means 100% effect applied; values between mixes the two linearly.

    key value
    default 1
    range [0, 1]
    is api.TargetType.AutomatableParameter
    positionX: PrimitiveField<number, "mut">

    X position on the desktop in the DAW.

    key value
    default 0
    range full
    positionY: PrimitiveField<number, "mut">

    Y position on the desktop in the DAW.

    key value
    default 0
    range full