Pangolin PangoScript Command Documentation

Command sets Zoom parameter of the current Live Control.

Zoom 100

Command sets Zoom parameter of the current Live Control.

ZoomDelta 5 // add 5%

Set Position of the current Live Control. This is absolute value command.

Position 0,0,0

Shift Position of the current Live Control. This is relative value command.

PositionDelta 0,10,0 // X,Y,Z

Set the Angle X parameter into specified value. Angles in degrees. Same can be done using AngleX property of Live Control enabled objects.

AngleX 0

AngleX 45

Set the Angle Y parameter into specified value. Angles in degrees. Same can be done using AngleY property of Live Control enabled objects.

AngleY 0

Set the Angle Z parameter into specified value. Angles in degrees. Same can be done using AngleZ property of Live Control enabled objects.

AngleZ 0

AngleZ 45

Live Control section of the geometric operations includes both a static rotation angle and a rotation speed. The Angle command defines the static rotation angle for the X, Y, and Z axes. All angles are measured in degrees.

Angle 0,0,0

Angle 0,0,90

AngleDelta increase Angle X, Y and Z of Live Control by specified value. This is relative command. Suggested use - MIDI encoders or

AngleDelta 0,0,0

Set rotation speed by X only of the current Live Control.

RotoSpeedX 0

Set rotation speed by Y only of the current Live Control.

RotoSpeedY 0

Set rotation speed by Z only of the current Live Control.

RotoSpeedZ 0

Set rotation speed by X, Y and Z of the current Live Control. If you need static angle - use Angle... commands.

RotoSpeed 0,0,0 // rotation speed by X,Y,Z axis. degree.

Increase rotation speed on the current Live Control.

RotoSpeedDelta 0,0,5 // increment of rotation speed. X,Y,Z axis.

Set Brightness parameter of associated Live Control object.

Brightness 100

Brightness 50

Sets the Visible Point parameters of the Live Control. This is absolute version of the command. Visible Points control how the end of the frame is handled visually.

VisiblePoints 100 // 0..100 (percents)

VisiblePoints 50 // 0..100 (percents)

Set the Color slider position. The slider has neutral range (0..31), then color gradient and white are at the end. Old FB3 DMX profile style. Use Red, Green, Blue and alpha if you need exact color control

ColorSlider 0 // default pos

ColorSlider 255 // default pos

Set animation speed of the Live Control. Animation speed parameter works on Cue and Master Live Control level. The Live Control also embedded into Projection zones, but you cannot set the playback speed of Zone. BEYOND plays content, BEYOND does not play Zones.

AnimationSpeed 100

AnimationSpeed 200

Sets the Scan rate of the current Live Control. Note, the scan rate is a multiplie of the same rate. Final sample rate controlled by the limit of the exact projector.

ScanRate 100

Reset current LiveControl to default state.

ResetLiveControl

Reset Rotation X,Y and Z of the current Live Control object. Command resets speed and current value to zero.

ResetRotation

Set Size X, Y and Z of the current Live Control.

Size 100,100,100 // Size X,Y,Z axis

Size 200,200,200

Changes the size relative to the current value along the X, Y, and Z axes.

SizeDelta 10,0,0

SizeDelta 0,-10,0

Relative version of Brightness command. Increase or decrease current Brightness value by provided delta.

BrightnessDelta 5

Command increases or decreases the Visible Points parameter of currently active Live Control.

VisiblePointsDelta -2

Shifts the Color slider position. The slider has neutral range (0..31), then color gradient and white are at the end. Old FB3 DMX profile style. Use Red, Green, Blue and alpha if you need exact color control

ColorSliderDelta 0

Increase or decrease animation speed. This is relative version of AnimationSpeed command.

AnimationSpeedDelta 0

Modifies the scan rate of the current Live Control.

ScanRateDelta -10

One axis position change. Sometimes it helps to have variable axis.

PositionIndex 1,0 // Axis, Value

Set Size X, Y or Z, using axis index.

SizeDelta 1,50

Command modify the RGBA recoloring values in various combinations. The command has three overloads: 2 parameters — channel index and value change. 3 parameters — R, G, and B change, alpha stay as it is 4 parameters — R, G, B, and Alpha change

RGBADelta 16,0,0,0

Sets the RGBA recoloring values in various combinations. Remember: if Alpha is 0, the RGB values have no effect. If Alpha is 255, Live Control applies full RGB recoloring (except on blank points). The command has three overloads: 2 parameters — channel index and value. 3 parameters — R, G, and B (Alpha remains unchanged). 4 parameters — R, G, B, and Alpha

RGBA 255,255,255,255 //R,G,B,Alpha. 0..255

RGBA 255,0,0,128 //R,G,B,Alpha. 0..255

Reset Position X,Y and Z of the current Live Control object.

ResetPosition

Set Effect index for FX layers. 0 means off. 1 to 100 is effect index. First argument is index for 1st layer, second argument for second layer, etc. Up to 8 arguments.

FX 0,0,0,0

The SetFX command assigns an FX (effect) from the QuickFX table to the current Live Control. Live Control includes eight layers, with one effect per layer. The command is overloade:d -The first argument specifies the layer index (1–8). -The second argument specifies the FX index for that layer. -Additional arguments define FX indexes for subsequent layers. The command is flexible - it can be used to set a single FX layer or multiple layers at once. Layer index value range is 1 to 8 FX index range is 1 to 100

