Page tree
Skip to end of metadata
Go to start of metadata

appendZone(zone)

Description

Function to add a zone in the specified destination layer. The destination layer is determined by its Layer object. For example, this.parent specifies the parent layer of the script module as destination layer. The zone to be added is determined by its Zone object. You can use getZone or findZones to determine the zone. The new zone will be added behind the existing zones. To insert a zone at a specific position in the destination layer, use insertZone instead.

An Element object can only have one parent. It cannot be child of multiple parents. Therefore, an Element object that you retrieved from the running plug-in instance must be removed before it can be inserted again. The Element objects you retrieve through loadPreset or loadPresetAsync can be inserted freely, because these functions create a copy of the Element objects when reading them.

Available in: Controller.

Arguments

zoneThe Zone object of the zone that you want to append.Zone

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.

 

-- append zone 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 zone from the loaded program
zone = loadedProgram:getZone()
   
-- append zone
if zone then
    this.program:appendZone(zone)
end

3 Comments

    1. Please reread. Thanks!