• ui.text(string value, bool upper = false)
• ui.title(string value) 
• ui.design(string path)
• ui.image(string path)
• ui.value(int value, bool forWhilePressed = false) 
• ui.vu(int value, string text = null) 
• ui.vuscale(string value) 
• ui.vpotspan(string value)
• ui.minmax(int min, int max, bool forWhilePressed = false) 
• ui.speed(int value) 
• ui.titlevalueposition(string value) 
• ui.iconleft(string path)
• ui.iconright(string path)
• ui.display(string value, bool forWhilePressed = false)
• ui.largeicons(bool value)
• ui.vpotsizefull(bool value)
• ui.vpotendless(bool value) 
• ui.avoidfader(string value) 
• ui.step(string algorithm, bool forWhilePressed = false) 
• ui.step(string algorithm, int stepsize, bool forWhilePressed = false);
• ui.valuedisplay(string value, bool forWhilePressedOrUpper = false) 
• ui.icon(string path, int? size = null, int? x = null, int? y = null, bool upper = false)

The vpot and fader subobjects are "convenient" objects that can be used to make scripts clearer by denoting which kind of object is referenced, but they affect the same properties as the non-prefixed settings. Examples:  ui.vpot.endless affect the same value as ui.vpotendless. ui.design, ui.vpot.design and ui.fader.design all affect the "Design" dropdown.

• ui.vpot.endless(bool value)
• ui.vpot.sizefull(bool value)
• ui.vpot.span(string value)
• ui.vpot.minmax(int min, int max, bool forWhilePressed = false) 
• ui.vpot.speed(int value)
• ui.vpot.design(string path)
• ui.vpot.step(string algorithm, bool forWhilePressed = false)
• ui.vpot.step(string algorithm, int stepsize, bool forWhilePressed = false)
• ui.vpot.value(int value, bool forWhilePressed = false)

• ui.fader.minmax(int min, int max, bool forWhilePressed = false)
• ui.fader.speed(int value)
• ui.fader.design(string path)
• ui.fader.step(string algorithm, bool forWhilePressed = false)
• ui.fader.step(string algorithm, int stepsize, bool forWhilePressed = false)
• ui.fader.value(int value, bool forWhilePressed = false)

Connection state

var isConnected = midi.connected

Control Change

midi.sendCC(int channel, int control, int value)
var value = getCC(int channel, int control)
var previousValue = getCC_Prev(int channel, int control)

NRPN

midi.sendNRPN(int channel, int control, int value)
var value = getNRPN(int channel, int control)
var previousValue = getNRPN_Prev(int channel, int control)

Program Change

midi.sendPC(int channel, int program) 
var value = getPC(int channel)
var previousValue = getPC_Prev(int channel) 

Note On/Off

midi.sendNoteOn(int channel, int key, int velocity = 127)
var value = getNoteOn(int channel, int key)
var previousValue = getNoteOn_Prev(int channel, int key) 

midi.sendNoteOff(int channel, int key, int velocity = 0)
var value = getNoteOff(int channel, int key)

Channel Pressure

midi.sendCP(int channel, int pressure)
var value = getCP(int channel)
var previousValue = getCP_Prev(int channel)

Pitch Bend

midi.sendPB(int channel, int value) 
var value = getPB(int channel)
var previousValue = getPB_Prev(int channel)

Sysex

midi.sendSysEx(byte[] data)

The midi namespace has a helper function for sysex data manipulation. Please see the Sysex event for details.

Midi ports

midi.inputport(portname)
midi.outputport(portname)

portname is either the actual port name or a global port abbreviation "GPx", where "x" is the global port number in the range 1-30.

Midi time

The midi namespace has a helper function for time data. Please see the Time event for details.

Global variables, as in the midiScript engine, are accessible to all scripts. To access a global variable, JavaScript scripts must use the gvar functions.

Local variables (i.e., variables displayed in the Variables window as "local") are variables declared in the root of the JavaScript script. In JavaScript terminology, these variables are "global" (i.e., accessible from all functions in the script), but from the plugin's perspective, they are local to the script. Variables defined in functions are not accessible to the plugin and are not displayed in the Variables window.

var myvar = gvar.myGlobalVar;
gvar.myGlobalVar = value:
gvar.remove("myGlobalVar")
if (gvar.exists("myGlobalVar")) {}