SetFX 1, 10 // Layer number: 1..8, Effect index: 1..100

SetFX 1, 10,10,10,10  // set all 4 first layers to effect number 10

SetFX 5, 0,0,0,0, // just an example of addressing

This command moves the focus within the specified layer of the QuickFX table.

ShiftFX 1, 1

Runs an effect from the FX table as a “drop effect” for a specified duration. Drop effects are an additional list of effects: they are defined in the main FX table, but triggered temporarily on top of the fixed FX chain. They are intended for short actions such as flashes, triggers, or brief accents.

DropFX 1,1, 1000

Sets FX effect action. Action is a morph between laser frame before and after effect. This is sort of CPU heavy operation.

SetFXAction 1, 100

Set FX Action for FX layers. 0 - effect does not work at all 100 - effect applied fully, without any modification. 1..99 - morph between input and out frame (after effect calculation). Command accept up to 8 arguments, one per layer.

FXAction 100,100,100,100

This command is deprecated. Use FXTimeScale instead.

ZoneFXTimeScale 1,2,1 // Layer, Clock multipler, Metronome multiplier

This command is deprecated. Use FXTimeShift instead.

ZoneFXTimeShift 1,2,1 // Layer, Clock multipler, Metronome multiplier

Toggle FX playback. If layer not specified than toggle all 8 layers. Command work in context of scripter (same as all Live Control commands)

ToggleFX 1 //

Set Position X coordinate of the current Live Control.

PositionX 100 // -100 to 100

Set Position Y coordinate of the current Live Control.

PositionY 100 // -100 to 100

Set Position Z coordinate of the current Live Control.

PositionZ 0 // -100 to 100

Sets the X size value of the current Live Control.

SizeX 100

Sets the Y size value of the current Live Control.

SizeY 100

Sets the Z size value of the current Live Control.

SizeZ 100

Enables laser frame recoloring using the Live Control RGB section. This command specifically sets the Alpha channel to either 0 or 255 - a simple on/off control for alpha.

ColorOn 1 // 1-enabled, 0-disabled

Sets the color used for live frame recoloring. The color value is a 24-bit unsigned integer.

ColorRGB 0x0000FF // red

Sets the color used for live frame recoloring. The color value is a 24-bit unsigned integer.

ColorBGR 0x0000FF // blue

Reset Rotation X of the current Live Control object. Command resets speed and current value to zero.

ResetRotationX

Reset Rotation Y of the current Live Control object. Command resets speed and current value to zero.

ResetRotationY

Reset Rotation Z of the current Live Control object. Command resets speed and current value to zero.

ResetRotationZ

Invert rotation X direction of the applicable live control.

InvertRotationX

Invert rotation Y direction of the applicable live control.

InvertRotationY

Invert rotation Z direction of the applicable live control.

InvertRotationZ

Reset FX time scale of the current Live Control for specified layer and time component (clock, beat)

FXTimeScaleAxReset 1,3 // Layer, Mask (1,2,3)

Defines the scale (multiplier) for incoming time. In practice, this is a speed control for the clock and beat time. If you set the speed to anything other than 1, BEYOND automatically enables independent time calculation for this Live Control. You can reset it back to the default using FXTimeSync.

FXTimeScaleAx 1,2,1 // Layer, Mask (1,2,3), multiplier

FXTimeScaleAx 1,3,1 // Layer, Mask (1,2,3), multiplier

Command open ability to mute (disable) FX layers of the Live Control 0-Off, 1-On, 2-Toggle

SetFXMute 1, 2

This is tricky area. The LC object has time accumulator per FX line. Each line has own Clock and Metronome time (optional). Each of time component has speed control. Overall, you can control the speed of each FX line, for clock and metronome components of time.

SetFXMul 2, 4,1 // Layer, Clock, Metronome multiplier

This command is deprecated. Use FXTimeScaleDelta instead.

ZoneFXTimeScaleDelta 0,0,0,0

This command is deprecated. Use FXTimeShiftDelta instead.

ZoneFXTimeShiftDelta 0,0,0,0

Stop effect at FX layer of current. The FX line may play up to 4 effects. If you need to stop exact - specify effect index. Otherwise - all effects in the layer.

StopFXCell

This command resets all time-related effects of the current Live Control, including DJ disk, time scale, time multiplier, time shift, and time value.

ResetFxTiming

Stop/reset FX of current Live Control

StopFX

Set action of FX 1 layer. Command act same as clicking on QuickFX grid.

SetFXAction1 100

Set action of FX 2 layer. Command act same as clicking on QuickFX grid.

SetFXAction2 100

Set action of FX 3 layer. Command act same as clicking on QuickFX grid.

SetFXAction3 100

Set action of FX 4 layer. Command act same as clicking on QuickFX grid.

SetFXAction4 100

Similar to SetFXMul, this command allows to control the speed of FX, but you can define which Layer number: 1..8, Mask (1 is clock, 2 is beat, 3 is clock and beat), Value of multiplier

SetFXMulAx 1, 3, 2 // layer, mask, multiplier

FXTimSync resets the time calculation for an FX layer to its default state, where the FX no longer uses its own time accumulation or speed. The first parameter specifies the FX layer, and the second parameter is the mode; using value 1 resets the layer to the default (parent time). As with all Live Control commands, this instruction applies to the currently active Live Control.

