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

    Type Alias Exciter

    key value
    type entity
    key "exciter"
    is

    The exciter device. Enriches the signal by adding a harmonic content to the signal.

    It does so by adding distortion to the higher frequencies above a certain threshold.

    type Exciter = {
        audioInput: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        displayName: PrimitiveField<string, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        mix: PrimitiveField<number, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        powerFactor: PrimitiveField<number, "mut">;
        toneFrequencyHz: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    audioInput audioOutput displayName isActive mix positionX positionY powerFactor toneFrequencyHz

    Properties

    audioInput: NexusObject<Empty>

    Audio Input

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

    Audio Output

    key value
    is api.TargetType.AudioOutput
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this device.

    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
    mix: PrimitiveField<number, "mut">

    Controls the mix between the incoming and the distorted signal. 0 ("dry") means 0% distortion applied, 1 ("wet") means 100% distortion 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
    powerFactor: PrimitiveField<number, "mut">

    The "power" factor controls how much distortion is added to the signal above the tone frequency.

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

    The "tone" frequency is the frequency above which the exciter will add distortion to the signal.

    key value
    default 3500
    range [20, 13000]
    is api.TargetType.AutomatableParameter

    Settings

    Member Visibility

    On This Page

    Properties