Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excerpt
Panel
insertEffect(effect, position)

Description

Function to insert an effect at the specified a specific position in the determined a destination bus. The effect to be inserted is determined by its Effect object. You can use getEffect or findEffects to determine the desired effect. The destination bus is determined by its Bus object. You can use getBus or findBusses to determine the destination bus. The position is the number indexing the effects in the destination bus. The new effect will be inserted before the specified position. To add the effect at the end, use appendEffect instead.

Info

Available in: Controller.

Arguments

effectThe element object of the effect that you want to insert.Effect
positionThe position where the inserted effect is inserted.number

Example

To explore the following script:

  1. Download Program.vstpreset.
  2. Drag the preset on the MediaBay to import it to the user folder for VST presets.
  3. Create an empty program and add a script module.
  4. Paste the script into the text editor of the script module and execute the script.

 

Code Block
-- insert an effect from Program.vstpreset into the current program
 
-- get the file path for user VST presets
path = getUserPresetPath()
 
-- load VST preset
loadedProgram = loadPreset(path.."/Program/Program.vstpreset")
 
-- get the first effect from the loaded program
effect = loadedProgram:getBus():getEffect()

-- get the first bus of this program
bus = this.program:getBus()

-- insert the effect
if (effect and bus) then
 	bus:insertEffect(effect, 1)
end

...