Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Readonly automation

automation: Automation = {}

isSynth

isSynth: boolean = false

Is this plugin a synth or an effect (does it accept midi input)?

Readonly makeAutomation

makeAutomation: { analyserMode: any; band1FrequencyHz: any; band1GainDb: any; band1Q: any; band1Shape: any; band1State: any; band2FrequencyHz: any; band2GainDb: any; band2Q: any; band2Shape: any; band2State: any; band3FrequencyHz: any; band3GainDb: any; band3Q: any; band3Shape: any; band3State: any; band4FrequencyHz: any; band4GainDb: any; band4Q: any; band4Shape: any; band4State: any; band5FrequencyHz: any; band5GainDb: any; band5Q: any; band5Shape: any; band5State: any; band6FrequencyHz: any; band6GainDb: any; band6Q: any; band6Shape: any; band6State: any; band7FrequencyHz: any; band7GainDb: any; band7Q: any; band7Shape: any; band7State: any; band8FrequencyHz: any; band8GainDb: any; band8Q: any; band8Shape: any; band8State: any; enable: any; outputGainDb: any; soloBand: any; soloGainDb: any } = ...

Type declaration

numAudioInputChannels

numAudioInputChannels: number = 2

numAudioOutputChannels

numAudioOutputChannels: number = 2

Readonly parameterLibrary

parameterLibrary: { analyserMode: { choices: { 0: number; 1: number; 2: number; 3: number }; index: number; isLinear: boolean; name: string }; band1FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band1GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band1Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band1Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band1State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band2FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band2GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band2Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band2Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band2State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band3FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band3GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band3Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band3Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band3State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band4FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band4GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band4Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band4Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band4State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band5FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band5GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band5Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band5Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band5State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band6FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band6GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band6Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band6Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band6State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band7FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band7GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band7Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band7Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band7State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band8FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band8GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band8Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band8Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band8State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; enable: { choices: { 0: number; 1: number }; index: number; isLinear: boolean; name: string }; outputGainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; soloBand: { choices: { -1: number; 0: number; 1: number; 2: number; 3: number; 4: number; 5: number; 6: number; 7: number; 8: number }; index: number; isLinear: boolean; name: string }; soloGainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string } } = ...

Type declaration

  • analyserMode: { choices: { 0: number; 1: number; 2: number; 3: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number; 3: number }
      • 0: number
      • 1: number
      • 2: number
      • 3: number
    • index: number
    • isLinear: boolean
    • name: string
  • band1FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band1GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band1Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band1Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band1State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band2FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band2GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band2Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band2Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band2State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band3FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band3GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band3Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band3Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band3State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band4FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band4GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band4Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band4Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band4State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band5FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band5GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band5Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band5Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band5State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band6FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band6GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band6Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band6Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band6State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band7FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band7GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band7Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band7Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band7State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band8FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band8GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band8Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band8Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band8State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • enable: { choices: { 0: number; 1: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number }
      • 0: number
      • 1: number
    • index: number
    • isLinear: boolean
    • name: string
  • outputGainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • soloBand: { choices: { -1: number; 0: number; 1: number; 2: number; 3: number; 4: number; 5: number; 6: number; 7: number; 8: number }; index: number; isLinear: boolean; name: string }
    • choices: { -1: number; 0: number; 1: number; 2: number; 3: number; 4: number; 5: number; 6: number; 7: number; 8: number }
      • -1: number
      • 0: number
      • 1: number
      • 2: number
      • 3: number
      • 4: number
      • 5: number
      • 6: number
      • 7: number
      • 8: number
    • index: number
    • isLinear: boolean
    • name: string
  • soloGainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string

parameters

parameters: TEqualizerVst2Parameters = {}

Readonly pluginName

pluginName: string

Readonly pluginType

pluginType: PluginType

Optional sidechainReceive

sidechainReceive: FluidReceive

Optional unresolvedSidechainReceive

unresolvedSidechainReceive: UnresolvedReceive

vst2

vst2: { presetBase64?: string; uid?: number; vendor?: string } = {}

VST2 plugins may specify a some additional parameters in this property. It will be empty for non-vst2 plugins.

Type declaration

  • Optional presetBase64?: string

    A .fxp vst2 preset preset file, base64 encoded. This is the initial state of the plugin will be applied before any additional configuration specified within the plugin's FluidPlugin.parameters property.

  • Optional uid?: number

    The 32-bit plugin VST2 plugin UID (if known)

  • Optional vendor?: string

    VST2 plugins report a vendor name

Static Readonly PluginType

PluginType: typeof PluginType = ...

Static Readonly makeAutomation

makeAutomation: { analyserMode: any; band1FrequencyHz: any; band1GainDb: any; band1Q: any; band1Shape: any; band1State: any; band2FrequencyHz: any; band2GainDb: any; band2Q: any; band2Shape: any; band2State: any; band3FrequencyHz: any; band3GainDb: any; band3Q: any; band3Shape: any; band3State: any; band4FrequencyHz: any; band4GainDb: any; band4Q: any; band4Shape: any; band4State: any; band5FrequencyHz: any; band5GainDb: any; band5Q: any; band5Shape: any; band5State: any; band6FrequencyHz: any; band6GainDb: any; band6Q: any; band6Shape: any; band6State: any; band7FrequencyHz: any; band7GainDb: any; band7Q: any; band7Shape: any; band7State: any; band8FrequencyHz: any; band8GainDb: any; band8Q: any; band8Shape: any; band8State: any; enable: any; outputGainDb: any; soloBand: any; soloGainDb: any } = ...

Type declaration

Static Readonly parameterLibrary

parameterLibrary: { analyserMode: { choices: { 0: number; 1: number; 2: number; 3: number }; index: number; isLinear: boolean; name: string }; band1FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band1GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band1Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band1Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band1State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band2FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band2GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band2Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band2Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band2State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band3FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band3GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band3Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band3Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band3State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band4FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band4GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band4Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band4Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band4State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band5FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band5GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band5Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band5Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band5State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band6FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band6GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band6Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band6Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band6State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band7FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band7GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band7Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band7Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band7State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; band8FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }; band8GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; band8Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }; band8Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }; band8State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }; enable: { choices: { 0: number; 1: number }; index: number; isLinear: boolean; name: string }; outputGainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }; soloBand: { choices: { -1: number; 0: number; 1: number; 2: number; 3: number; 4: number; 5: number; 6: number; 7: number; 8: number }; index: number; isLinear: boolean; name: string }; soloGainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string } } = ...