FXTimeSync 1,1 // Set to master/parent time.

This is relative version of the FxTimeScaleAx command. It changes the scale (multiplier) for incoming time.

FXTimeScaleDeltaAx 1,2, 0.05

Reset Live Control currently used in UI. Most of commands work with exact Live Control containers. The UI (Live Control Tab) can be connected to various Live Controls, such as Cues, ProTracks, etc. This command made for UI mapping.

ResetLCTab

Set action of FX 5 layer. Command act same as clicking on QuickFX grid.

SetFXAction5 100

Set action of FX 6 layer. Command act same as clicking on QuickFX grid.

SetFXAction6 100

Set action of FX 7 layer. Command act same as clicking on QuickFX grid.

SetFXAction7 100

Set action of FX 8 layer. Command act same as clicking on QuickFX grid.

SetFXAction8 100

Command sets the strobe of the current Live Control.

StrobeSpeed 0.2

Command changes the strobe of the current Live Control.

StrobeSpeedDelta 0.1 // period, flicker per second

Command controls the speed/multiplier for FX playback

MulFXMulAx 1, 3, 1 // Multiply multiplier... :-) Layer number: 1..4, Mask (1 is clock, 2 is beat, 3 is clock and beat), Value of multiplier

Set the Hue component. Negative values treated as not active, and hue has not impact on recolor

Hue -1

Increment or decrement the Hue property by specified value. This is relative command

HueDelta 5

Hue shift is an additional offset for the hue value. Made for additional oscillation around current hue. If you need to recolor then use Hue, which replaces the input color Hue.

HueShift 90

Command increment/decrement current HueShift value by provided delta. This is relative version of the Sh

HueShiftDelta 5

Sets saturation level of the current Live Control. Saturation is not direct value. In Live Control it works as an offset. Incoming color transformed to HSV, modified and transformed back.

Saturation 0

Shift the saturation level of the current Live Control.

SaturationDelta 0

Set BeamBrush value (laser line width).

BeamBrush 25

BeamBrush 0

BeamBrush 100

Relative version of BeamBrush command. Increase or decrease BeamBrush value by specified delta

BeamBrushDelta 1

This command sets the index of the currently visible page in the main Grid.

SetPage 1

This command is deprecated. Please do not use it. It remains enabled only to avoid syntax check failures in very old scripts.

This is a script instruction, not a command. It restarts script execution from the beginning and also resets the execution start time, which is used by the WaitForTimePos instruction.

StartCue 1, randomin(1,100) // action
Sleep 1000 // delay
restart // go to beginning

EXIT is an instruction to stop script execution. Typically used at the end of script section, such as universe components, or a triggers. Same logic as in SWICTH () in C.

Exit

Depreciated. Same as ControlFromTcTab.

GetPage

Depreciated. Same as ControlFromLcTab.

GetLiveControl

Depreciated. Same as ControlFromFxTab.

GetFxControl

This command defines the name of the scripter object. The assigned name appears in the PangoScript tab and can also be used as an identifier in the StartCode and StopCode commands.

CodeName "MyCode"

Defines the shortcut for the script. The only parameters is shortcut name. Use this link for shortcut names: https://docwiki.embarcadero.com/Libraries/Sydney/en/Vcl.Menus.TextToShortCut

CodeShortcut "Ctrl+D"

CodeShortcut "F2"

Enable auto start of the script. This scrip option applicable for scripts located in PangoScript tab. This command inform BEYOND that this script must be executed at start up.

AutoStart

Enables script termination on Blackout. When this option is enabled, the script will stop automatically if Blackout is activated. This is useful for scripts that start or manage multiple Cues, allowing BEYOND to halt the script immediately when the user clicks Blackout.

StopOnBlackout 1

LinePerCycle defines how many script lines are executed during a single iteration of the scripting core. BEYOND can run hundreds of scripts in parallel—some may be stopped, others waiting, and some running in endless loops. To prevent any single script from monopolizing processing time, a limit is imposed on the number of lines executed per cycle. For large or time-critical scripts that need to be processed more quickly, you can increase this value. The default setting is 30 lines per cycle.

LinePerCycle 100 // put at beginning of script.

Defines color marker for the script in PangoScript tab. Color in standard GDI RGB encoding, where 0x0000FF is red, 0x00FF00 is green, and 0xFF0000 is blue. Yes, this is not HTML encoding.

CodeColorMarker 0x00FF00

Each scripter has a property that defines which MIDI device it operates with. Command defined index of the MIDI IN and MIDI OUT.

SelectMidi 1 // Select MIDI device pair, 1..4.

Sends a MIDI message to the MIDI OUT device. By default, the target device is device 1. However, if the command is called from MIDI mapping, BEYOND automatically sets the device index based on the current context. The MIDI device index can be manually defined using the SelectMIDI command, which assigns the MIDI device index for this scripter. The parameters msg, data1, and data2 follow standard MIDI specifications. Make sure to review MIDI fundamentals before using these commands.

MidiOut 0x90, 0x40, 0x7F

DmxOut command defines state of the DMX channel. BEYOND has multiple DMX buffers, which merged during calculation. All scripts write the data into shared buffer. The buffer channel has 16 bit signed resolution. Value -1 means undefined. Use it if you want to make this channel "transparent". Values between 0 and 255 are normal values. This command made for output of 1 or 2 channels. If you need more than two then use DmxOutRange

