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

    Type Alias SpitfireLabsVst3Plugin

    key value
    type entity
    key "spitfireLabsVst3Plugin"
    is api.TargetType.NoteTrackPlayer

    Data structure representing the Spitfire VST plugin. This plugin only runs when connected to the booster.

    All automatable parameters are added below as float values. However, they're set to immutable, because the plugin state is not actually synced through these parameters; they only exist to be able to connect automation tracks.

    The plugin state is instead synced through the state field below, containing an opaque binary blob. Note that the engine on its own doesn't read the state field, it has to be passed in manually (this is automatically managed in the DAW)

    type SpitfireLabsVst3Plugin = {
        adsrAttack: PrimitiveField<number, "immut">;
        adsrDecay: PrimitiveField<number, "immut">;
        adsrRelease: PrimitiveField<number, "immut">;
        adsrSustain: PrimitiveField<number, "immut">;
        amount: PrimitiveField<number, "immut">;
        audioOutput: NexusObject<Empty>;
        compression: PrimitiveField<number, "immut">;
        delay: PrimitiveField<number, "immut">;
        depth: PrimitiveField<number, "immut">;
        direction: PrimitiveField<number, "immut">;
        displayName: PrimitiveField<string, "mut">;
        distortion: PrimitiveField<number, "immut">;
        dynamics: PrimitiveField<number, "immut">;
        expression: PrimitiveField<number, "immut">;
        generalPurpose1: PrimitiveField<number, "immut">;
        generalPurpose2: PrimitiveField<number, "immut">;
        generalPurpose3: PrimitiveField<number, "immut">;
        generalPurpose4: PrimitiveField<number, "immut">;
        generalPurpose5: PrimitiveField<number, "immut">;
        generalPurpose6: PrimitiveField<number, "immut">;
        generalPurpose7: PrimitiveField<number, "immut">;
        generalPurpose8: PrimitiveField<number, "immut">;
        generalPurpose9: PrimitiveField<number, "immut">;
        globalGain: PrimitiveField<number, "immut">;
        globalPan: PrimitiveField<number, "immut">;
        globalTune: PrimitiveField<number, "immut">;
        grainSpeed: PrimitiveField<number, "immut">;
        length: PrimitiveField<number, "immut">;
        lowPassFilter: PrimitiveField<number, "immut">;
        lushVerb: PrimitiveField<number, "immut">;
        mallet: PrimitiveField<number, "immut">;
        noiseFx: PrimitiveField<number, "immut">;
        notesInput: NexusObject<Empty>;
        pedalDyn: PrimitiveField<number, "immut">;
        pedalVol: PrimitiveField<number, "immut">;
        portamento: PrimitiveField<number, "immut">;
        positionX: PrimitiveField<number, "mut">;
        positionY: PrimitiveField<number, "mut">;
        release: PrimitiveField<number, "immut">;
        response: PrimitiveField<number, "immut">;
        reverb: PrimitiveField<number, "immut">;
        scale: PrimitiveField<number, "immut">;
        simpleMix: PrimitiveField<number, "immut">;
        softPedal: PrimitiveField<number, "immut">;
        speed: PrimitiveField<number, "immut">;
        state: PrimitiveField<boolean, "mut">;
        stereoFlip: PrimitiveField<number, "immut">;
        stereoPan: PrimitiveField<number, "immut">;
        stereoSpread: PrimitiveField<number, "immut">;
        stopMute: PrimitiveField<number, "immut">;
        stretch: PrimitiveField<number, "immut">;
        tightness: PrimitiveField<number, "immut">;
        timeMachine: PrimitiveField<number, "immut">;
        variation: PrimitiveField<number, "immut">;
        vibrato: PrimitiveField<number, "immut">;
    }
    Index

    Properties

    adsrAttack adsrDecay adsrRelease adsrSustain amount audioOutput compression delay depth direction displayName distortion dynamics expression generalPurpose1 generalPurpose2 generalPurpose3 generalPurpose4 generalPurpose5 generalPurpose6 generalPurpose7 generalPurpose8 generalPurpose9 globalGain globalPan globalTune grainSpeed length lowPassFilter lushVerb mallet noiseFx notesInput pedalDyn pedalVol portamento positionX positionY release response reverb scale simpleMix softPedal speed state stereoFlip stereoPan stereoSpread stopMute stretch tightness timeMachine variation vibrato

    Properties

    adsrAttack: PrimitiveField<number, "immut">

    spitfire labs parameter 1869222698

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    adsrDecay: PrimitiveField<number, "immut">

    spitfire labs parameter 1869225099

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    adsrRelease: PrimitiveField<number, "immut">

    spitfire labs parameter 1869238562

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    adsrSustain: PrimitiveField<number, "immut">

    spitfire labs parameter 1869240026

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    amount: PrimitiveField<number, "immut">

    spitfire labs parameter 1753593070

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    audioOutput: NexusObject<Empty>

    Audio Output

    key value
    is api.TargetType.AudioOutput
    compression: PrimitiveField<number, "immut">

    spitfire labs parameter 1077613272

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    delay: PrimitiveField<number, "immut">

    spitfire labs parameter 1513843245

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    depth: PrimitiveField<number, "immut">

    spitfire labs parameter 1456563165

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    direction: PrimitiveField<number, "immut">

    spitfire labs parameter 2142130985

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

    The user-assigned name of this device.

    distortion: PrimitiveField<number, "immut">

    spitfire labs parameter 1078470069

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    dynamics: PrimitiveField<number, "immut">

    spitfire labs parameter 20

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    expression: PrimitiveField<number, "immut">

    spitfire labs parameter 10

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    generalPurpose1: PrimitiveField<number, "immut">

    spitfire labs parameter 481116022

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    generalPurpose2: PrimitiveField<number, "immut">

    spitfire labs parameter 481116053

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    generalPurpose3: PrimitiveField<number, "immut">

    spitfire labs parameter 481116735

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    generalPurpose4: PrimitiveField<number, "immut">

    spitfire labs parameter 481116766

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    generalPurpose5: PrimitiveField<number, "immut">

    spitfire labs parameter 481116797

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    generalPurpose6: PrimitiveField<number, "immut">

    spitfire labs parameter 481116828

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    generalPurpose7: PrimitiveField<number, "immut">

    spitfire labs parameter 481116859

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    generalPurpose8: PrimitiveField<number, "immut">

    spitfire labs parameter 481116890

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    generalPurpose9: PrimitiveField<number, "immut">

    spitfire labs parameter 481116921

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    globalGain: PrimitiveField<number, "immut">

    spitfire labs parameter 892218455

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    globalPan: PrimitiveField<number, "immut">

    spitfire labs parameter 98063557

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    globalTune: PrimitiveField<number, "immut">

    spitfire labs parameter 892625104

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    grainSpeed: PrimitiveField<number, "immut">

    spitfire labs parameter 481116952

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    length: PrimitiveField<number, "immut">

    spitfire labs parameter 2061082492

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    lowPassFilter: PrimitiveField<number, "immut">

    spitfire labs parameter 749414706

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    lushVerb: PrimitiveField<number, "immut">

    spitfire labs parameter 31201011

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    mallet: PrimitiveField<number, "immut">

    spitfire labs parameter 2085962329

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    noiseFx: PrimitiveField<number, "immut">

    spitfire labs parameter 2119488876

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    notesInput: NexusObject<Empty>

    Notes Input

    key value
    is api.TargetType.NotesInput
    pedalDyn: PrimitiveField<number, "immut">

    spitfire labs parameter 27784064

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    pedalVol: PrimitiveField<number, "immut">

    spitfire labs parameter 27831802

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    portamento: PrimitiveField<number, "immut">

    spitfire labs parameter 2027374695

    key value
    default 0
    range [0, 1]
    immutable 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
    release: PrimitiveField<number, "immut">

    spitfire labs parameter 40

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    response: PrimitiveField<number, "immut">

    spitfire labs parameter 591113047

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    reverb: PrimitiveField<number, "immut">

    spitfire labs parameter 30

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    scale: PrimitiveField<number, "immut">

    spitfire labs parameter 1527626228

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    simpleMix: PrimitiveField<number, "immut">

    spitfire labs parameter 70

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    softPedal: PrimitiveField<number, "immut">

    spitfire labs parameter 1018373914

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    speed: PrimitiveField<number, "immut">

    spitfire labs parameter 1528017137

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

    The Spitifire Labs VST state, with opaque content only understandable by the plugin. Contains all parameters also part of this message, which is why those are marked as immutable.

    If the state cannot be read by the Spitfire LABS plugin, this will keep working with existing values. The DAW will likely overwrite it soon with valid values.

    If the state contains a sample pack that the user doesn't have installed, the user won't hear any sound (the plugin UI shows some error), otherwise it will continue working as expected.

    stereoFlip: PrimitiveField<number, "immut">

    spitfire labs parameter 1235749049

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    stereoPan: PrimitiveField<number, "immut">

    spitfire labs parameter 80

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    stereoSpread: PrimitiveField<number, "immut">

    spitfire labs parameter 1816604410

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    stopMute: PrimitiveField<number, "immut">

    spitfire labs parameter 444268806

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    stretch: PrimitiveField<number, "immut">

    spitfire labs parameter 1819677999

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    tightness: PrimitiveField<number, "immut">

    spitfire labs parameter 50

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    timeMachine: PrimitiveField<number, "immut">

    spitfire labs parameter 164512228

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    variation: PrimitiveField<number, "immut">

    spitfire labs parameter 875294141

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter
    vibrato: PrimitiveField<number, "immut">

    spitfire labs parameter 60

    key value
    default 0
    range [0, 1]
    immutable true
    is api.TargetType.AutomatableParameter

    Settings

    Member Visibility

    On This Page

    Properties