The JavaScript engine imposes no restrictions on naming global variables, and global and local variables can share the same names.

• timer.run(string name, int callBackTime, bool? isGlobal = false)
• timer.pause(string name, bool? isGlobal = false)
• timer.restart(string name, int callBackTime, bool? isGlobal = false)
• timer.reset(string name, bool? isGlobal = false)
• var elapsed = timer.value(string name, bool? isGlobal = false)

• io.key(string text) 
• io.launch(string path, string parameters = "")
• io.requestInput(string id, string part2Label = "", string part3Label = "") 
• io.saveToClipboard(string text)
• io.saveFile(string action, string path, string text)
• var fileContent = io.loadFile(string path, int? line = null)

• list.set(string csvItems)
• list.set(string[] items)
• list.show(string csvItems= null, string focus = null)
• list.hide()
• list.focus(string itemOrIndex)
• var item = list.current()
• var item = list.selectedName()
• var item = list.selectedIndex()
• list.options(string csvOptions) 

csvOptions is a comma-separated list of options that control how a dial selection list is displayed and how it responds to dial press and release. 

List options become active "from now on" when a list.options() is executed. If all lists in a script share the same list options, you can place the list.options() action in an OnInit() command. All option groups have default values that are used unless you change them with a list.options() action. You need to specify only the option you want to change; the others remain as is. Options are grouped so that only one per group can be active at a time.

The default options are: list.options("paddedlist,useauto,hideexit,press")

List-display options

The list can be displayed as a...

• a loop, wrapping from the last to the first item and vice versa.
• a list, stopping at the first and last item.
• a paddedlist, stopping at the first and last item and displaying an empty line above the first item and below the last item.

The selected item in a list is displayed with white text on a blue background, while the other items are a bit dimmed on a gray background.

For the looped and padded lists, the selected item is always in the center of the display. The unpadded list moves the selection indication to the first and last position at the list endpoints.

Item reference type

Item references for focusing and when a selection is made can be made using the item text or index.

• usetext. Item references are made using the item text. References must be exactly as defined in the list, and they are case-sensitive.
• useindex. Item references are made using the item index, starting with the number 1 for the first item. If an exit item is shown as the first item in the list, it has the number 0, so the first "real" item in the list is always index 1.
• useAuto (default): If _item_ in the selectedfromlist event is explicitly defined as an integer or an interval, it is assumed to match the index of the selected item. If it cannot be interpreted as an integer or interval, it is assumed to match the text of the selected item. To match text that can be interpreted as an integer or interval, enclose the value in quotation marks to force it to be treated as a string.

Exit option

The plugin can show an extra option, "Exit (no change)", which will close the list without notifying the script if selected. The options to control this feature are:

• showexit, which will show the "Exit (no change)" as the first item in the list.
• hideexit, which will not show the item. With hideexit active, you must select an item in the list to close it.

Press/release options

With these options, you can control whether a list selection occurs on dial press, dial release, or both. Please note that when a list is displayed, the script will NOT receive press or release events. Instead, an OnSelectedfromlist() event will be triggered when a selection is made.

• press, The selection will be made the first time the dial is pressed after the list is displayed; a dial release will be ignored.
• release, The selection will be made the first time the dial is released after the list is displayed; a dial press will be ignored.
• pressrelease, The selection will be made the first time the dial is pressed or released after the list is displayed. A dial release will make the selection if the dial is pressed when the list is displayed. A dial press will make the selection if the dial is not pressed when the list is displayed. 

The path namespace keeps path constants and helpers.

• var trevligaSpelFolder = path.trevligaspel;
• var musicFolder = path.music;
• var documentsFolder = path.documents;
• var pluginFolder = path.plugin;
• var fullPath = path.expand(environmentVariable);

All paths end with a trailing path separator (/ or \ depending on platform)

Using the console functions, you can write entries to the plugin log file.

• console.log(...)
• console.info(...)
• console.debug(...)
• console.warn(...)
• console.error(...)

The logging follows the same rules as the rest of the plugin. Warn and error logging are always performed, regardless of the plugin's extended logging setting. log, info, and debug are logged only when extended logging is enabled.

The following command results in the log entry below:

console.log("script logging");

INFO    36  ScriptEngine_JS  console.log                   [3d8120ed24c147abc662b6e6a8ccd967 script logging]