Engine

Topics
	Global Variables

Namespaces
namespace	System
	Global system variables.

Classes
class	Element
	Common Elements base class. More...
class	EventProcessor
	an Event processor. More...
class	ControlSignalSource
	a Modulation source More...
class	SignalConnection
	a Connection definition for a modulation More...
class	AuxEffect
	an Auxiliary Bus Container for multiple InsertEffect More...
class	InsertEffect
	an Insert FX Generic structure that defines an insert FX More...
class	BusRouter
	a BusRouter Structure that holds the aux send level as well as the pre/post flag More...
class	SampledReverb
	SampledReverb. More...
class	Synth
	The Master Element in the synthesis tree. More...
class	Part
	A Part. More...
class	Program
	A Patch that represents a monotimbral instrument. More...
class	Layer
	A layer of sounds. More...
class	Keygroup
	A range of keys and velocities. More...
class	Oscillator
	The Synthesis primitive. More...
class	SampleBasedOscillator
	A sample-based Oscillator. More...
class	SamplePlayer
	A sample player Oscillator. More...

Functions
string	getLocation (string location)
function	findLayer (name)
	return the layer id given the layer display name.

Detailed Description

Synthesis engine structure and hierarchy access.

The Engine group provides access to the UVI synthesis engine's hierarchical structure, from the top-level Synth down through Parts, Programs, Layers, Keygroups, to individual Oscillators. You can navigate this hierarchy, query properties, and modify parameters to control synthesis in real-time.

Engine Hierarchy:

• Synth (top level) → Parts → Program → Layers → Keygroups → Oscillators
• Each level contains modulations, event processors, insert effects, and aux sends
• Navigate using parent/children references (e.g., Program.layers[1].keygroups[1])

Key Classes:

• Element - Base class with common functionality (get/set parameters, children navigation)
• Program - The current instrument patch
• Layer - A layer within a program
• Keygroup - Sample/sound mapped to key/velocity ranges
• Oscillator - The actual sample player or synthesis primitive
• ScriptProcessor - This script processor (access via this)

Common Operations:

• Query engine state and parameters
• Navigate the synthesis hierarchy
• Modify synthesis parameters dynamically
• Manage sample loading and purging
• Access modulation sources and connections

Note

Use the global variable this to access the current ScriptProcessor and navigate to parent elements like this.parent.parent to reach the Program level.

See also

Elements & parameters, Async

Function Documentation

findLayer()

function findLayer

(

name

)

return the layer id given the layer display name.

Parameters

name	displayName of layer to find

Returns

layerId if the layer was found, nil otherwise usage:

function onNote(e)
  local layer = findLayer("sustain")
  e.layer = layer
  local voiceId = postEvent(e)
end

getLocation()

string getLocation

(

string

location

)

Returns

returns special locations like Home, Desktop, Documents and Music directories

print(getLocation("Home"))
print(getLocation("Documents"))
print(getLocation("Desktop"))
print(getLocation("Music"))
print(getLocation("ProgramPath"))
print(getLocation("Temp"))