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

    Type Alias RingModulator

    key value
    type entity
    key "ringModulator"
    is

    The ring modulator multiplies two audio signals together.

    type RingModulator = {
        audioInput1: NexusObject<Empty>;
        audioInput2: NexusObject<Empty>;
        audioOutput: NexusObject<Empty>;
        displayName: PrimitiveField<string, "mut">;
        gain: PrimitiveField<number, "mut">;
        isActive: PrimitiveField<boolean, "mut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    audioInput1: NexusObject<Empty>

    First Audio Input.

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

    Second 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.

    gain: PrimitiveField<number, "mut">

    Gain applied to the signal. Equivalent to a dB range of [-inf, 18.0]. In the DAW UI called "boost".

    key value
    default 1
    range [0, 7.943282127380371]
    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
    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