DmxOut 1, 255 // set first DMX OUT channel to 255 (max value)

BEYOND provides 255 general-purpose channels. A channel is an element in an array of 255 normalized floating-point variables The main concept is that external inputs modify channel values, and these values are then used in effects as multipliers or in other forms of modulation.

ChannelOut 1, 1000

ChannelOut 1, 500

Send OSC message out. The Type Tag String composed by type of the arguments. The first argument must be string with OSC address. Command used OSC Client socket.

OscOut "/beam1/xy", -5, 100

Send OSC message out. First argument - OSC address, string. Second argument - OSC TTS, string. Third, 4ths, etc - OSC message values. Command used OSC Client socket.

OscOutTTS "/main/volume","i", 100 // Address, Type Tag String, Arguments (optional)

DmxOutRange allows to write array of DMX values. First parameter is channel index, 1 to 2048 Second, third, 4th and so on - DMX values. -1 is transparent DMX value. 0 to 255 are standard DMX values

DmxOutRange 1, 100,101,102,103,104 // send 5 DMX values, starting channel 1

The command sets the layer index for the MIDI device currently selected in the active Scripter (range 1..4). Use SelectMidi to select the MIDI device. The default layer index is 1. After selecting the device, you can control which layer is active using SetMidiLayer.

SetMidiLayer 1 // default is 1

Sets the Surface layer index for Grid1 in the MIDI Surface Mapping.

SetGrid1MSL 1

Sets the Surface layer index for Grid2 in the MIDI Surface Mapping.

SetGrid2MSL 1

Sets the Surface layer index for Slider in the MIDI Surface Mapping.

SetSliderMSL 1

Sets the Surface layer index for Buttons in the MIDI Surface Mapping.

SetButtonMSL 1

Sets the Surface layer index for Zone Selection in the MIDI Surface Mapping.

SetZoneSelMSL 1

Sets the Surface layer index for Zone Mute in the MIDI Surface Mapping.

SetZoneMuteMSL 1

Sets the Surface layer index for FX1 in the MIDI Surface Mapping.

SetFX1MSL 1

Sets the Surface layer index for FX2 in the MIDI Surface Mapping.

SetFX2MSL 1

Sets the Surface layer index for FX3 in the MIDI Surface Mapping.

SetFX3MSL 1

Sets the Surface layer index for FX4 in the MIDI Surface Mapping.

SetFX4MSL 1

Sets the Surface layer index for FX5 in the MIDI Surface Mapping.

SetFX5MSL 1

Sets the Surface layer index for FX6 in the MIDI Surface Mapping.

SetFX6MSL 1

Creates the buffer for long MIDI Sysex message. Internally buffer is TMemoryStream, you can add as many bytes as you need. Use command MidiSystexAdd to write bytes into the stream. Use command MidiSysexSend to actually send complete MIDI message to output device. Check description of MidiOut command for device indexing.

MidiSysexStart

Write parameters as bytes into local sysex stream. Check description of MidiSysexStart

MidiSysexAdd  "F0477F"

MidiSysexAdd  1,2,3 // add 3 bytes.

Send prepared sysex stream to MIDI device. Use MidiSysexStart to initialize the buffer, and MidiSysexAdd to add bytes to the buffer.

MidiSysexSend

Load file into current cue of primary grid.

LoadCue "c:\MyAnimationFile.bani"

Load workspace from file. This is HTTP oriented command, do not use in script directly.

LoadWorkspace "c:\MyWorkspace.BeyondWorkspace"

ControlMaster set the LiveControl destination of this script Master Live Control. Subsequent LiveControl commands, such as Size, will apply to Master LC only.

ControlMaster

ControlCue set the LiveControl destination of this script to one Cue, addressed by page and cue index.

ControlCue 1,1

ControlZone set the LiveControl destination of this script to one zone, addressed by index or by name.

ControlZone 1 // name as "Main Graphics", or zone number 1...N

ControlZone "Main Graphics"

Command depreciated. At some point of time BEYOND had Live Control in Projectors.

ControlProjector 1

The ControlSelZones command sets the LiveControl destination of the script to the selected projection zones. Subsequent LiveControl commands, such as Size, will apply to all currently selected zones.

ControlSelZones

The ControlSelCues command sets the LiveControl destination of the script to the selected Cues. Subsequent LiveControl commands, such as Size, will apply to all currently selected Cues.

ControlSelCues

Start execution of script with specified name. In addition to that, this is overloaded command. You can add more arguments to this command and they will form parameter list. To read parameter in the script use param(index) function, where index is an index of parameter.

StartCode "MyCode"

StartCode "MyCode", "hello, this is param", 12345

// other script, place in PangoScript tab:

Codename "MyCode"  // define code name, required to work
displaypopup param(1), param(2)  //display two parameters

Stop execution of scripts with specified name.

StopCode "MyCode"

The ControlProTrack command sets the LiveControl destination of the script to ProTrack addressed by Index. Subsequent LiveControl commands, such as Size, will apply to this ProTrack only.

ControlProTrack 1 // bind to protrack 1

The ControlSelProTracks command sets the LiveControl destination of the script to the selected ProTracks. Subsequent LiveControl commands, such as Size, will apply to all currently ProTracks.

ControlSelProTracks

Each scripter has a property that defines which Grid it operates on. The Grid index—similar to the MIDI Device index—determines the context in which commands are executed.

