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

    Type Alias StompboxFlanger

    key value
    type entity
    key "stompboxFlanger"
    is

    A flanger effect in the form of a stompbox.

    type StompboxFlanger = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        delayTimeMs: PrimitiveField<number, "mut">;
        displayName: PrimitiveField<string, "mut">;
        feedbackFactor: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        lfoFrequencyHz: PrimitiveField<number, "mut">;
        lfoModulationDepth: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    audioInput audioOutput delayTimeMs displayName feedbackFactor isActive lfoFrequencyHz lfoModulationDepth positionX positionY

    Properties

    audioInput: NexusObject<Empty>

    Single Input.

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

    Single Output.

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

    Allows control of the Flanger's short delay.

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

    The user-assigned name of this device.

    feedbackFactor: PrimitiveField<number, "mut">

    Allows control over how much of the processed signal is feed back into the effect.

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

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

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

    The frequency of the LFO modulation.

    key value
    default 0.03999999910593033
    range [0.03999999910593033, 5]
    is api.TargetType.AutomatableParameter
    lfoModulationDepth: PrimitiveField<number, "mut">

    The amount the LFO influences the delay_time_ms parameter.

    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

    Settings

    Member Visibility

    On This Page

    Properties