Type declaration

  • analyserMode: { choices: { 0: number; 1: number; 2: number; 3: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number; 3: number }
      • 0: number
      • 1: number
      • 2: number
      • 3: number
    • index: number
    • isLinear: boolean
    • name: string
  • band1FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band1GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band1Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band1Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band1State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band2FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band2GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band2Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band2Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band2State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band3FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band3GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band3Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band3Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band3State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band4FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band4GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band4Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band4Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band4State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band5FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band5GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band5Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band5Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band5State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band6FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band6GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band6Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band6Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band6State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band7FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band7GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band7Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band7Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band7State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • band8FrequencyHz: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
    • units: string
  • band8GainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • band8Q: { index: number; isLinear: boolean; name: string; powerFuncB: number; range: [number, number] }
    • index: number
    • isLinear: boolean
    • name: string
    • powerFuncB: number
    • range: [number, number]
  • band8Shape: { choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }; index: number; isLinear: boolean; name: string }
    • choices: { bandPass: number; bandStop: number; highPass: number; highShelf: number; lowPass: number; lowShelf: number; peakNotch: number }
      • bandPass: number
      • bandStop: number
      • highPass: number
      • highShelf: number
      • lowPass: number
      • lowShelf: number
      • peakNotch: number
    • index: number
    • isLinear: boolean
    • name: string
  • band8State: { choices: { 0: number; 1: number; 2: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number; 2: number }
      • 0: number
      • 1: number
      • 2: number
    • index: number
    • isLinear: boolean
    • name: string
  • enable: { choices: { 0: number; 1: number }; index: number; isLinear: boolean; name: string }
    • choices: { 0: number; 1: number }
      • 0: number
      • 1: number
    • index: number
    • isLinear: boolean
    • name: string
  • outputGainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string
  • soloBand: { choices: { -1: number; 0: number; 1: number; 2: number; 3: number; 4: number; 5: number; 6: number; 7: number; 8: number }; index: number; isLinear: boolean; name: string }
    • choices: { -1: number; 0: number; 1: number; 2: number; 3: number; 4: number; 5: number; 6: number; 7: number; 8: number }
      • -1: number
      • 0: number
      • 1: number
      • 2: number
      • 3: number
      • 4: number
      • 5: number
      • 6: number
      • 7: number
      • 8: number
    • index: number
    • isLinear: boolean
    • name: string
  • soloGainDb: { index: number; isLinear: boolean; name: string; range: [number, number]; units: string }
    • index: number
    • isLinear: boolean
    • name: string
    • range: [number, number]
    • units: string

Methods

getAutomationLane

getNormalizedValue

  • getNormalizedValue(paramKey: string, value: number): null | number
  • If paramKey identifies a plugin parameter, and that parameter has a normalizer, return the normalized value. Otherwise return null.

    Parameters

    • paramKey: string
    • value: number

    Returns null | number

getParameterIndex

  • getParameterIndex(paramKey: string): null | number
  • VST2 parameters can also be identified by an index. This method returns the index, or returns null if the index is not available.

    Parameters

    • paramKey: string

      the JavaScript friendly parameter identifier

    Returns null | number

getParameterName

  • getParameterName(paramKey: string): string
  • fluid-music has two ways of identifying a parameter with a string:

    1. The javascript friendly "key" (ex: lfo1Speed)
    2. JUCE's parameter name (ex: LFO 1: Speed)

    This function attempts to get JUCE's name from the key. If the key is not registered on the plugin, just return the key argument directly. This behavior is designed to make it possible to use and configure plugins with the FluidPlugin base class even when there is no adapter available.

    When there is no adapter available, you can just set a parameter directly: `pluginInstance.parameters["Wet Level"] = 0.8;

    Parameters

    • paramKey: string

      the JavaScript friendly parameter identifier

    Returns string

setBand1

  • setBand1(hz?: number, gain?: number, q?: number, active?: boolean): void
  • Configure EQ band 1 frequency, gain, and Q

    Parameters

    • Optional hz: number

      frequency in hertz (10 to 30000)

    • Optional gain: number

      band gain in dB (-30 to 30, 0 is unity gain)

    • Optional q: number

      band width (0.025 to 40, higher is narrower)

    • active: boolean = true

    Returns void

setBand2

  • setBand2(hz?: number, gain?: number, q?: number, active?: boolean): void
  • Configure EQ band 2 frequency, gain, and Q

    Parameters

    • Optional hz: number

      frequency in hertz (10 to 30000)

    • Optional gain: number

      band gain in dB (-30 to 30, 0 is unity gain)

    • Optional q: number

      band width (0.025 to 40, higher is narrower)

    • active: boolean = true

    Returns void

setBand3

  • setBand3(hz?: number, gain?: number, q?: number, active?: boolean): void
  • Configure EQ band 3 frequency, gain, and Q

    Parameters

    • Optional hz: number

      frequency in hertz (10 to 30000)

    • Optional gain: number

      band gain in dB (-30 to 30, 0 is unity gain)

    • Optional q: number

      band width (0.025 to 40, higher is narrower)

    • active: boolean = true

    Returns void

setBand4

  • setBand4(hz?: number, gain?: number, q?: number, active?: boolean): void
  • Configure EQ band 4 frequency, gain, and Q

    Parameters

    • Optional hz: number

      frequency in hertz (10 to 30000)

    • Optional gain: number

      band gain in dB (-30 to 30, 0 is unity gain)

    • Optional q: number

      band width (0.025 to 40, higher is narrower)

    • active: boolean = true

    Returns void

setBand5

  • setBand5(hz?: number, gain?: number, q?: number, active?: boolean): void
  • Configure EQ band 5 frequency, gain, and Q

    Parameters

    • Optional hz: number

      frequency in hertz (10 to 30000)

    • Optional gain: number

      band gain in dB (-30 to 30, 0 is unity gain)

    • Optional q: number

      band width (0.025 to 40, higher is narrower)

    • active: boolean = true

    Returns void

setBand6

  • setBand6(hz?: number, gain?: number, q?: number, active?: boolean): void
  • Configure EQ band 6 frequency, gain, and Q

    Parameters

    • Optional hz: number

      frequency in hertz (10 to 30000)

    • Optional gain: number

      band gain in dB (-30 to 30, 0 is unity gain)

    • Optional q: number

      band width (0.025 to 40, higher is narrower)

    • active: boolean = true

    Returns void

setBand7

  • setBand7(hz?: number, gain?: number, q?: number, active?: boolean): void
  • Configure EQ band 7 frequency, gain, and Q

    Parameters

    • Optional hz: number

      frequency in hertz (10 to 30000)

    • Optional gain: number

      band gain in dB (-30 to 30, 0 is unity gain)

    • Optional q: number

      band width (0.025 to 40, higher is narrower)

    • active: boolean = true

    Returns void

setBand8

  • setBand8(hz?: number, gain?: number, q?: number, active?: boolean): void
  • Configure EQ band 8 frequency, gain, and Q

    Parameters

    • Optional hz: number

      frequency in hertz (10 to 30000)

    • Optional gain: number

      band gain in dB (-30 to 30, 0 is unity gain)

    • Optional q: number

      band width (0.025 to 40, higher is narrower)

    • active: boolean = true

    Returns void

sidechainWith

  • Specify a sidechain input to the plugin.

    If the first argument is a name string (not a Track Object), the sidechain routing will be unresolved. To resolve the routing, insert the plugin into a track, and call .resolveSidechainReceives on the parent session.

    sidechainWith returns the plugin itself, so you can setup a sidechain compressor like this:

    const session = new FluidSession({}, [
     { name: 'kick' },
     { name: 'bass', plugins: [compressor.sidechainFrom('kick')]}
    ])
    

    Note that sidechains are resolved by the FluidSession constructor, so in the example above, a call to session.resolveSidechainReceives() is not necessary.

    chainable

    Parameters

    • track: string | FluidTrack

      name of the track that will feed the sidechain

    Returns TEqualizerVst2