SelectGrid 1

Select Tab by name. Operation by name are better to exact/safer scripting.

SelectTabName "Graphics" //define Page name!

Selects a Tab by its index. Index-based addressing works for general-purpose scripting, such as MIDI mapping, but it may have safety implications if the tab order changes.

SelectTab 1 //

Go to the next tab in the workspace. Grid defined by command SelectGrid.

SelectNextTab

Select previous Tab of the Grid. Grid defined by command SelectGrid.

SelectPrevTab

Select page by the name. String case sensitive.

SelectPageName "Graphics" // define Page name!

Page is absolute index, used as cue address. The Tab is UI side. The Grid may show subset of Pages because of Category selected.

SelectPage 1 // tab index, 1..N.

Go to the next page in the workspace. Grid defined by command SelectGrid.

SelectNextPage

Select previous Page of the Grid. Grid defined by command SelectGrid.

SelectPrevPage

Depreciated. New version ControlFromLcTab

ControlFromUI

Show Grid pages of all categories.

SelectAllCat

Shows only the Grid pages belonging to the specified category.

SelectCatName "Graphics"

Shows only the Grid pages belonging to the specified category.

SelectCat 1 // category index, 1..N.

Go to the next category in the workspace. Grid defined by command SelectGrid.

SelectNextCat

Go to the previous category in the workspace. Grid defined by command SelectGrid.

SelectPrevCat

Focuses the specified Grid cell using the provided column and row values. The row and column refer to UI coordinates; internally, BEYOND uses a flat 0–255 cue index. The command operates in the context of the scripter and the currently active Grid.

FocusCell 1,1 //Column (1..N), Row (1..N)

Focuses the specified Grid cell using the flat index, equal to cue index. The command operates in the context of the scripter and the currently active Grid.

FocusCellIndex 1 // cell index, 1..255

Starts playback of the cue located in the current cell of the current Grid. Arguments are optional and specify the names of the projection zones where the cue should output.

StartCell // start current cell

Stops playback of the cue located in the current cell of the current Grid.

StopCell

This command shifts the focus by N cells, forward or backward.

ShiftFocus -1

Move current (focused) cue of the current Grid

MoveFocus -1,0 //number of cells to go horizontally and vertically

Restarts playback of the cue in the current cell of the current Grid.

RestartCell

Toggles (plays or stops) the current cue in the active Grid. This is a UI-oriented command that simply starts or stops the currently selected cue. The command can also accept multiple projection zone names. These define the destination zones where the cue’s output will be sent.

ToggleCell // current grid

The Echo command sets the echo mode for the TCP Talk Server. 0 – No echo, no confirmation 1 – Confirmation with “OK” or “ERROR” 2 – Echoes back the command along with the status “OK” or “ERROR”

Echo 2 //0-none, 1-ok/error, 2-echo of input plus ok/error

Password protection can be enabled for the TCP Talk Server. The password must be defined in the BEYOND.INI file under the “General” section. If the provided password matches, commands from the client will be accepted. No password by default. [General] TcpTalkServerPassword=12345

password "enter pasword here"

Command Version designed for TCP Talk Server. BEYOND will respond with exe version information.

version

Command Hello is connection test command. Suggested use case - "TCP Talk Server". Essentially, this is plain text communication, one command per line. Your application connects to BEYOND and send Hello command. Response will be "Hello!".

hello

ControlFromLcTab set the LiveControl destination of this script to whatever selected now in Live Control tab. Command made to read current state of UI.

ControlFromLcTab

ControlFromFxTab set the LiveControl destination of this script to whatever selected now in QuickFX tab. Command made to read current state of UI.

ControlFromFxTab

ControlFromTcTab set the LiveControl destination of this script to whatever selected now in Time Control tab. Command made to read current state of UI.

ControlFromTcTab

The StoreZoneSelection command saves the list of selected projection zones into the local storage of the scripter executing the script. You can restore the selection later using ReStoreZoneSelection. The main idea is: store the current selection, modify it, perform the necessary operations, and then restore the original selection.

StoreZoneSelection // use ReStoreZoneSelection to revert back

ReStoreZoneSelection is the counterpart to StoreZoneSelection. It restores the projection zone selection that was previously saved.

ReStoreZoneSelection

Set the DMX slider value in QuickDMX editor. Good for MIDI or other external control.

SetDmxEditorChannel 1, 128 // firsh slider/channel, and 128 as value

Command call Projection Zone Settings dialog. Suggested use - from UMAX, sometimes you may need to give access to zone adjustments.

ProjectionZonesDialog

Command designed to help to prepare secured Timeline files.

MakeSecuredFile "Input file name", "Output file name", ClientHardwareSerial

This command is deprecated. There was an idea to generate a script from the current player state (a kind of “capture to script”), but this approach did not work well in practice.

RestorePlayer

Command call Windows ShellExec() which can start any applications, or other command line. Command disabled by default. Min purpose - automation in installations projects.

RunApp "C:\Windows\Notepad.exe", ""

ExecCmd is a bit fancy. Idea to execute script located in the string. ExecCmd accent any number of arguments, only strings executed as commands. One command per string.

ExecCmd "Blackout"

var s
s = "Blackout"
ExecCmd s

Write command add a string to last string of the Script component of the Universe. See WriteLn for more details.

write "*Add*/ " // run it a few times, it add to end of the current line.

WriteLn provides terminal-style output for scripts. Both Write and WriteLn send text to the script’s own terminal output buffer. To test the command, place a Script component on the Universe page, then click the Script Edit button. Inside the OnMouseDown section, add: writeln "Hello World!"; Run the page and click the component—your message will appear. WriteLn appends a new line to the terminal’s string list, which can be viewed in the Script component on the Universe page.

writeln "Hello world!"

Use to force refresh MIDI feedback for the surface. Command reset stored cache of the state, which cause update the MIDI feedback.

ResetMidiFeedback

Force sending the feedback of all OSC messages. BEYOND OSC feedback based on checking specified variables and sending the OSC message when the value changes. This command to send the state of all variables no matter of state.

ResetOscFeedback

Probably unusual idea - instead of writing script with loop, tell BEYOND which variable must be "animated" and let application to the work in background. To make it work you need to supply variable/property name as string, beginning and ending values, and duration. Optionally you can specify Event name which will be triggered at the end of animation process.

AnimateProp "master.brightness", 0,100,1000 // look at LiveControl tab, master lc, brightness

Similar to the AnimateProp command, but instead of using a from-to value pair, it operates in a relative mode. This command changes the specified property value by a given delta.

AnimatePropDelta "master.brightness", -10,1000

Deletes property animators associated with the specified property names. The AnimateProp command creates an animator, and DeletePropAni removes it. This command accepts one or multiple property names as strings: DeletePropAni "variable" or DeletePropAni ["variable", ...]

DeletePropAni

Check HtmlBody description first. HtmlClearHead clear the Head string.

HtmlClearHead

Check HtmlBody description first. Set Header string.

HtmlHead "<html><head><title></title></head>"

Check HtmlBody description first. HtmlClearBody clear the Body string.

HtmlClearBody

The Guide window contains HTML Viewer component. Primary purpose - style control info window for Universe or similar applications. This group contains commands for window and html parts control (head and body). Default initialization: HeadText:='<html><head><title></title></head>'; BodyText:='<body><p>Welcome to BEYOND Guide window</p></body></html>';

var a
a='BEYOND'
HtmlBody "<body><p>Welcome to "+a+" Guide window</p></body></html>"

Check HtmlBody description first. Update Guide window by correct state of Body and Header string

HtmlUpdate

Check HtmlBody description first. Close Guide window.

HtmlHide

Start recorder located in QuickRecord tab. Feature is not publicly available yet.

StartQuickRecord

Stop recorder located in QuickRecord tab. Feature is not publicly available yet.

StopQuickRecord

Command sets the file name for the recording. The recording feature is in not released state yet.

SetRecordFile "C:\BEYOND50\MyFile.best"

BEYOND supports three types of events used in scripts, images, and effects: audio, manual, and timer beats. All three serve the same purpose - to initiate a process or event that can be used elsewhere. TimerBeat initiated by system metronome located on main toolbar of BEYOND. One event every beat.

TimerBeat

BEYOND supports three types of events used in scripts, images, and effects: audio, manual, and timer beats. All three serve the same purpose - to initiate a process or event that can be used elsewhere. Audio beat events are generated by the audio input using an FFT-based peak detector. Manual events result from user interaction, while timer events are produced by the system-wide metronome. AudioBeat command initiate audio-beat event, same as audio analyzer. You may need if you have external audio peak detector.

AudioBeat

BEYOND supports three types of events used in scripts, images, and effects: audio, manual, and timer beats. All three serve the same purpose - to initiate a process or event that can be used elsewhere. ManualBeat command initiate manual-beat event.

ManualBeat

Command perform "press" action on the Grid (workspace cue). Exact action depends on Grid mode - toggle, flash, etc. Command is not depending on the Grid (main or secondary) as well as from current page.

CueDown 1,1 // simulate client on 1st page, 1st cue

Command perform "release" action on the Grid (workspace cue). Exact action depends on Grid mode - toggle, flash, etc. Command is not depending on the Grid (main or secondary) as well as from current page.

CueUp 1,1 // first page, first cue

Main Stop command. Stop playback of the cue.

StopCueNow 1, 1 // page 1..255, cue 1..255

Stops Cue playback in the Grid, ProTrack, and the Effect/Group pool.

StopAllSync  0.5

Stops Cue playback in the Grid, ProTrack, and the Effect/Group pool with specified fade out time.

StopAllAsync 0.5 // duration in seconds

Stops playback of all cues and effects, including the Grid player pool, ProTracks, Effects, Zone Effects, and the DMX Server. Playback is stopped immediately, without a soft stop. This is the primary stop command used internally by BEYOND.

StopAllNow

Stops playback of the specified Cue. This is legacy command. Do not use.

StopCueSync 1, 1, 0.5

Enable Laser Output. This command change internal mode of BEYOND to streaming. Streaming means output to laser projector, which initiate creation of calculation threads.

EnableLaserOutput

Disable Laser Output. This command change internal mode of BEYOND and stop output to all projectors, release threads and decrease CPU usage.

DisableLaserOutput

Set the playback on pause. Applied to laser and audio playbacks.

MasterPause Toggle // ON, OFF, TOGGLE

System wide reset. Has most impact when laser output enabled. Command has configuration for how many systems it reset. Main purpose - universal stop and reset.

BlackOut

Command enable, disable of toggle Virtual LJ (see button on main toolbar).

VirtualLJ Toggle // ON, OFF, TOGGLE

Tap tempo. Set the master BPM by means of tapping. Made for external MIDI control. BEYOND approximate last 4 taps. Max BPM is 600. Use SetBPM command if you want to set exact value. You can read and write current BPM using Master.BPM property.

BeatTap

Resets the master beat timer and sets its phase to zero. This command is used to synchronize the master beat timer and takes effect immediately. No parameters are required. Reset master beat timer, set phase to zero. Command made to synchronize the master beat timer. Act immediately. No parameters required.

BeatResync

The OneCue command sets the one cue mode. In this mode, the Grid allows one cue to be started.

OneCue

The MultiCue command enables multi-cue mode. In this mode, the Grid allows multiple cues to be started and played in parallel.

MultiCue

Command enable, disable or toggle transition between cues in the Grid.

Transition Toggle // ON, OFF, TOGGLE

Enable Select click mode of Live / Content Grid.

ClickSelect

Enable Flash click mode of Live / Content Grid.

ClickToggle

Enable Restart click mode of Live / Content Grid.

ClickRestart

Enable Flash click mode of Live / Content Grid.

ClickFlash

Enable Live click mode of Live / Content Grid.

ClickLive

Enable Solo-Flash click mode of Live / Content Grid.

ClickSoloFlash

Command finds the cue player, and set/remove the pause state. Command use default soft pause durations.

PauseCue 1,1, TOGGLE  // page index, cue index, action (ON, OFF, TOGGLE)

Command enable/disable VLJ of QuickFX tab.

VljFX 1, Toggle // index of FX-VLJ 1..8, and action: ON, OFF, TOGGLE

Zoom slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollZoom -5

Size slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollSize -5

Fade slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollFade -5

Visible points slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollVPoints -5

ScanRate slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollScanRate -5

Color slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollColor -5

Animation speed slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollAniSpeed -5

Red slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollR -5

Green slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollG -5

Blue slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollB -5

Alpha slider of Live Control tab. The slider includes two buttons on the left and right sides that control its movement toward the boundaries. Use a negative step value to move toward the lower boundary and a positive value to move toward the upper boundary. A higher absolute value results in faster motion. Use zero to stop the movement.

ClickScrollA -5

The OnePer command sets the one-per-zone mode. This is legacy mode, which is not recommended to use. Such model was applicable at BEYOND version 1 or 2. With increased calculation chain length, this mode become very hard to use and support.

OnePer

Sets the master BPM - the global tempo of the BEYOND application. There is only one tempo clock for the entire system.

SetBpm 120

Increment or decrement current BPM. You can have access to it using Master.BPM property.

SetBpmDelta 1

If a cue is currently playing in the Grid or ProTrack, this command resets its playback time to the beginning.

RestartCue 1,1 // page, cue

ClickLcTabMode command is same as clicking Master, Cue, Zone, ProTrack buttons in FX Tab. Command defined which Live Control is connected to Live Control tab (UI). Use following constants: 1-Master, 2-Cue, 3-Zone, 4-ProTrack

ClickLCTabMode 1 // 1-Master, 2-Cue, 3-Zone, 4-ProTrack

ClickFXTabMode command is same as clicking Master, Cue, Zone, ProTrack buttons in FX Tab. Command defined which Live Control FX is connected to QuickFX tab. Use following constants: 1-Master, 2-Cue, 3-Zone, 4-ProTrack

ClickFXTabMode 1

Sets Master.MasterSpeed property, which is general purpose speed multiplier.

MasterSpeed 1 // From zero to one

Performs the same action as the Back button on the main toolbar. This command starts the previously played Cue.

StartPrevious

A cue click history–based operation. The command starts the previously played cue, acting as a kind of “swap” function.

TogglePrevious // "SWAP" button

Clears the selection state of all ProTracks. After this command, no ProTracks remain selected.

UnselectAllProTracks

Select one or multiple ProTracks by index or by the name. String arguments used as names, numeric as indexes (1 to 8)

SelectProTrack 1

Clears the selection state of the specified ProTracks. Command accept multiple arguments - strings as ProTrack name, and numbers as ProTrack index.

UnselectProTrack 1,2,3,4 // unselect 1,2,3 and 4th ProTrack

Toggles the Selected state of the specified ProTrack. The command accepts multiple arguments: strings are treated as ProTrack names, and numeric values are treated as ProTrack indexes.

ToggleSelectProTrack 1

Removes the muted state from all ProTracks.

UnmuteAllProTracks

Mute specified ProTracks. Command accept multiple arguments - strings as ProTrack name, and numbers as ProTrack index.

MuteProTrack 1 // index(es) or name(s)

Removes the muted state from specified ProTrack. Command accept multiple arguments - strings as ProTrack name, and numbers as ProTrack index.

UnmuteProTrack 0,1,2,3 // unmute first four protracks

Toggles the muted state of the specified ProTrack. The command accepts multiple arguments: strings are treated as ProTrack names, and numeric values are treated as ProTrack indexes.

ToggleMuteProTrack 1 // index(es) or name(s)

ToggleMuteProTrack 1,2,3,4 //

Clears the selection state of all Fixtures. After this command, no Fixtures remain selected.

UnselectAllFixt

Set Selected state of the Fixture object

SelectFixt 0 // index(es) or name(s)

Clears the selection state of the specified Fixtures. Command accept multiple arguments - strings as fixture name, and numbers as fixture index.

UnselectFixt 0,2, "Spot 1" // two indexes and one name of the Fixture

Toggles the Selected state of the specified Fixtures. The command accepts multiple arguments: strings are treated as FIxture names, and numeric values are treated as Fixture indexes.

ToggleSelectFixt

ClickFXStopAll is combine action command, which send StopFX command, and stop FX VLJ actions.

ClickFXStopAll

ClickFxVlc is action performed by 8 VLJ buttons in QuickFX tab. It enable, disable or toggle corresponding VLJ button state. You must specify line index. Default action - toggle.

ClickFxVlj 2 // 0 off, 1 on, 2 toggle.

This command performs an FX table cell click using absolute indexing, which does not account for any horizontal shift of the table. It predates the FXCellClick command — in earlier versions, the number of effects was small and the FX grid was not scrollable. (The content grid is still not scrollable.) Consider this command as operating on absolute indexes, while FXCellClick is more UI-oriented.

FXCellDown 1, 1 // Layer number: 1..8, Effect number

Removes the muted state from all Projection Zones.

UnmuteAllZone

Mute specified Projection Zones. Command accept multiple arguments - strings as Zone name, and numbers as Zone index.

MuteZone 0

Removes the muted state from specified Projection Zone. Command accept multiple arguments - strings as zone name, and numbers as zone index.

UnmuteZone 0

Toggles the muted state of the specified Projection Zone. The command accepts multiple arguments: strings are treated as ProTrack names, and numeric values are treated as ProTrack indexes.

ToggleMuteZone 0

Toggle mute state of all zones associated with the projector.

ToggleMuteZoneOfProjector 1 // 1st projector

ToggleMuteZoneOfProjector 1, 0 // 1st projector, 0 unmute

Enable or disable synchronized change of Size X and Size Y sliders in Live Control tab. Basically, moving both sliders together.

ClickLockSize 1 // 0,1,2 Off, On, toggle

Start audio recording in QuickAudio tab (for spectrum, and audio triggers).

StartAudioRecord

Stop audio recording in QuickAudio tab.

StopAudioRecord

Set Audio Release speed (Quick Audio tab)

SetAudioRelease 75

Depreciated. FFT Audio compensation (1 to 15). Is not related to audio playback.

SetAudioGain 10

Sets the muted state for the selected Projection Zones, ProTracks and Fixtures.

MuteSelected 2 // 0,1,2

Command set the main grid size.

SetGridSize 8,5

Sets master pause duration (the soft pause)

MasterPauseTime 1000 // set pause/unpause time to 1 second

Set the Main Grid page by index.

SetGrid1Page 1

Set the Secondary Grid (bottom side) page by index.

SetGrid2Page 1

Mute all Projection Zones. Muted zone has no output to laser projector.

MuteAllZones

Sets the Main Preview mode, same as context menu. Modes: 1 - laser 2 - 2x2 3 - 3x3 4 - 4x4 11-Custom 1 12-Custom 2 13-Custom 3 In custom modes you can specify number of rows and columns.

PreviewNxN 4  // 1 - laser, 2 - 2x2, 3 - 3x3, 4 - 4x4, 11-Custom1, 12-Custom2, 13-Custom 3

Shows popup window. This is pure UI oriented command. Take any number of parameters of any type.

DisplayPopup "Hello world!"

DisplayPopup Master.BPM

DisplayPopup 123, "hello!"

Display message in Main Preview Panel located in Right/Top corner of BEYOND window. Recommend to use for debug messages, or action confirmation where you do not need a window based message. Command take any number parameters of any type.

DisplayPreview "Hello world!", 0x0000ff

Enable HOLD mode for Cue playback.

HoldClick 1

Sets the Main Preview panel to Master View mode. This action also clears the zone selection, since zones cannot be viewed or selected in Master View mode.

PreviewMaster

Stop cue playback of a specified type. 1 - general images 2 - timeline 4 - DMX 8 - Animator 16 - Beam sequences 32 - Capture 64 - Chains (not supported now) 128 - Script (not supported now) 256 - Records (not publicly available yet) 512 - Zone effects 1024 - effect pool (group mode)

StopCueType 255

Set FX table horizontal scroll position

FXScroll 1

Click on FX cell without using current UI left/right scroll. This index is absolute FX index

FXClick 1,1

The FX table is wider than the available UI space. This command performs an FX table cell click using relative indexing, which accounts for any horizontal shift of the table. In practice, it clicks by column position rather than by the absolute effect index.

FXCellClick 1,1

Enables, disables, or toggles Tap-Tempo on Cue click. When enabled, clicking a Cue in the Grid generates a Tap-Tempo (BPM) click. The command can turn this option on, off, or toggle its current state.

TapByCueClick On // options: On,Off, Toggle

This command sets the beat synchronization mode that is applied when a cue is clicked. You can use the predefined constants OFF, ON, and TOGGLE. The command is related to the master BPM (metronome) control, which also includes functions such as tap and resync.

ResyncByCueClick On

Sets the global option for players to synchronize to the beat. Synchronization occurs on player start and restart. The idea is similar to quantize in audio software: it is nearly impossible to click exactly on the beat, so the timing will always be slightly off. This option corrects that by using the current sub-beat time as the alignment reference.