PangoScript Commands Catalog

529 commands

PangoScript command reference

Every PangoScript command in BEYOND. Commands are grouped as they appear in the Commands by category list. Run a command from the PangoScript editor, or send one statement through the HTTP Server.

No commands match that search.

General

BlackOut

System-wide reset. It has the most impact when laser output is enabled. The command has a configuration for how many systems it resets. Main purpose: universal stop and reset.

Example

BlackOut

Notes

Laser output stop and reset (blackout)

Warning

This is a complex command that resets multiple internal subsystems. Execution may take some time. Do not use it inside loops, as it performs a heavy system reset.

EnableLaserOutput

Enables Laser Output. This command changes BEYOND's internal mode to streaming. Streaming means output to the laser projector, which initiates the creation of calculation threads.

Example

EnableLaserOutput

Notes

Enable laser output
Laser output is enabled only when the license is confirmed. If the license is not confirmed, output will not start. This might be a problem with scripts marked as autostart: that is too early an execution point, the hardware might not be connected yet, and the license is not confirmed either.

Warning

This is a slow command; do not use it frequently.

DisableLaserOutput

Disables Laser Output. This command changes BEYOND's internal mode, stops output to all projectors, releases threads, and decreases CPU usage.

Example

DisableLaserOutput

Notes

Disable laser output

Warning

Slow command; it changes BEYOND's mode. Do not use it in loops.

MasterPause

Pauses playback. Applies to laser and audio playback.

Syntax

masterpause(integer)

Parameters

Name	Type	Description
`mode`	integer	0 - off, 1 - on, 2 - toggle

Example

MasterPause Toggle // ON, OFF, TOGGLE

Notes

Toggle master pause

Cue clicking

StartCue

Starts playback of a Cue. The Cue can be specified either by its page and cue index, or by its name. In Multi-Cue mode, this command may start more than one Cue. In Single-Cue mode, only one Cue will be started.

Syntax

startcue(integer, integer)startcue(string)startcue(string, string)

Parameters

Name	Type	Description
`pageind`	integer	page index
`cueind`	integer	cue index
`cue`	string	cue name to start
`pagename`	string	page name
`cuename`	string	cue name

Example

StartCue 1,1

Notes

Start the first cue on the 1st page, in single-cue mode

StartCueMulti

Starts playback of a Cue. The Cue can be specified either by its page and cue index, or by its name. The command always operates in multi-cue mode. You are responsible for stopping the cue.

Syntax

startcuemulti(integer, integer)startcuemulti(string)startcuemulti(string, string)

Parameters

Name	Type	Description
`pageind`	integer	page index
`cueind`	integer	cue index
`cue`	string	cue name
`pagename`	string	page name
`cuename`	string	cue name

Example

StartCueMulti 1,1

Notes

Multiple cues possible

StopCue

Stops playback of the specified Cue.

Syntax

stopcue(integer, integer)stopcue(string)stopcue(string, string)

Parameters

Name	Type	Description
`pageind`	integer	page index
`cueind`	integer	cue index
`cue`	string	cue name
`pagename`	string	page name
`cuename`	string	cue name

Example

StopCue 1,1

Notes

Stop the first cue

ToggleCue

Finds a cue by name, by page name and cue name, or by index. Once the cue is located, the command toggles its playback state (play/stop).

Syntax

togglecue(integer, integer)togglecue(string)togglecue(string, string)

Parameters

Name	Type	Description
`page`	integer	page index
`cue`	integer	cue index
`cuename`	string
`pagename`	string	page name
`cuename`	string	cue name

Example

ToggleCue 1,1

Notes

Toggle the playback state of cue 1 on page 1.
This is a simplified command. If the current click mode is not MultiCue, it will stop playback of all cues in the Grid and in the ProTrack array.
Use ToggleCueMulti if you intend to start multiple cues simultaneously.

ToggleCueMulti

Finds a cue by name, by page name and cue name, or by index. Once the cue is located, the command toggles its playback state (play/stop). Allows multiple cues to be started simultaneously, which may lead to system overload if used excessively.

Syntax

togglecuemulti(integer, integer)togglecuemulti(string)togglecuemulti(string, string)

Parameters

Name	Type	Description
`page`	integer	page index
`cue`	integer	cue index
`cuename`	string	cue name
`pagename`	string	page name
`cuename`	string	cue name

Example

ToggleCueMulti 1,1

Notes

Toggle playback of a specific cue (page, index)

PauseCue

Finds the cue player and sets/removes the pause state. The command uses the default soft-pause durations.

Syntax

pausecue(integer, integer, integer)

Parameters

Name	Type	Description
`page`	integer	Page index, 1..page count
`cue`	integer	cue index 1..255
`state`	integer	0 - resume playback (pause off), 1 - enable pause (pause on), 2 - toggle pause state

Example

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

Notes

Toggle pause of the cue
For readability, you can use predefined constants:
OFF as 0
ON as 1
TOGGLE as 2

RestartCue

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

Syntax

restartcue(integer, integer)

Parameters

Name	Type	Description
`page`	integer	page index
`cue`	integer	cue index

Example

RestartCue 1,1 // page, cue

Notes

Reset cue playback time (if playing now)

CueDown

Performs a "press" action on the Grid (workspace cue). The exact action depends on the Grid mode: toggle, flash, etc. The command does not depend on the Grid (main or secondary) or on the current page.

Syntax

cuedown(integer, integer)cuedown(integer, integer, integer)

Parameters

Name	Type	Description
`page`	integer	page index 1..N (where N is number of pages in current workspace)
`cue`	integer	cue index 1..255
`page`	integer	page index 1..N (where N is number of pages in current workspace)
`cue`	integer	cue index 1..255
`src`	integer	Internal BEYOND use only

Example

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

Notes

Cue click (mouse down) simulation

CueUp

Performs a "release" action on the Grid (workspace cue). The exact action depends on the Grid mode: toggle, flash, etc. The command does not depend on the Grid (main or secondary) or on the current page.

Syntax

cueup(integer, integer)cueup(integer, integer, integer)

Parameters

Name	Type	Description
`page`	integer	page index 1..N (where N is number of pages in current workspace)
`cue`	integer	cue index 1..255
`page`	integer	page index 1..N (where N is number of pages in current workspace)
`cue`	integer	cue index 1..255
`src`	integer	Internal BEYOND use only

Example

CueUp 1,1 // first page, first cue

Notes

Cue release (mouse up) simulation

SelectCue

Controls the Selected property of a cue. You can identify a cue either by its Page/Cue indexes or by its name. BEYOND first searches for the cue name in the current page of the main Grid. If the cue is not found there, the search continues from the first page of the workspace.

Syntax

selectcue(string)selectcue(float, float)selectcue(float, float, float)

Parameters

Name	Type	Description
`name`	string	Cue name
`page`	float	page index
`cue`	float	cue index
`page`	float	page index
`cue`	float	cue index
`mode`	float	0 - off, 1 - on, 2 - toggle

Example

SelectCue "Cue01" // Enter correct Cue name!

Notes

Select cue by name

HoldClick

Enables HOLD mode for Cue playback.

Syntax

holdclick(integer)

Parameters

Name	Type	Description
`mode`	integer	0 means OFF, 1 means ON

Example

HoldClick 1

Notes

Enable Hold mode for Grid click

How to stop?

StopAllNow

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.

Example

StopAllNow

Notes

Stop cue playback now

StopAllSync

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

Syntax

stopallsync(float)

Parameters

Name	Type	Description
`param1`	float

Example

StopAllSync 0.5

Notes

Duration in seconds

StopAllAsync

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

Syntax

stopallasync(float)

Parameters

Name	Type	Description
`duration`	float	Fade-out time in seconds

Example

StopAllAsync 0.5 // duration in seconds

Notes

Stop cue execution

StopCueNow

The main Stop command. Stops playback of the cue.

Syntax

stopcuenow(integer, integer)

Parameters

Name	Type	Description
`page`	integer
`cue`	integer

Example

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

Notes

Stop a specific cue's playback

StopCueSync

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

Syntax

stopcuesync(integer, integer, float)

Parameters

Name	Type	Description
`param1`	integer
`param2`	integer
`param3`	float

Example

StopCueSync 1, 1, 0.5

Notes

page 1..255, cue 1..255, time 0..

StopCueType

Stops 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)

Syntax

stopcuetype(integer)stopcuetype(integer, float)

Parameters

Name	Type	Description
`mask`	integer	cue type mask
`mask`	integer	cue type mask
`stoptime`	float	soft stop duration

Example

StopCueType 255

Notes

Stop cue by type mask

Main toolbar

ClickSelect

Enables Select click mode of the Live / Content Grid.

Syntax

clickselect(float)

Parameters

Name	Type	Description
`param1`	float

Example

ClickSelect

Notes

Optional argument: 1 or 2 (Grid number)

ClickToggle

Enables Toggle click mode of the Live / Content Grid.

Syntax

clicktoggle(float)

Parameters

Name	Type	Description
`grid`	float	1 for main grid. 2 for secondary grid

Example

ClickToggle

Notes

Optional argument: 1 or 2 (Grid number)

ClickRestart

Enables Restart click mode of the Live / Content Grid.

Syntax

clickrestart(float)

Parameters

Name	Type	Description
`grid`	float	1 for main grid. 2 for secondary grid

Example

ClickRestart

Notes

Optional argument: 1 or 2 (Grid number)

ClickFlash

Enables Flash click mode of the Live / Content Grid.

Syntax

clickflash(float)

Parameters

Name	Type	Description
`grid`	float	1 for main grid. 2 for secondary grid

Example

ClickFlash

Notes

Optional argument: 1 or 2 (Grid number)

ClickSoloFlash

Enables Solo-Flash click mode of the Live / Content Grid.

Syntax

clicksoloflash(float)

Parameters

Name	Type	Description
`grid`	float	1 for main grid. 2 for secondary grid

Example

ClickSoloFlash

Notes

Optional argument: 1 or 2 (Grid number)

ClickLive

Enables Live click mode of the Live / Content Grid.

Syntax

clicklive(float)

Parameters

Name	Type	Description
`grid`	float	1 for main grid. 2 for secondary grid

Example

ClickLive

Notes

Optional argument: 1 or 2 (Grid number)

Transition

Enables, disables, or toggles transitions between cues in the Grid.

Syntax

transition(integer)

Parameters

Name	Type	Description
`action`	integer	0 - off, 1 - on, 2 - toggle

Example

Transition Toggle // ON, OFF, TOGGLE

Notes

Toggle Transition mode

OneCue

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

Example

OneCue

Notes

Set One Cue playback mode
Live Grid playback has a complex internal structure. Even in One mode, multiple cues can be active simultaneously due to the parallel processing of DMX playback, VLJ, Hold cues, and user-started cues.

OnePer

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

Example

OnePer

Notes

One cue per projection zone

MultiCue

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

Example

MultiCue

Notes

Set Multi Cue playback mode

GroupCue

Enables the Group mode of the Grid. Group mode is a playback and cue start/stop mode that organizes cues into groups, visually represented by colors. Only one cue can play per group, although behavior also depends on the cue type—content, destination, and effects.

Example

GroupCue

Notes

Set Group playback mode

Transition

MasterTransition

Enables, disables, or toggles transitions between cues in the Grid.

Syntax

mastertransition(integer)

Parameters

Name	Type	Description
`mode`	integer	0 (OFF) disables transitions; 1 (ON) enables them; 2 (TOGGLE) reverses the current state. 0..2

Examples

MasterTransition ON

MasterTransition OFF

MasterTransition TOGGLE

Notes

Transition provides the same on/off/toggle operation. Use MasterTransitionIndex to choose the effect and MasterTransitionTime to set its duration.

MasterTransitionIndex

Sets the cue transition effect by index.

Syntax

mastertransitionindex(integer)

Parameters

Name	Type	Description
`index`	integer	Transition index

Example

MasterTransitionIndex 2

Notes

SetTransitionIndex is an alias for the same operation.

MasterTransitionTime

Sets the cue transition duration in seconds.

Syntax

mastertransitiontime(float)

Parameters

Name	Type	Description
`time`	float	Seconds

Example

MasterTransitionTime 0.1

Notes

SetTransitionTime is an alias for the same operation.

SetTransitionIndex

Sets the cue transition effect by index.

Syntax

settransitionindex(integer)

Parameters

Name	Type	Description
`index`	integer	Transition index

Example

SetTransitionIndex 2

Notes

MasterTransitionIndex is an alias for the same operation.

SetTransitionTime

Sets the cue transition duration in seconds.

Syntax

settransitiontime(float)

Parameters

Name	Type	Description
`time`	float	Seconds

Example

SetTransitionTime 0.1

Notes

MasterTransitionTime is an alias for the same operation.

Cell "navigation"

SelectGrid

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.

Syntax

selectgrid(integer)

Parameters

Name	Type	Description
`grid`	integer	1 - main grid, 2 - grid at bottom, 0 - recently active

Example

SelectGrid 1

Notes

1 - main grid, 2 - grid at bottom, 0 - recently active

FocusCell

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.

Syntax

focuscell(integer, integer)

Parameters

Name	Type	Description
`col`	integer	grid column index
`row`	integer	grid row index

Example

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

Notes

Focus top/left cell

FocusCellIndex

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

Syntax

focuscellindex(integer)

Parameters

Name	Type	Description
`index`	integer	flat cell index (1 to 255)

Example

FocusCellIndex 1 // cell index, 1..255

Notes

Focus the first cell of the current Grid

StartCell

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.

Example

StartCell // start current cell

ToggleCell

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.

Example

ToggleCell // current grid

Notes

Start/stop the current cell

ReStartCell

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

Example

RestartCell

Notes

Restart the current cell

StopCell

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

Example

StopCell

Notes

Stop the current cell of the current grid

ShiftFocus

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

Syntax

shiftfocus(integer)

Parameters

Name	Type	Description
`offs`	integer	Offset value (negative value for backward)

Example

ShiftFocus -1

Notes

Go to the previous cell

MoveFocus

Moves the current (focused) cue of the current Grid.

Syntax

movefocus(integer, integer)

Parameters

Name	Type	Description
`x`	integer	column shift (horizontal)
`y`	integer	row shift (vertical)

Example

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

Notes

Grid focus shift (go to another cue)

Beat timer - tap and re-sync

SetBpm

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

Syntax

setbpm(float)

Parameters

Name	Type	Description
`bpm`	float	Beats per minute. Range 0.1 to 600.

Example

SetBpm 120

Notes

Set 120 BPM

SetBpmDelta

Increments or decrements the current BPM. You can access it using the Master.BPM property.

Syntax

setbpmdelta(float)

Parameters

Name	Type	Description
`delta`	float	increment/decrement value.

Example

SetBpmDelta 1

Notes

Increase current BPM by one

BeatTap

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

Example

BeatTap

Notes

Beat tap command

BeatResync

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.

Example

BeatResync

Notes

Resynchronize beat

Virtual LJ

VirtualLJ

Enables, disables, or toggles Virtual LJ (see the button on the main toolbar).

Syntax

virtuallj(integer)

Parameters

Name	Type	Description
`action`	integer	0 - off, 1 - on, 2 - toggle

Example

VirtualLJ Toggle // ON, OFF, TOGGLE

Notes

Toggle Virtual LJ

VLJFX

Enables/disables VLJ of the QuickFX tab.

Syntax

vljfx(integer, integer)

Parameters

Name	Type	Description
`layer`	integer	FX layer index
`action`	integer	0 - off, 1 - on, 2 - toggle

Example

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

Notes

Toggle state of the 1st FX layer

Generating beats

TimerBeat

Example

TimerBeat

Notes

Simulate a timer beat instead of the internal BPM timer

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. 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. The AudioBeat command initiates an audio-beat event, the same as the audio analyzer does. You may need it if you have an external audio peak detector.

Example

AudioBeat

Notes

Simulate an audio beat

ManualBeat

Example

ManualBeat

Selecting Live Control

ControlMaster

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

Example

ControlMaster

Notes

Bind the script to the Master LC

ControlCue

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

Syntax

controlcue(integer, integer)

Parameters

Name	Type	Description
`page`	integer	page index
`cue`	integer	cue index

Example

ControlCue 1,1

Notes

Bind the script to the 1st cue of the 1st page.

ControlZone

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

Syntax

controlzone(integer)controlzone(string)

Parameters

Name	Type	Description
`index`	integer	Projection zone index (position in the zone list)
`name`	string	projection zone name

Examples

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

ControlZone "Main Graphics"

Notes

Bind the script to the 1st projection zone
Bind the script to the "Main Graphics" projection zone

ControlProTrack

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

Syntax

controlprotrack(integer)

Parameters

Name	Type	Description
`index`	integer	ProTrack index

Example

ControlProTrack 1 // bind to protrack 1

Notes

Bind the script to a specific ProTrack

ControlSelZones

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.

Example

ControlSelZones

Notes

Bind the script to selected zones

ControlSelCues

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.

Example

ControlSelCues

Notes

Bind the script to selected cues

ControlSelProTracks

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 selected ProTracks.

Example

ControlSelProTracks

Notes

Bind the script to selected ProTracks

ControlFromLcTab

ControlFromLcTab sets the LiveControl destination of this script to whatever is currently selected in the Live Control tab. The command is made to read the current state of the UI.

Example

ControlFromLcTab

Notes

Bind the script to the Live Control tab destination selection

ControlFromFxTab

ControlFromFxTab sets the LiveControl destination of this script to whatever is currently selected in the QuickFX tab. The command is made to read the current state of the UI.

Example

ControlFromFxTab

Notes

Bind the script to the FX tab destination selection

ControlFromTcTab

ControlFromTcTab sets the LiveControl destination of this script to whatever is currently selected in the Time Control tab. The command is made to read the current state of the UI.

Example

ControlFromTcTab

Notes

Bind the script to the Time Control tab destination selection

Live Control

ClickLCTabMode

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

Syntax

clicklctabmode(float)

Parameters

Name	Type	Description
`param1`	float

Example

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

Notes

Connect the Live Control tab to the Master LC

Size

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

Syntax

size(float, float, float)

Parameters

Name	Type	Description
`x`	float	Size X. Size in percent. 100 is default.
`y`	float	Size Y
`z`	float	Size x

Examples

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

Size 200,200,200

Notes

Set default Size X, Y and Z
Twice as big

SizeX

Sets the X size value of the current Live Control.

Syntax

sizex(float)

Parameters

Name	Type	Description
`param1`	float

Example

SizeX 100

Notes

Set default Size Y

SizeY

Sets the Y size value of the current Live Control.

Syntax

sizey(float)

Parameters

Name	Type	Description
`param1`	float

Example

SizeY 100

Notes

Set default Size Y

SizeZ

Sets the Z size value of the current Live Control.

Syntax

sizez(float)

Parameters

Name	Type	Description
`param1`	float

Example

SizeZ 100

Notes

Set default Size Z

SizeDelta

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

Syntax

sizedelta(float, float, float)sizedelta(float, float)sizedelta(float)

Parameters

Name	Type	Description
`x`	float	Size X delta
`y`	float	Size Y delta
`z`	float	Size Z delta
`x`	float	Size X delta
`y`	float	Size Y delta
`all`	float	Size change on all 3 axes.

Examples

SizeDelta 10,0,0

SizeDelta 0,-10,0

Notes

Make size X 10% bigger
Make Size Y ten percent smaller

SizeIndex

Sets Size X, Y, or Z using an axis index.

Syntax

sizeindex(integer, float)

Parameters

Name	Type	Description
`index`	integer	Axis index. 0 - x, 1 - y, 2 - z.
`value`	float	Size in percent

Example

SizeDelta 1,50

Notes

Set size X to 50

Position

Sets the Position of the current Live Control. This is an absolute-value command.

Syntax

position(float, float, float)

Parameters

Name	Type	Description
`x`	float	Position X (-100 to 100)
`y`	float	Position Y (-100 to 100)
`z`	float	Position Z (-100 to 100)

Example

Position 0,0,0

Notes

X,Y,Z position.

PositionX

Sets the Position X coordinate of the current Live Control.

Syntax

positionx(float)

Parameters

Name	Type	Description
`x`	float	X coordinate (-100 to 100);

Example

PositionX 100 // -100 to 100

Notes

Set Position X

PositionY

Sets the Position Y coordinate of the current Live Control.

Syntax

positiony(float)

Parameters

Name	Type	Description
`y`	float	Y coordinate (-100 to 100);

Example

PositionY 100 // -100 to 100

Notes

Set Position Y

PositionZ

Sets the Position Z coordinate of the current Live Control.

Syntax

positionz(float)

Parameters

Name	Type	Description
`z`	float	Z coordinate (-100 to 100);

Example

PositionZ 0 // -100 to 100

Notes

Set Position Z

PositionDelta

Shifts the Position of the current Live Control. This is a relative-value command.

Syntax

positiondelta(float, float, float)

Parameters

Name	Type	Description
`dx`	float	X coordinate shift
`dy`	float	Y coordinate shift
`dz`	float	Z coordinate shift

Example

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

Notes

Shift position up

PositionIndex

Changes the position on one axis. Sometimes it helps to have the axis as a variable.

Syntax

positionindex(integer, float)

Parameters

Name	Type	Description
`index`	integer	1 is X, 2 is Y, 3 is Z
`value`	float	Position value (-100 to 100)

Example

PositionIndex 1,0 // Axis, Value

Notes

Set position using axis index

AngleX

Sets the Angle X parameter to the specified value. Angles are in degrees. The same can be done using the AngleX property of Live Control-enabled objects.

Syntax

anglex(float)

Parameters

Name	Type	Description
`angle`	float	Absolute angle X

Examples

AngleX 0

AngleX 45

Notes

Reset angle X to zero
Reset angle X to 45 degrees
You can use AngleDelta 5,0,0 as the relative version of the command.
You can use the AngleX property of Live Control objects. For example: Master.AngleX = Master.AngleX + 5

AngleY

Sets the Angle Y parameter to the specified value. Angles are in degrees. The same can be done using the AngleY property of Live Control-enabled objects.

Syntax

angley(float)

Parameters

Name	Type	Description
`angle`	float	Absolute angle Y

Example

AngleY 0

Notes

Reset angle Y to zero

AngleZ

Sets the Angle Z parameter to the specified value. Angles are in degrees. The same can be done using the AngleZ property of Live Control-enabled objects.

Syntax

anglez(float)

Parameters

Name	Type	Description
`angle`	float	Absolute angle Z

Examples

AngleZ 0

AngleZ 45

Notes

Set angle to zero
Set angle to 45 degrees

Angle

The Live Control section for 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.

Syntax

angle(float, float, float)

Parameters

Name	Type	Description
`x`	float	Absolute angle x
`y`	float	Absolute angle y
`z`	float	Absolute angle z

Examples

Angle 0,0,0

Angle 0,0,90

Notes

Reset angle to zero
Rotate on Z by 90 degrees

AngleDelta

Increases or decreases Angle X, Y, and Z of the current Live Control by the supplied deltas, in degrees.

Syntax

angledelta(float, float, float)

Parameters

Name	Type	Description
`x`	float	Add X value to current angle X
`y`	float	Add Y value to current angle Y
`z`	float	Add Z value to current angle Z

Example

AngleDelta 0,0,0

Notes

Increment X, Y, Z angles in degrees

RotoSpeedX

Sets the rotation speed on X only for the current Live Control.

Syntax

rotospeedx(float)

Parameters

Name	Type	Description
`x`	float

Example

RotoSpeedX 0

Notes

Rotation speed, degrees

RotoSpeedY

Sets the rotation speed on Y only for the current Live Control.

Syntax

rotospeedy(float)

Parameters

Name	Type	Description
`y`	float

Example

RotoSpeedY 0

Notes

Rotation speed, degrees

RotoSpeedZ

Sets the rotation speed on Z only for the current Live Control.

Syntax

rotospeedz(float)

Parameters

Name	Type	Description
`z`	float

Example

RotoSpeedZ 0

Notes

Rotation speed, degrees

RotoSpeed

Sets the rotation speed on X, Y, and Z for the current Live Control. If you need a static angle, use the Angle... commands.

Syntax

rotospeed(float, float, float)

Parameters

Name	Type	Description
`x`	float	Rotation speed X (degrees per second)
`y`	float	Rotation speed Y
`z`	float	Rotation speed Z

Example

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

Notes

Stop rotation

RotoSpeedDelta

Increases the rotation speed of the current Live Control.

Syntax

rotospeeddelta(float, float, float)

Parameters

Name	Type	Description
`dx`	float	Increase/decrease rotation (degrees)
`dy`	float	Increase/decrease rotation (degrees)
`dz`	float	Increase/decrease rotation (degrees)

Example

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

Notes

Increase rotation speed on Z

Brightness

Sets the Brightness parameter of the associated Live Control object.

Syntax

brightness(float)

Parameters

Name	Type	Description
`value`	float	Brightness value in the range 0 to 100

Examples

Brightness 100

Brightness 50

Notes

Full brightness
Half brightness

BrightnessDelta

Relative version of the Brightness command. Increases or decreases the current Brightness value by the provided delta.

Syntax

brightnessdelta(float)

Parameters

Name	Type	Description
`delta`	float	Value to add to current brightness

Example

BrightnessDelta 5

Notes

Increase brightness by 5%

StrobeSpeedDelta

Changes the strobe of the current Live Control.

Syntax

strobespeeddelta(float)

Parameters

Name	Type	Description
`delta`	float	Negative values decrement the current Strobe value.

Example

StrobeSpeedDelta 0.1 // period, flicker per second

Notes

Increment the strobe of the Live Control

VisiblePoints

Sets the Visible Points parameter of the Live Control. This is the absolute version of the command. Visible Points controls how the end of the frame is handled visually.

Syntax

visiblepoints(float)

Parameters

Name	Type	Description
`edge`	float	Sets the end of visible points in percent. Value from 0 to 100

Examples

VisiblePoints 100 // 0..100 (percents)

VisiblePoints 50 // 0..100 (percents)

Notes

Reset visible points to default
Show half of the frame
BEYOND also allows points to be blanked or deleted.
While deleting points may seem useful, it increases scanner speed and FPS, which makes the visible parts of the frame progressively brighter.
Be aware of these visual consequences when removing points!

VisiblePointsDelta

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

Syntax

visiblepointsdelta(float)

Parameters

Name	Type	Description
`delta`	float	Increase or decrease the Visible Points parameter

Example

VisiblePointsDelta -2

Notes

Decrease visible points by two percent

ColorSlider

Sets the Color slider position. The slider has a neutral range (0..31), then a color gradient, with white at the end. This is the old FB3 DMX profile style. Use Red, Green, Blue, and Alpha if you need exact color control.

Syntax

colorslider(float)

Parameters

Name	Type	Description
`pos`	float	Color slider position (0..255)

Examples

ColorSlider 0 // default pos

ColorSlider 255 // default pos

Notes

Color slider
Color slider set to white

ColorSliderDelta

Shifts the Color slider position. The slider has a neutral range (0..31), then a color gradient, with white at the end. This is the old FB3 DMX profile style. Use Red, Green, Blue, and Alpha if you need exact color control.

Syntax

colorsliderdelta(float)

Parameters

Name	Type	Description
`delta`	float	Slider offset

Example

ColorSliderDelta 0

AnimationSpeed

Sets the animation speed of the Live Control. The animation speed parameter works at the Cue and Master Live Control level. Live Control is also embedded in Projection Zones, but you cannot set the playback speed of a Zone: BEYOND plays content, not Zones.

Syntax

animationspeed(float)

Parameters

Name	Type	Description
`speed`	float	Animation speed in percent. 100 is the default value. 0 is full stop.

Examples

AnimationSpeed 100

AnimationSpeed 200

Notes

Set default animation speed
Play twice as fast

Warning

AnimationSpeed was initially designed for use with clock-based time. The tempo (beats) is not meant to work with animation speed; use the Master.BPM property instead.

AnimationSpeedDelta

Increases or decreases the animation speed. This is the relative version of the AnimationSpeed command.

Syntax

animationspeeddelta(float)

Parameters

Name	Type	Description
`delta`	float	Defines the relative change (current = current + delta)

Example

AnimationSpeedDelta 0

ScanRate

Sets the Scan rate of the current Live Control. Note: the scan rate is a multiplier of the base rate. The final sample rate is limited by the specific projector.

Syntax

scanrate(float)

Parameters

Name	Type	Description
`rate`	float	100 is default value. Range 10 to 400

Example

ScanRate 100

ScanRateDelta

Modifies the scan rate of the current Live Control.

Syntax

scanratedelta(float)

Parameters

Name	Type	Description
`rate`	float	Increment/decrement of the sample rate value

Example

ScanRateDelta -10

Notes

Decrease scan rate by 10 percent

Zoom

Sets the Zoom parameter of the current Live Control.

Syntax

zoom(float)

Parameters

Name	Type	Description
`zoom`	float	Zoom value in percent. 100 is default

Example

Zoom 100

Notes

value -100..100

ZoomDelta

Increases or decreases the Zoom parameter of the current Live Control by the supplied delta.

Syntax

zoomdelta(float)

Parameters

Name	Type	Description
`delta`	float	Zoom change value

Example

ZoomDelta 5 // add 5%

Notes

Relative change of zoom value

BeamBrush

Sets the BeamBrush value (laser line width).

Syntax

beambrush(float)

Parameters

Name	Type	Description
`brush`	float	Width of the beam brush. Value range is 0 to 100, where 0 is min width and 100 is max

Examples

BeamBrush 25

BeamBrush 0

BeamBrush 100

Notes

Set 1/4 of the max width
Zero-width sharp line
Set widest line
Requires a BeamBrush-equipped projector.

BeamBrushDelta

Relative version of the BeamBrush command. Increases or decreases the BeamBrush value by the specified delta.

Syntax

beambrushdelta(float)

Parameters

Name	Type	Description
`delta`	float

Example

BeamBrushDelta 1

Notes

Make beam wider

ColorOn

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.

Syntax

coloron(float)

Parameters

Name	Type	Description
`enabled`	float	0 - disabled, 1 - enabled

Example

ColorOn 1 // 1-enabled, 0-disabled

Notes

Enable or disable Live Control recolor by RGB value

ColorRGB

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

Syntax

colorrgb(integer)

Parameters

Name	Type	Description
`rgb`	integer	24-bit RGB color 0x0000FF // red color

Example

ColorRGB 0x0000FF // red

Notes

Live Control - recolor

ColorBGR

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

Syntax

colorbgr(integer)

Parameters

Name	Type	Description
`bgr`	integer	24-bit BGR color 0x0000FF // red color

Example

ColorBGR 0x0000FF // blue

Notes

Live Control - recolor

RGBA

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 blanked 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.

Syntax

rgba(float, float, float, float)rgba(float, float)rgba(float, float, float)

Parameters

Name	Type	Description
`r`	float	Red channel 0 to 255
`g`	float	Green channel 0 to 255
`b`	float	Blue channel 0 to 255
`a`	float	Alpha channel value 0 to 255
`index`	float	0 red, 1 green, 2 blue, 3 alpha, 4 - all four to one value (reset)
`value`	float	Channel value from 0 to 255
`r`	float	Red channel 0 to 255
`g`	float	Green channel 0 to 255
`b`	float	Blue channel 0 to 255

Examples

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

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

Notes

Set white color
Set half-transparent red

RGBADelta

Modifies 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 stays as it is. 4 parameters — R, G, B, and Alpha change.

Syntax

rgbadelta(float, float, float, float)rgbadelta(float, float)rgbadelta(float, float, float)

Parameters

Name	Type	Description
`r`	float	Red channel change
`g`	float	Green channel change
`b`	float	Blue channel change
`a`	float	Alpha channel change
`index`	float	0 red, 1 green, 2 blue, 3 alpha, 4 - all four to one value (reset)
`value`	float	Increment/decrement value
`r`	float
`g`	float
`b`	float

Example

RGBADelta 16,0,0,0

Notes

Increase Red recolor (Alpha must be defined first)

InvertRotationX

Inverts the rotation X direction of the applicable Live Control.

Example

InvertRotationX

Notes

Live Control rotation

InvertRotationY

Inverts the rotation Y direction of the applicable Live Control.

Example

InvertRotationY

Notes

Live Control rotation

InvertRotationZ

Inverts the rotation Z direction of the applicable Live Control.

Example

InvertRotationZ

Notes

Live Control rotation

ResetPosition

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

Example

ResetPosition

Notes

Reset Position X,Y, and Z.

ResetRotation

Resets Rotation X, Y, and Z of the current Live Control object. The command resets both the speed and the current value to zero.

Example

ResetRotation

Notes

Reset Live Control Rotation X Y Z

ResetRotationX

Resets Rotation X of the current Live Control object. The command resets both the speed and the current value to zero.

Example

ResetRotationX

Notes

Reset Live Control Rotation X

ResetRotationY

Resets Rotation Y of the current Live Control object. The command resets both the speed and the current value to zero.

Example

ResetRotationY

Notes

Reset Live Control Rotation Y

ResetRotationZ

Resets Rotation Z of the current Live Control object. The command resets both the speed and the current value to zero.

Example

ResetRotationZ

Notes

Reset Live Control Rotation Z

ResetLiveControl

Resets the current Live Control to its default state.

Example

ResetLiveControl

Notes

Reset current script to default state.

ResetLCTab

Resets the Live Control currently used in the UI. Most commands work with specific Live Control containers. The UI (Live Control tab) can be connected to various Live Controls, such as Cues, ProTracks, etc. This command is made for UI mapping.

Example

ResetLCTab

Notes

Reset the Live Control in the tab

ClickLockSize

Enables or disables synchronized change of the Size X and Size Y sliders in the Live Control tab; basically, moving both sliders together.

Syntax

clicklocksize(float)

Parameters

Name	Type	Description
`state`	float	0 disabled, 1 enabled, 2 toggle

Example

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

Notes

Enable Size Lock mode

Live Control sliders buttons

ClickScrollZoom

Zoom slider of the 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.

Syntax

clickscrollzoom(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollZoom -5

Notes

Zoom slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollSize

Size slider of the 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.

Syntax

clickscrollsize(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollSize -5

Notes

Size slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollFade

Fade slider of the 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.

Syntax

clickscrollfade(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollFade -5

Notes

Fade slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollVPoints

Visible points slider of the 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.

Syntax

clickscrollvpoints(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollVPoints -5

Notes

Visible points slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollScanRate

ScanRate slider of the 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.

Syntax

clickscrollscanrate(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollScanRate -5

Notes

Scan rate slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollColor

Color slider of the 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.

Syntax

clickscrollcolor(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollColor -5

Notes

Color slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollAniSpeed

Animation speed slider of the 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.

Syntax

clickscrollanispeed(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollAniSpeed -5

Notes

Animation speed slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollR

Red slider of the 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.

Syntax

clickscrollr(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollR -5

Notes

Red slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollG

Green slider of the 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.

Syntax

clickscrollg(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollG -5

Notes

Green slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollB

Blue slider of the 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.

Syntax

clickscrollb(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollB -5

Notes

Blue slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollA

Alpha slider of the 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.

Syntax

clickscrolla(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollA -5

Notes

Alpha slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollHue

Hue slider of the 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.

Syntax

clickscrollhue(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollHue -5

Notes

Hue slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollHueShift

Hue Shift slider of the 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.

Syntax

clickscrollhueshift(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollHueShift -5

Notes

Hue shift slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollSaturation

Saturation slider of the 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.

Syntax

clickscrollsaturation(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollSaturation -5

Notes

Saturation slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

ClickScrollBeamBrush

Beam brush slider of the 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.

Syntax

clickscrollbeambrush(float)

Parameters

Name	Type	Description
`step`	float	increment step

Example

ClickScrollBeamBrush -5

Notes

Beam brush slider scroll speed, recommended -5..-1, or 1..5. Zero will stop.

Live Control Physics

SetMassSlider

Controls the Physics slider (mass) of the Master tab.

Syntax

setmassslider(float)

Parameters

Name	Type	Description
`value`	float	Mass slider value (1 to 30)

Example

SetMassSlider 4

Notes

Physics - Mass

SetAttractionSlider

Controls the Physics slider (attraction) of the Master tab.

Syntax

setattractionslider(float)

Parameters

Name	Type	Description
`value`	float	Attraction slider value (1 to 50)

Example

SetAttractionSlider 10

Notes

Physics - Attraction

SetFrictionSlider

Controls the Physics slider (friction) of the Master tab.

Syntax

setfrictionslider(float)

Parameters

Name	Type	Description
`param1`	float

Example

SetFrictionSlider 10

Notes

Physics - Friction

SetPhysicsCheckbox

This command enables, disables, or toggles the Physics checkbox located in the Live Control tab.

Syntax

setphysicscheckbox(integer)

Parameters

Name	Type	Description
`state`	integer	1 ON, 0 OFF, 2 TOGGLE

Example

SetPhysicsCheckbox TOGGLE

Notes

Toggle the Physics checkbox in the Live Control tab

FX

ClickFXTabMode

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

Syntax

clickfxtabmode(float)

Parameters

Name	Type	Description
`index`	float	1-Master, 2-Cue, 3-Zone, 4-ProTrack

Example

ClickFXTabMode 1

Notes

Connect the QuickFX tab to the Master Live Control

FX

Sets the effect index for FX layers. 0 means off; 1 to 100 is the effect index. The first argument is the index for the 1st layer, the second argument for the 2nd layer, etc. Up to 8 arguments.

Example

FX 0,0,0,0

Notes

One or more layers. 0 stops. Effect 1..100

SetFX

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 overloaded: -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 set a single FX layer or multiple layers at once. The layer index range is 1 to 8. The FX index range is 1 to 100.

Examples

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

Notes

Set 1st layer of FX
Set the first four layers of FX
Reset 5..8 layers

StopFX

Stops/resets the FX of the current Live Control.

Example

StopFX

Notes

One or more layers. 0 stops. Effect 1..100

StopFxCell

Stops the effect on an FX layer of the current Live Control. The FX line may play up to 4 effects. To stop a specific one, specify its effect index; otherwise all effects in the layer stop.

Syntax

stopfxcell(float)stopfxcell(float, float)

Parameters

Name	Type	Description
`layer`	float	layer index
`layer`	float	layer index
`item`	float	effect index

Example

StopFxCell 1

Notes

Layer index, optional Cell index (relative, takes the scrollbar into account)

ToggleFX

Toggles FX playback. If no layer is specified, all 8 layers are toggled. The command works in the context of the scripter (same as all Live Control commands).

Syntax

togglefx(integer)

Parameters

Name	Type	Description
`layer`	integer	0 - all, 1..8 layer index.

Example

ToggleFX 1 //

Notes

Toggle FX on 1st layer

ShiftFX

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

Syntax

shiftfx(integer, integer)

Parameters

Name	Type	Description
`layer`	integer	Layer index 1 to 8
`offs`	integer	Offset (negative for backward)

Example

ShiftFX 1, 1

Notes

Layer 1..8, delta

SetFXAction

Sets the FX effect action. Action is a morph between the laser frame before and after the effect. This is a somewhat CPU-heavy operation.

Syntax

setfxaction(integer, float)

Parameters

Name	Type	Description
`layer`	integer	Layer index 1 to 8
`action`	float	Action of the effect in percent (0 to 100)

Example

SetFXAction 1, 100

Notes

Layer number: 1..4, Action 0..100 percent

FXAction

Sets the FX Action for FX layers. 0 - the effect does not work at all. 100 - the effect is applied fully, without modification. 1..99 - morph between the input and output frame (after the effect calculation). The command accepts up to 8 arguments, one per layer.

Example

FXAction 100,100,100,100

Notes

One or more layers. Set effect action from 0% to 100%

ZoneFXTimeScale

This command is deprecated. Use FXTimeScale instead.

Syntax

zonefxtimescale(float, float, float)

Parameters

Name	Type	Description
`layer`	float	Layer index 1 to 8
`clock`	float	Clock speed (1 is default)
`beat`	float	Metronome (beat) speed (1 is default)

Example

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

Notes

Deprecated

FXTimeScaleAx

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.

Syntax

fxtimescaleax(float, float, float)

Parameters

Name	Type	Description
`layer`	float	Layer index 1 to 8
`mask`	float	Mask: 1 clock, 2 beat, 3 both.
`mul`	float	Time multiplier, 1 is default. Range 0 to 100

Examples

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

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

Notes

Reset the beat speed for FX on the 1st layer.
Reset beat and clock for the 1st layer

FXTimeScaleAxReset

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

Syntax

fxtimescaleaxreset(float, float)

Parameters

Name	Type	Description
`layer`	float	FX layer 1 to 8
`mask`	float	1 - clock, 2 - beat, 3 - clock and beat

Example

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

Notes

Reset the speed of clock and beat time components.

FXTimeSync

FXTimeSync 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; a value of 1 resets the layer to the default (parent time). As with all Live Control commands, this instruction applies to the currently active Live Control.

Syntax

fxtimesync(float, float)

Parameters

Name	Type	Description
`layer`	float	layer index (1 to 8)
`mode`	float	1 - default sync. 0 - own, custom sync

Example

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

Notes

Reset FX time mode

ZoneFXTimeScaleDelta

This command is deprecated. Use FXTimeScaleDelta instead.

Syntax

zonefxtimescaledelta(float, float, float, float)

Parameters

Name	Type	Description
`layer`	float
`clock`	float
`beat`	float
`param4`	float

Example

ZoneFXTimeScaleDelta 0,0,0,0

Notes

Deprecated

ZoneFXTimeShift

This command is deprecated. Use FXTimeShift instead.

Syntax

zonefxtimeshift(float, float, float)

Parameters

Name	Type	Description
`param1`	float
`param2`	float
`param3`	float

Example

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

Notes

Deprecated

ZoneFXTimeShiftDelta

This command is deprecated. Use FXTimeShiftDelta instead.

Syntax

zonefxtimeshiftdelta(float, float, float, float)

Parameters

Name	Type	Description
`param1`	float
`param2`	float
`param3`	float
`param4`	float

Example

ZoneFXTimeShiftDelta 0,0,0,0

Notes

Deprecated

FXClick

Clicks an FX cell without using the current UI left/right scroll. This index is the absolute FX index.

Syntax

fxclick(integer, integer)

Parameters

Name	Type	Description
`layer`	integer	Layer index 1 to 8
`eff`	integer	effect index 0 to 100

Example

FXClick 1,1

Notes

Start the first effect on the 1st FX layer

FXCellClick

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.

Syntax

fxcellclick(integer, integer)

Parameters

Name	Type	Description
`layer`	integer	FX layer index
`item`	integer	Effect index

Example

FXCellClick 1,1

Notes

FX table playback

FXScroll

Sets the FX table horizontal scroll position.

Syntax

fxscroll(integer)

Parameters

Name	Type	Description
`pos`	integer	Absolute offset value

Example

FXScroll 1

Notes

Set the FX table scroll position to default

FXScrollDelta

Shifts the FX table horizontal scroll position (left or right).

Syntax

fxscrolldelta(integer)

Parameters

Name	Type	Description
`offs`	integer	Scroll delta for FX table

Example

FXScrollDelta 8

Notes

Scroll FX table

ClickFXStopAll

ClickFXStopAll is a combined action command, which sends the StopFX command and stops FX VLJ actions.

Example

ClickFXStopAll

Notes

FX Tab - Stop All button

ClickFxVlj

ClickFxVlj is the action performed by the 8 VLJ buttons in the QuickFX tab. It enables, disables, or toggles the corresponding VLJ button state. You must specify the line index. Default action: toggle.

Syntax

clickfxvlj(float)clickfxvlj(float, float)

Parameters

Name	Type	Description
`line`	float	FX line index
`line`	float	FX line index
`action`	float	0 disable (default), 1 enable, 2 toggle

Example

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

Notes

Toggle the first FX-VLJ

Code

Restart

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.

Example

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

Notes

Random BPM
Restart is the oldest tool for making a loop, which is typical for the WaitFor... action... restart pattern. You may also look at the GOTO instruction.

Exit

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

Example

Exit

CodeShortcut

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

Syntax

codeshortcut(string)

Parameters

Name	Type	Description
`shortcutname`	string	The string with the shortcut name

Examples

CodeShortcut "Ctrl+D"

CodeShortcut "F2"

Notes

Set CTRL+D shortcut
Set F2 shortcut
Based on the Delphi implementation of shortcut naming

CodeName

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.

Syntax

codename(string)

Parameters

Name	Type	Description
`name`	string	Specify the name of the scripter

Example

CodeName "MyCode"

Notes

Define the UI name and identifier of this scripter

CodeColorMarker

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

Syntax

codecolormarker(integer)

Parameters

Name	Type	Description
`color`	integer	RGB GDI color

Example

CodeColorMarker 0x00FF00

Notes

Green color marker

Autostart

Enables auto-start of the script. This script option applies to scripts located in the PangoScript tab. This command tells BEYOND that this script must be executed at startup.

Example

AutoStart

Notes

Enable auto-start of this script

Warning

Works only in scripts where applicable, such as the PangoScript tab

StopOnBlackout

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.

Syntax

stoponblackout(integer)

Parameters

Name	Type	Description
`mode`	integer	0 - off, 1 - on

Example

StopOnBlackout 1

Notes

Enable script stop on Blackout

StartCode

Starts execution of the script with the specified name. This command is also overloaded: you can add more arguments, and they will form a parameter list. To read a parameter in the script, use the param(index) function, where index is the index of the parameter.

Syntax

startcode(string)

Parameters

Name	Type	Description
`name`	string	Name of the script to start

Examples

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

Notes

Find the scripter(s) with the specified name and start execution. No parameters.
Start code and supply parameters
StartCode is not a procedure/function-like call. It instructs the internal BEYOND core to start code.
The command starts all scripts with the specified name.

StopCode

Stops execution of scripts with the specified name.

Syntax

stopcode(string)

Parameters

Name	Type	Description
`name`	string	name of the script

Example

StopCode "MyCode"

Notes

Find the scripter with the specified name and stop execution

Projection Zone - the destination

UnselectAllZones

Clears the selection state of all Projection Zones. After this command, no zones remain selected.

Example

UnselectAllZones

Notes

Unselect all projection zones
Note: since BEYOND 5.5 there are multiple selection buffers. For zones, the selection is not as simple as a property of the Zone object.

StoreZoneSelection

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.

Example

StoreZoneSelection // use ReStoreZoneSelection to revert back

Notes

Store the zone selection
Since Projection Zones are stored in a global array, other scripts may modify the zone selection state at the same time.
To avoid conflicts, set LinePerCycle to a sufficiently large value so your script completes in a single iteration.

ReStoreZoneSelection

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

Example

ReStoreZoneSelection

Notes

Restore previously saved zone selection

SelectZone

The command accepts multiple arguments. A string is treated as a zone name, and a numeric value is treated as a zone index. You can specify multiple names or indexes in any order. The command adds each Projection Zone to the current Master Selection Array. The order of the zones in this array is important for time-shift operations.

Example

SelectZone 1,2,3, "Scanner 2 main"

Notes

Zone selected in the Master Selection array

UnSelectZone

Removes the Selected state from the specified Projection Zones. The command accepts multiple arguments: strings as zone names, and numbers as zone indexes.

Example

UnSelectZone 1 // index or names

ToggleSelectZone

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

Example

ToggleSelectZone 1

Notes

Zone index, 1..N.

MuteSelectedZones

Sets the muted state for the selected Projection Zones only.

Syntax

muteselectedzones(integer)

Parameters

Name	Type	Description
`action`	integer	0 - off, 1 - on, 2 - toggle

Example

MuteSelectedZones OFF

Notes

ON, OFF, TOGGLE

Tabs

SelectTabName

Selects a Tab by name. Operations by name are better for exact/safer scripting.

Syntax

selecttabname(string)

Parameters

Name	Type	Description
`param1`	string

Example

SelectTabName "Graphics" //define Page name!

Notes

Select tab by name

SelectTab

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.

Syntax

selecttab(integer)

Parameters

Name	Type	Description
`index`	integer	tab index

Example

SelectTab 1 //

Notes

Select tab by index
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

SelectNextTab

Goes to the next tab in the workspace. The Grid is defined by the SelectGrid command.

Example

SelectNextTab

Notes

Select next tab
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

SelectPrevTab

Selects the previous Tab of the Grid. The Grid is defined by the SelectGrid command.

Example

SelectPrevTab

Notes

Select previous tab
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

Pages

SelectPageName

Selects a page by name. The string is case-sensitive.

Syntax

selectpagename(string)

Parameters

Name	Type	Description
`name`	string	page name

Example

SelectPageName "Graphics" // define Page name!

Notes

Select page by name
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

SelectPage

Page is an absolute index, used as the cue address. The Tab is the UI side. The Grid may show a subset of Pages depending on the selected Category.

Syntax

selectpage(integer)

Parameters

Name	Type	Description
`page`	integer	page index

Example

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

Notes

Select page by index
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

SelectNextPage

Goes to the next page in the workspace. The Grid is defined by the SelectGrid command.

Example

SelectNextPage

Notes

Select next page
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

SelectPrevPage

Selects the previous Page of the Grid. The Grid is defined by the SelectGrid command.

Example

SelectPrevPage

Notes

Select previous page
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

Category selection

SelectAllCat

Shows Grid pages of all categories.

Example

SelectAllCat

Notes

Show all pages

SelectCatName

Shows only the Grid pages belonging to the specified category.

Syntax

selectcatname(string)

Parameters

Name	Type	Description
`name`	string	Category name

Example

SelectCatName "Graphics"

Notes

Define the correct Category name.

SelectCat

Shows only the Grid pages belonging to the specified category.

Syntax

selectcat(integer)

Parameters

Name	Type	Description
`index`	integer	Category index (1-based)

Example

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

Notes

Select page category by index

SelectNextCat

Goes to the next category in the workspace. The Grid is defined by the SelectGrid command.

Example

SelectNextCat

Notes

Select next category

SelectPrevCat

Goes to the previous category in the workspace. The Grid is defined by the SelectGrid command.

Example

SelectPrevCat

Notes

Select previous category

Universe page navigation

SetUEditPage

This command selects a page of the Editor Universe panel using either its index or its name.

Syntax

setueditpage(float)setueditpage(string)

Parameters

Name	Type	Description
`index`	float	Universe page index
`name`	string	Universe page name

Example

SetUEditPage 1

Notes

Set the Universe page in the editor

SetUCenterPage

This command selects a page of the Universe panel, located in the central area, using either its index or its name.

Syntax

setucenterpage(float)setucenterpage(string)

Parameters

Name	Type	Description
`index`	float	Universe page index
`name`	string	Universe page name

Example

SetUCenterPage 1 // set first page

Notes

Set the Universe page in the main area

SetUToolPage

This command selects a page of the Universe panel, located in the QuickTools area, using either its index or its name.

Syntax

setutoolpage(float)setutoolpage(string)

Parameters

Name	Type	Description
`index`	float	Universe page index
`name`	string	Universe page name

Example

SetUToolPage 1

Notes

Set the Universe page in the QuickTools area

SetURightPage

This command selects a page of the Universe panel, located in the right-side area, using either its index or its name.

Syntax

seturightpage(float)seturightpage(string)

Parameters

Name	Type	Description
`index`	float	Universe page index
`name`	string	Universe page name

Example

SetURightPage 1

Notes

Set the Universe page in the right-side area

SetUPreviewPage

This command selects a page of the Universe panel, located in the preview area, using either its index or its name.

Syntax

setupreviewpage(float)setupreviewpage(string)

Parameters

Name	Type	Description
`index`	float	Universe page index
`name`	string	Universe page name

Example

SetUPreviewPage 1

Notes

Set the Universe page in the Preview area

SetUMaxPage

This command selects a page of the Universe panel, located in UMAX, using either its index or its name.

Syntax

setumaxpage(float)setumaxpage(string)

Parameters

Name	Type	Description
`index`	float	Universe page index
`name`	string	Universe page name

Example

SetUMaxPage 1

Notes

Set the Universe page in UMAX

ToggleUEditPage

This command performs page navigation (Universe editor). A numeric argument triggers a relative action (go to the previous or next page). A string argument selects a page by its name.

Syntax

toggleueditpage(float)toggleueditpage(string)

Parameters

Name	Type	Description
`offs`	float	Offset; use negative to go to the previous page and positive to go to the next page
`pagename`	string	Page name

Example

ToggleUEditPage 1 // next page

Notes

Universe page navigation (editor)

ToggleUCenterPage

This command performs page navigation (Universe docked to the main window). A numeric argument triggers a relative action (go to the previous or next page). A string argument selects a page by its name.

Syntax

toggleucenterpage(float)toggleucenterpage(string)

Parameters

Name	Type	Description
`offs`	float	Offset; use negative to go to the previous page and positive to go to the next page
`pagename`	string	Page name

Example

ToggleUCenterPage 1 // next page

Notes

Universe page navigation (center area)

ToggleUToolPage

This command performs page navigation (Universe docked into the QuickTools area). A numeric argument triggers a relative action (go to the previous or next page). A string argument selects a page by its name.

Syntax

toggleutoolpage(float)toggleutoolpage(string)

Parameters

Name	Type	Description
`offs`	float	Offset; use negative to go to the previous page and positive to go to the next page
`pagename`	string	Page name

Example

ToggleUToolPage 1 // next page

Notes

Universe page navigation (QuickTools)

ToggleURightPage

This command performs page navigation (Universe docked into the right-side tabs). A numeric argument triggers a relative action (go to the previous or next page). A string argument selects a page by its name.

Syntax

toggleurightpage(float)toggleurightpage(string)

Parameters

Name	Type	Description
`offs`	float	Offset; use negative to go to the previous page and positive to go to the next page
`pagename`	string	Page name

Example

ToggleURightPage 1 // next page

Notes

Universe page navigation (right side)

ToggleUPreviewPage

This command performs page navigation (Universe docked into the main Preview panel). A numeric argument triggers a relative action (go to the previous or next page). A string argument selects a page by its name.

Syntax

toggleupreviewpage(float)toggleupreviewpage(string)

Parameters

Name	Type	Description
`offs`	float	Offset; use negative to go to the previous page and positive to go to the next page
`pagename`	string	Page name

Example

ToggleUPreviewPage 1 // next page

Notes

Universe page navigation (preview)

ToggleUMaxPage

This command performs page navigation (UMAX window). A numeric argument triggers a relative action (go to the previous or next page). A string argument selects a page by its name.

Syntax

toggleumaxpage(float)toggleumaxpage(string)

Parameters

Name	Type	Description
`offs`	float	Offset; use negative to go to the previous page and positive to go to the next page
`pagename`	string	Page name

Example

ToggleUMaxPage 1 // next page

Notes

Universe page navigation (umax)

ProTracks

SelectProTrack

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

Example

SelectProTrack 1

Notes

Index(es) (1..N) or name (string). More than one argument can be used

UnselectProTrack

Clears the selection state of the specified ProTracks. The command accepts multiple arguments: strings as ProTrack names, and numbers as ProTrack indexes.

Example

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

Notes

Unselect ProTracks

ToggleSelectProTrack

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.

Example

ToggleSelectProTrack 1

Notes

Index(es) (1..N) or name(s)

UnselectAllProTracks

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

Example

UnselectAllProTracks

Notes

Unselect all ProTracks

MuteAllProTracks

Mutes all ProTracks in BEYOND. In the muted state the calculation still happens, but output to the laser is disabled.

Example

MuteAllProTracks

Notes

Mute all ProTracks

UnmuteAllProTracks

Removes the muted state from all ProTracks.

Example

UnmuteAllProTracks

Notes

Unmute all ProTracks

MuteProTrack

Mutes the specified ProTracks. The command accepts multiple arguments: strings as ProTrack names, and numbers as ProTrack indexes.

Example

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

Notes

Mute ProTrack

UnmuteProTrack

Removes the muted state from the specified ProTracks. The command accepts multiple arguments: strings as ProTrack names, and numbers as ProTrack indexes.

Example

UnmuteProTrack 1, 2, 3, 4

Notes

Unmutes the first four ProTracks. Numeric ProTrack indexes start at 1.

ToggleMuteProTrack

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.

Examples

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

ToggleMuteProTrack 1,2,3,4 //

Notes

Toggle Mute of the 1st ProTrack
Toggle Mute of multiple ProTracks

UnSoloAllProTrack

Removes the Solo state from all ProTracks.

Example

UnSoloAllProTrack

Notes

Remove Solo state from all ProTracks

SoloProTrack

Sets the Solo state on the specified ProTracks. The command accepts multiple arguments: strings as ProTrack names, and numbers as ProTrack indexes.

Example

SoloProTrack 1

Notes

Index(es) or name(s)

UnSoloProTrack

Removes the Solo state from the specified ProTracks. The command accepts multiple arguments: strings as ProTrack names, and numbers as ProTrack indexes.

Example

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

Notes

Remove the Solo state from a ProTrack

ToggleSoloProTrack

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

Example

ToggleSoloProTrack 1

Notes

Index(es) or name(s)

StopProTrack

Stops playback of the specified ProTracks. The command accepts multiple arguments: strings as ProTrack names, and numbers as ProTrack indexes.

Example

StopProTrack 1,2,3,4

Notes

Stop playback on ProTracks 1, 2, 3, and 4

StopProTrackFX

Stops ProTrack effects. With no arguments, stops all effects on all ProTracks. To stop particular effect layers on one ProTrack, supply its name or one-based index followed by one or more one-based layer indexes.

Examples

StopProTrackFX

StopProTrackFX 1, 1

Notes

StopProTrackFX 1, 1 stops effect layer 1 on ProTrack 1.
Do not use the single-argument form to target only one ProTrack: the current implementation also clears effects on all ProTracks.

FocusProTrack

Defines the focused ProTrack in the UI.

Syntax

focusprotrack(string)focusprotrack(float)

Parameters

Name	Type	Description
`name`	string	ProTrack name
`index`	float	ProTrack index (1 based)

Example

FocusProTrack 1 // Track index or name

Notes

Focus the 1st ProTrack

SetProTrackZones

Defines routing information for the specified ProTrack. Routing consists of one or more Projection Zones. The first argument is the ProTrack name or index. If the name does not exist or the index is out of range, the command exits silently. The second and subsequent arguments are the Projection Zones, specified either by name or index. String values are treated as names; numeric values are treated as indexes.

Example

SetProTrackZones 1, "Scanner 1 Main", "Scanner 2 Main" // Track index/name, Zone name(es)/index(es)

Notes

Set routing of the 1st ProTrack to two zones by name

Files

LoadWorkspace

Loads a workspace from file. This is an HTTP-oriented command; do not use it directly in scripts.

Syntax

loadworkspace(string)

Parameters

Name	Type	Description
`filename`	string	Workspace file name

Example

LoadWorkspace "c:\MyWorkspace.BeyondWorkspace"

Notes

Open a workspace file

Warning

File operation commands are experimental

LoadCue

Loads a file into the current cue of the primary grid.

Syntax

loadcue(string)

Parameters

Name	Type	Description
`filename`	string	File name of the content. The file must be compatible with BEYOND

Example

LoadCue "c:\MyAnimationFile.bani"

Notes

Load a file into the current cue

Warning

This is an experimental command. We do not recommend using it.

MIDI, DMX, Channel, OSC output

SelectMidi

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

Syntax

selectmidi(integer)

Parameters

Name	Type	Description
`dev`	integer	MIDI device index (1 to 4)

Example

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

Notes

Associate the script with MIDI OUT

MidiOut

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.

Syntax

midiout(integer, integer, integer)midiout(integer, integer, integer, integer)

Parameters

Name	Type	Description
`msg`	integer	First byte of the MIDI message (128..255).
`data1`	integer	Second byte of the MIDI message (0..127)
`data2`	integer	Third byte of the MIDI message (0..127)
`msg`	integer	First byte of the MIDI message (128..255).
`data1`	integer	Second byte of the MIDI message (0..127)
`data2`	integer	Third byte of the MIDI message (0..127)
`DevIndex`	integer	Index of the MIDI OUT device in the BEYOND Configuration (1..4)

Example

MidiOut 0x90, 0x40, 0x7F

Notes

Send MIDI Note On

MidiOutLong

Sends the supplied numeric values as bytes in one long MIDI message to the output device selected for this script. Each value is clamped to 0..255.

Example

MidiOutLong 0xF0, 0x7D, 0x01, 0xF7

Notes

The example sends the bytes shown. The target device determines how it interprets the message.
For larger SysEx messages, use MidiSysexStart, MidiSysexAdd, and MidiSysexSend.
Use SelectMidi to select the MIDI device.

MidiSysexStart

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

Example

MidiSysexStart

Notes

Clear the Sysex buffer

MidiSysexAdd

Writes parameters as bytes into the local sysex stream. See the MidiSysexStart description.

Examples

MidiSysexAdd "F0477F"

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

Notes

Add data to the Sysex buffer; the string must represent a sequence of hex values. You may also use integer parameters.
Simple byte writing to the sysex stream

MidiSysexSend

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

Example

MidiSysexSend

Notes

Send the prepared sysex buffer

DmxOut

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

Syntax

dmxout(float, float)dmxout(float, float, float)

Parameters

Name	Type	Description
`chan`	float	DMX channel index. BEYOND uses a flat output buffer of 1..2048 channels.
`v`	float	0 to 255 are data values. -1 means transparent value.
`chan`	float	DMX channel index. BEYOND uses a flat output buffer of 1..2048 channels.
`v`	float	0 to 255 are data values. -1 means transparent value.
`v2`	float	Value for the next channel. Made for 16-bit values

Example

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

Notes

DMX output to the 1st channel
BEYOND DMX OUT has 4 universes. All data is placed in one flat array. Channel addressing is 1 to 2048. Output to specific devices or protocols can be set up in the DMX Settings dialog.

DmxInMute

Mutes or unmutes incoming DMX channels. Supply a channel index and state, or an inclusive range of channel indexes and state. This command uses zero-based channel indexes: 0 is the first channel.

Syntax

dmxinmute(float, float)dmxinmute(float, float, float)

Parameters

Name	Type	Description
`channel`	float	Zero-based input channel index.
`muted`	float	1 mutes input; 0 unmutes input.
`from`	float	First zero-based input channel index.
`to`	float	Last zero-based input channel index, inclusive.
`muted`	float	1 mutes input; 0 unmutes input.

Examples

DmxInMute 0, 1 // mute the first input channel

DmxInMute 0, 0 // unmute the first input channel

DmxInMute 0, 511, 0 // unmute the first input universe

Notes

Unlike many other DMX commands, this command addresses the first input channel as 0.

ChannelOut

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.

Syntax

channelout(integer, integer)

Parameters

Name	Type	Description
`index`	integer	Channel index in the range 1 to 255.
`value`	integer	Channel value. This is an old command with an unusual range: 0 is the min value and 1000 is the max value. Internally it is mapped to the 0..1 range.

Examples

ChannelOut 1, 1000

ChannelOut 1, 500

Notes

Set the first channel to 1000 (max value)
Set the first channel to 50% value

OscOut

Sends an OSC message. The Type Tag String is composed from the types of the arguments. The first argument must be a string with the OSC address. The command uses the OSC Client socket.

Example

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

Notes

Set beam 1 position to [-5,100]

OscOutTTS

Sends an OSC message. First argument - OSC address, string. Second argument - OSC TTS, string. Third, 4th, etc. - OSC message values. The command uses the OSC Client socket.

Example

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

Notes

Send OSC message

Pause between commands

Sleep

The Sleep instruction puts the script into a waiting state for the specified number of milliseconds.

Syntax

sleep(integer)

Parameters

Name	Type	Description
`ms`	integer	sleep duration in milliseconds

Example

Sleep 1000

Notes

Pause script execution (sleep)
Exact timing is not guaranteed due to multithreading and timer-based operations.

Starting exe files

RunApp

Calls Windows ShellExec(), which can start any application or other command line. The command is disabled by default. Main purpose: automation in installation projects.

Syntax

runapp(string, string)

Parameters

Name	Type	Description
`app`	string	executable
`param`	string	command line

Example

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

Notes

Full exe file name, parameters

Warning

DANGEROUS COMMAND. Disabled by default.

Waiting for events - time, beats, DMX, etc

WaitForMidi

The WaitForMIDI instruction puts the scripter into a waiting state for a MIDI message. param(1) - first byte of the MIDI message (msg) param(2) - second byte of the MIDI message (data1) param(3) - third byte of the MIDI message (data2) Data2 is also stored as extvalue in normalized form.

Syntax

waitformidi(integer, integer, integer)

Parameters

Name	Type	Description
`msg`	integer	-1 for any 1st byte value, or 128..255 for a specific message
`data1`	integer	-1 for any value, or 0 to 127 for a specific value
`data2`	integer	-1 for any value, or 0 to 127 for a specific value

Example

WaitForMidi 0x90, -1, -1
DisplayPopup param(1), param(2), param(3)
restart

Notes

Wait for any NoteOn on MIDI channel 0

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForDmx

param(1) - DMX channel index param(2) - DMX channel value

Syntax

waitfordmx(integer)

Parameters

Name	Type	Description
`ch`	integer	DMX Channel index

Example

WaitForDmx 1
DisplayPopup param(2)
restart

Notes

Wait for a change of DMX IN Channel 1

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForChannel

WaitForChannel puts the script into a waiting state for a channel value. param(1) - channel index param(2) - channel value

Syntax

waitforchannel(integer)

Parameters

Name	Type	Description
`index`	integer	channel index 1 to 255. -1 for any value

Example

WaitForChannel -1
displaypopup param(1), param(2)
restart

Notes

Wait for any channel change

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForCueStart

The WaitForCueStart command puts the script into a waiting state until a cue playback starts. This command is not related to UI cell interaction. The hook is placed in the playback engine that manages player allocation. If you click on an empty grid cell to start a new cue, this waiting operation will not respond. When triggered, the fired cue and page indexes are stored as script parameters. Use param(1) to get the page index and param(2) to get the cue index. Note that BEYOND uses zero-based indexing internally, so both param(1) and param(2) return zero-based values.

Syntax

waitforcuestart(integer, integer)

Parameters

Name	Type	Description
`page`	integer	Page index, starting at 1
`cue`	integer	Cue index, starting at 1

Example

WaitForCueStart -1,-1
displaypopup param(1)+1, param(2)+1
restart

Notes

Wait for any cue to start

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForCueStop

The WaitForCueStop command puts the script into a waiting state until a cue playback stops. The hook is placed in the playback engine that manages player allocation. When triggered, the stopped cue and page indexes are stored as script parameters. Use param(1) to get the page index and param(2) to get the cue index. Note that BEYOND uses zero-based indexing internally, so both param(1) and param(2) return zero-based values.

Syntax

waitforcuestop(integer, integer)

Parameters

Name	Type	Description
`page`	integer	Page index, starting at 1
`cue`	integer	Cue index, starting at 1

Example

WaitForCueStop 1, 1 //page 1, cue 1
displaypopup "stopped..."
restart

Notes

Wait for a cue to stop

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForCellDown

Waits for a click (cell down) on the content grid. Use -1 to wait for any click (cell down) on the grid; otherwise, specify the exact cell index. The function Param(1) returns the zero-based cell index.

Syntax

waitforcelldown(integer)

Parameters

Name	Type	Description
`cellindex`	integer	Use -1 for any cell of the grid. Use 1..255 for a specific cell-down event

Examples

// run this script in PangoScript tab
// click on left/top cell of content grid.
waitforcelldown 1
displaypopup "cell down"
restart

// run this script in PangoScript tab
WaitForCellDown -1 // -1 means any cell
displaypopup param(1)+1 // index is zero based internally
restart

Notes

Wait for cell down on a Grid cell
Any cell mouse down
The BEYOND UI represents the content page as a 2D grid (matrix) with columns and rows. However, the internal implementation is a flat 1D array with indexing starting at zero.
Cell operations relate to the UI Grid, which shows the current page of the workspace. This waiting operation is not connected to a specific cue; it is connected to a UI cell.

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForCellUp

Waits for a click release (cell up) on the content grid. Use -1 to wait for any click release (cell up) on the grid; otherwise, specify the exact cell index. The function Param(1) returns the zero-based cell index.

Syntax

waitforcellup(integer)

Parameters

Name	Type	Description
`cellindex`	integer	Waits for a click (cell down) on the content grid. Use -1 to wait for any click (cell down) on the grid; otherwise, specify the exact cell index.

Examples

// run this script in PangoScript tab
// click on left/top cell of content grid.
waitforcellup 1
displaypopup "cell down"
restart

// run this script in PangoScript tab
waitforcellup -1
displaypopup param(1)+1 // index is zero based internally
restart

Notes

Wait for key up on a Grid cell
Any cell mouse up
Cell operations relate to the UI Grid, which shows the current page of the workspace. This waiting operation is not connected to a specific cue; it is connected to a UI cell.

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForTime

The WaitForTime command puts the scripter into a waiting state until the specified time is reached. Once the system clock passes the defined time, the waiting ends and the next command is executed.

Syntax

waitfortime(integer, integer, integer, integer)

Parameters

Name	Type	Description
`h`	integer	hour
`m`	integer	minute
`s`	integer	second
`ms`	integer	millisecond

Example

// NOTE: THIS IS NOT GOOD FOR SCHEDULER.
// at 15:30
WaitForTime 15,30,0,0 // hours, minutes, seconds, ms
StartCue 1,1
// at 15:40
WaitForTime 15,40,0,0 // hours, minutes, seconds, ms
StartCue 1,2

Notes

Example of chained waiting - PC clock

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForTimePos

This wait command waits for a time period measured from the start of script execution. This is a relative-time command. The Restart command resets the local script time.

Syntax

waitfortimepos(integer, integer, integer, integer)

Parameters

Name	Type	Description
`h`	integer
`m`	integer
`s`	integer
`ms`	integer

Example

// beginning
WaitForTimePos 0,0,0,0
StartCue 1,1
// minute later
WaitForTimePos 0,1,0,0
StartCue 1,2
// in 2 minutes
WaitForTimePos 0,2,0,0
StartCue 1,3

Notes

Hours, minutes, seconds, ms

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForTC

The WaitForTC command puts the scripter into a waiting state until the specified TIMECODE time is reached. Once the incoming timecode passes the defined time, the waiting ends and the next command is executed. param(1) has current timecode time in seconds.

Syntax

waitfortc(integer, integer, integer, integer)

Parameters

Name	Type	Description
`h`	integer	Hours 0 to 23
`m`	integer	Minutes 0 to 59
`s`	integer	Seconds 0 to 59
`ms`	integer	Milliseconds 0 to 9990

Example

// NOTE: THIS IS NOT TIMELINE. THIS JUST SEQUENTIAL WAITING
// at 00:00:00:000
WaitForTC 0,0,0,0 // hours, minutes, seconds, ms
StartCue 1,1
// at 00:00:30:000
WaitForTC 0,0,30,0 // hours, minutes, seconds, ms
StartCue 1,2

Notes

Example of chained waiting - incoming timecode

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForHotKey

Each scripter has a hotkey. This wait command lets you wait for the hotkey press and then perform an action.

Example

WaitForHotKey
DmxOut 1, 255
Sleep 1000
DmxOut 1, 0
restart

Notes

Wait for the hotkey assigned to this script in the Code tab

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForAudioBeat

Puts the Scripter into a waiting state for the audio-beat event.

Syntax

waitforaudiobeat(integer)

Parameters

Name	Type	Description
`count`	integer	Specifies the number of events to wait before reacting. The default value is 1, meaning the command responds to every event.

Example

WaitForAudioBeat 1 // waiting instruction, every beat
master.color = randomin(32,255) // example of action - random color of master lc.
restart // jump to script start, and immediatelly run into waiting state

Notes

Every audio beat

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForManualBeat

Puts the Scripter into a waiting state for the manual-beat event.

Syntax

waitformanualbeat(integer)

Parameters

Name	Type	Description
`count`	integer	Specifies the number of events to wait before reacting. The default value is 1, meaning the command responds to every event.

Example

WaitForManualBeat 1 // every manual beat
displaypopup "Manual beat!" // ui message as an action
restart // jump to script start, and immediatelly run into waiting state

Notes

Message on manual beat

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForTimerBeat

Puts the Scripter into a waiting state for the timer-beat event. The best approach for waiting scripts is to put them in the PangoScript tab and use a structure like: WaitFor... // your action, executes once waiting completes. Restart

Syntax

waitfortimerbeat(integer)

Parameters

Name	Type	Description
`count`	integer	Specifies the number of events to wait before reacting. The default value is 1, meaning the command responds to every event.

Example

WaitForTimerBeat 4 // waiting instruction
master.brightness = randomin(0,100) // example of action - random brightness
restart // jump to script start, and immediatelly run into waiting state

Notes

Wait for and react to every 4th beat

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.

WaitForBeat

Puts the Scripter into a waiting state. The WaitForBeat instruction waits for a beat defined by the mask parameter.

Syntax

waitforbeat(integer, integer)

Parameters

Name	Type	Description
`mask`	integer	Bit mask. 1 is timer beat. 2 is manual beat. 4 is audio beat.
`count`	integer	Specifies the number of events to wait before reacting. The default value is 1, meaning the command responds to every event.

Example

WaitForBeat 7, 1 // any and every of beats
displaypopup "Booom!" // ui message as an action
restart // jump to script start, and immediatelly run into waiting state

Notes

Multi beat source waiting

Network

Hello

The Hello command is a connection test command. Suggested use case: the "TCP Talk Server". Essentially, this is plain-text communication, one command per line. Your application connects to BEYOND and sends the Hello command. The response will be "Hello!".

Example

hello

Notes

The answer will be Hello!

Echo

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”.

Syntax

echo(integer)

Parameters

Name	Type	Description
`mode`	integer	0, 1, 2; see the command description

Example

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

Notes

TCP Talk Server echo mode

Password

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. There is no password by default. [General] TcpTalkServerPassword=12345

Syntax

password(string)

Parameters

Name	Type	Description
`pass`	string	Password string.

Example

password "enter pasword here"

Notes

Password for TCP Talk Server

Version

The Version command is designed for the TCP Talk Server. BEYOND will respond with the exe version information.

Example

version

Notes

The remote server will get the exe file version

Dynamics - Limiters

SetLimiterProfile

Chooses between 3 limiter profiles.

Syntax

setlimiterprofile(integer)

Parameters

Name	Type	Description
`index`	integer	profile index, range 0 to 2

Example

SetLimiterProfile 1

Notes

Select limiter profile
Does not apply in Group mode

SetLimiterPerZone

This command belongs to the SetLimiter... group. Live/Grid playback uses a dedicated pool of cue players, which operates under specific rules such as limiters that define the maximum number of simultaneously playing cues by type.

Syntax

setlimiterperzone(integer)

Parameters

Name	Type	Description
`max`	integer	max number of cues

Example

SetLimiterPerZone 3 // do not use this

Notes

Set limiter per zone (deprecated)
Does not apply in Group mode

Warning

This is a legacy command and concept.
BEYOND does not play zones—it plays content. The content is then routed to zones.
You should plan and limit the content itself rather than attempting to restrict the output to specific zones.
In other words, define where the content should go at the start of the processing chain, not at the end.

SetLimiterPerGrid

Syntax

setlimiterpergrid(integer)

Parameters

Name	Type	Description
`max`	integer	Max number of cues in total (per grid)

Example

SetLimiterPerGrid 10

Notes

Set max number of cues in Live mode
Does not apply in Group mode

SetLimiterFlash

Syntax

setlimiterflash(integer)

Parameters

Name	Type	Description
`max`	integer	max number of cues in Flash mode

Example

SetLimiterFlash 4

Notes

Set max Flash mode cues in Live mode
Does not apply in Group mode

SetLimiterHold

Syntax

setlimiterhold(integer)

Parameters

Name	Type	Description
`max`	integer	max number of cues in HOLD mode

Example

SetLimiterHold 3

Notes

Set max Hold mode cues in Live mode
Does not apply in Group mode

SetLimiterBeam

Syntax

setlimiterbeam(integer)

Parameters

Name	Type	Description
`max`	integer	max number of cues of this type

Example

SetLimiterBeam 5

Notes

Set max beam cues in Live mode
Does not apply in Group mode

SetLimiterDMX

Syntax

setlimiterdmx(integer)

Parameters

Name	Type	Description
`max`	integer	max number of cues of this type

Example

SetLimiterDMX 5

Notes

Set max DMX cues in Live mode
Does not apply in Group mode

SetLimiterShow

Syntax

setlimitershow(integer)

Parameters

Name	Type	Description
`max`	integer	max number of cues of this type

Example

SetLimiterShow 2

Notes

Set max timeline cues in Live mode
Does not apply in Group mode

Timeline editor

PlayTimeline

Plays the current timeline.

Syntax

playtimeline()

Example

PlayTimeline

Notes

TimelinePlay is an alias for the same operation.

StopTimeline

Stops timeline playback.

Syntax

stoptimeline()

Example

StopTimeline

Notes

TimelineStop is an alias for the same operation.

TimelineShowItNow

Command from the Timeline Editor group. Defines the state of the ShowItNow button (output to laser).

Syntax

timelineshowitnow(float)

Parameters

Name	Type	Description
`state`	float	0 - disabled, 1 - enabled

Example

TimelineShowItNow 1

Notes

Set online mode for timeline editor

TimelineSetPos

Sets the timeline position in seconds.

Syntax

timelinesetpos(float)

Parameters

Name	Type	Description
`time`	float	time in seconds

Example

TimelineSetPos 10 // 10th second.

Notes

Set timeline position

TimelineJumpToStart

Command from the Timeline Editor group. Jumps to the beginning of the timeline.

Example

TimelineJumpToStart

TimelineJumpToEnd

Command from the Timeline Editor group. Jumps to the end of the timeline.

Example

TimelineJumpToEnd

TimelineJumpDelta

Shifts the timeline cursor position by the specified number of seconds.

Syntax

timelinejumpdelta(float)

Parameters

Name	Type	Description
`seconds`	float	time in seconds

Example

TimelineJumpDelta 1

Notes

One second

TimelineSetViewRange

Sets the timeline visibility range (timeline view area from left to right).

Syntax

timelinesetviewrange(float, float)

Parameters

Name	Type	Description
`from`	float	start time
`to`	float	end time

Example

TimelineSetViewRange 1,5

Notes

From 1 to 5 seconds

TimelineShiftViewRange

Shifts the timeline visibility left or right.

Syntax

timelineshiftviewrange(float)

Parameters

Name	Type	Description
`time`	float	time in seconds

Example

TimelineShiftViewRange 1 //one second shift

Notes

Shift timeline view by one second

TimelineMarker

Adds a marker to the current timeline. With no arguments, it uses the current cursor position and current marker color. With one argument, it selects the color at the current cursor position. With two arguments, it selects the color and the time in seconds.

Syntax

timelinemarker()timelinemarker(integer)timelinemarker(integer, float)

Parameters

Name	Type	Description
`color`	integer	Marker color index, starting at 1.
`color`	integer	Marker color index, starting at 1.
`time`	float	Timeline position in seconds.

Examples

TimelineMarker

TimelineMarker 1

TimelineMarker 1, 1.0

Notes

TimelineAddMarker is an alias and accepts the same arguments.
TimelineMarker 1, 1.0 adds a marker at one second using the first marker color.

TimelineAddMarker

Syntax

timelineaddmarker()timelineaddmarker(integer)timelineaddmarker(integer, float)

Parameters

Name	Type	Description
`color`	integer	Marker color index, starting at 1.
`color`	integer	Marker color index, starting at 1.
`time`	float	Timeline position in seconds.

Examples

TimelineAddMarker

TimelineAddMarker 1

TimelineAddMarker 1, 1.0

Notes

TimelineMarker is an alias and accepts the same arguments.
TimelineAddMarker 1, 1.0 adds a marker at one second using the first marker color.

TimelineNextMarker

Command from the Timeline Editor group. Goes to the next marker (legacy name: log). A marker is a vertical line, a time position on the timeline.

Example

TimelineNextMarker

TimelinePrevMarker

Command from the Timeline Editor group. Goes to the previous marker.

Example

TimelinePrevMarker

TimelineNextEditPoint

Command from the Timeline Editor group. Goes to the next edit point, such as an event boundary, marker, etc.

Example

TimelineNextEditPoint

Notes

Edit point navigation

TimelinePrevEditPoint

Command from the Timeline Editor group. Goes to the previous edit point, such as an event boundary, marker, etc.

Example

TimelinePrevEditPoint

Notes

Edit point navigation

TimelinePlayFromMarker

Command from the Timeline Editor group. Finds the marker by name and starts playback from the marker position.

Syntax

timelineplayfrommarker(string)

Parameters

Name	Type	Description
`name`	string	marker name

Example

TimelinePlayFromMarker "MyMarker" // you should have the name of marker in your timeline.

Notes

Go to a specific timeline marker.

TimelineFirstTab

Command from the Timeline Editor group. Goes to the first timeline/tab of the editor.

Example

TimelineFirstTab

Notes

Timeline tabs navigation

TimelineNextTab

Command from the Timeline Editor group. Goes to the next timeline/tab of the editor.

Example

TimelineNextTab

Notes

Timeline tabs navigation

TimelinePrevTab

Command from the Timeline Editor group. Goes to the previous timeline/tab of the editor.

Example

TimelinePrevTab

Notes

Timeline tabs navigation

TimelineLastTab

Command from the Timeline Editor group. Goes to the last timeline/tab of the editor.

Example

TimelineLastTab

Notes

Timeline tabs navigation

TimelineSetTabIndex

Command from the Timeline Editor group. Goes to a timeline/tab by index.

Syntax

timelinesettabindex(float)

Parameters

Name	Type	Description
`index`	float	Timeline/Tab index

Example

TimelineSetTabIndex 1

Notes

Select timeline in editor by index

TimelineSetTabName

Selects a timeline tab by name.

Syntax

timelinesettabname(string)

Parameters

Name	Type	Description
`param1`	string

Example

TimelineSetTabName "MyShow"

Notes

Select timeline in editor by name

TimelineEnableTC

Enables or disables the use of incoming timecode for playback.

Syntax

timelineenabletc(float)

Parameters

Name	Type	Description
`state`	float	0 - off, 1 - on.

Examples

TimelineEnableTC 1

TimelineEnableTC 0

Play list control

PlayListPlay

Start playback of the current show from the PlayList.

Example

PlayListPlay

Notes

Start playback of the current show in the PlayList

PlayListStop

Stops playback of the show in the PlayList.

Example

PlayListStop

Notes

Stop playback of the current show in the PlayList

PlayListFirst

Goes to the first show in the PlayList.

Example

PlayListFirst

Notes

Select first show in the PlayList

PlayListNext

Goes to the next show in the PlayList.

Example

PlayListNext

Notes

Select the next show in the PlayList

PlayListPrev

Goes to the previous show in the PlayList.

Example

PlayListPrev

Notes

Select previous show in the PlayList

PlayListLast

Goes to the last show in the PlayList.

Example

PlayListLast

Notes

Select last show in the PlayList

PlayListSetPos

Selects a Show from the PlayList by index (1..N).

Syntax

playlistsetpos(float)

Parameters

Name	Type	Description
`param1`	float

Example

PlayListSetPos 1

Notes

Select the 1st show from the PlayList

PlayListSetTime

Jumps to a time position in the current show.

Syntax

playlistsettime(float)

Parameters

Name	Type	Description
`time`	float	Time in seconds. 62.5 is one minute and two and a half seconds

Example

PlayListSetTime 0

Notes

Jump to the start of the current PlayList show.

LoadPlaylist

Opens a file in the BEYOND Playlist window.

Syntax

loadplaylist(string)

Parameters

Name	Type	Description
`filename`	string	File name of BEYOND playlist

Example

LoadPlaylist "c:\MyPlaylist.BeyondSL"

Notes

Open a playlist file

Warning

File operation commands are experimental

Players

InvertPlayersTime

The BEYOND content player supports time direction control, allowing playback to bounce between time points A and B as part of the Time Control section. This command toggles the playback direction for players located in the Grid (dynamic pool) or the ProTrack array. The action depends on the message source—it may apply to selected zones, selected cues, selected ProTracks, or, in the case of a Master/General source, to all ProTracks and Grid players.

Example

InvertPlayersTime

Notes

Invert time direction of players (context dependent)

PlayersSetJump

This command stores the current player time on the first call, and on the second call jumps back to the stored position. It is another variation of DJ-style live time effects.

Example

PlayersSetJump

Notes

Player time - set and jump back
Applicable to ProTracks and Grid/Live cue players only.

PlayersResetJump

Clears the time stored in the player by the PlayerSetJump command. The command may apply to ProTracks and Grid players, depending on the selection.

Example

PlayersResetJump

Notes

Reset stored time
Applicable to ProTracks and Grid/Live cue players only.

PlayersSetLoop

The idea of this feature is to loop the player between two points and allow back-and-forth playback. It provides three actions in total: 1. Store point A. 2. Store point B (looping begins). 3. Clear the loop settings.

Syntax

playerssetloop(integer)

Parameters

Name	Type	Description
`action`	integer	-1 - auto, 0 - clear, 1 - set point A, 2 - set point B

Example

PlayersSetLoop -1 // automatic mode, set A, set B, clear.

Notes

Playback A-B loop
Applicable to ProTracks and Grid/Live cue players only.

PlayersDisk

Time Control command. The DJ Disk located in the Time Control tab can slow down playback as well as time-shift (scratch). If you need a time-shift-only action, see the PlayerDiskShift command.

Syntax

playersdisk(float)playersdisk(float, float)

Parameters

Name	Type	Description
`speed`	float	The speed ratio, in the 0 to 1 range. The DJ disk can slow down playback.
`speed`	float	The speed ratio, in the 0 to 1 range. The DJ disk can slow down playback.
`offset`	float	Time shift injected by the disk. Scratch effect.

Example

PlayersDisk 1, 0.1 // speed scale, the shift

Notes

DJ Disk
Applicable to ProTracks and Grid/Live cue players only.

PlayersDiskShift

Time Control command. This command is a simplified version of PlayerDisk. The shift is applied to the clock and beat time components.

Syntax

playersdiskshift(float)

Parameters

Name	Type	Description
`shift`	float	Time shift injected by the disk. Scratch effect.

Example

PlayersDiskShift 0.1

Notes

DJ shift only
Applicable to ProTracks and Grid/Live cue players only.

Trigger Definition (test mode)

DefineTrigger

Syntax

definetrigger(string)definetrigger(string, string)

Parameters

Name	Type	Description
`param1`	string
`param1`	string
`param2`	string

Example

DefineTrigger "2+2"

Notes

Expression...

DefineDmxTrigger

Syntax

definedmxtrigger(integer)definedmxtrigger(integer, string)

Parameters

Name	Type	Description
`param1`	integer
`param1`	integer
`param2`	string

Example

DefineDmxTrigger 1

Notes

Channel

DefineMidiTrigger

Syntax

definemiditrigger(integer, integer)definemiditrigger(integer, integer, string)definemiditrigger(integer, integer, string, integer)

Parameters

Name	Type	Description
`param1`	integer
`param2`	integer
`param1`	integer
`param2`	integer
`param3`	string
`param1`	integer
`param2`	integer
`param3`	string
`param4`	integer

Example

DefineMidiTrigger 0xC0, 0x00

Notes

MIDI Command, MIDI Data 1, Trigger Name (optional), MIDI Dev index from 0 to 3 (optional, by default any)

Trigger Parameters (test mode)

InRangeTrigger

Syntax

inrangetrigger(float, float, string)

Parameters

Name	Type	Description
`param1`	float
`param2`	float
`param3`	string

Example

InRangeTrigger 0,100,"MyLabel"

Notes

Min Value, Max Value, Label name

InRangeTriggerCmd

Syntax

inrangetriggercmd(float, float, string)

Parameters

Name	Type	Description
`param1`	float
`param2`	float
`param3`	string

Example

InRangeTriggerCmd 0,100,"Blackout"

Notes

Min Value, Max Value, Command

OutOfRangeTrigger

Syntax

outofrangetrigger(float, float, string)

Parameters

Name	Type	Description
`param1`	float
`param2`	float
`param3`	string

Example

OutOfRangeTrigger 0,100,"MyLabel"

Notes

Min Value, Max Value, Label name

OutOfRangeTriggerCmd

Syntax

outofrangetriggercmd(float, float, string)

Parameters

Name	Type	Description
`param1`	float
`param2`	float
`param3`	string

Example

OutOfRangeTriggerCmd 0,100,"Blackout"

Notes

Min Value, Max Value, Command

IncreaseTrigger

Syntax

increasetrigger(float, float, string)

Parameters

Name	Type	Description
`param1`	float
`param2`	float
`param3`	string

Example

IncreaseTrigger 0,100,"MyLabel"

Notes

Min Value, Max Value, Label name

DecreaseTrigger

Syntax

decreasetrigger(float, float, string)

Parameters

Name	Type	Description
`param1`	float
`param2`	float
`param3`	string

Example

DecreaseTrigger 0,100,"MyLabel"

Notes

Min Value, Max Value, Label name

MoreThanTrigger

Syntax

morethantrigger(float, string)morethantrigger(float, float, float, float, string)

Parameters

Name	Type	Description
`param1`	float
`param2`	string
`param1`	float
`param2`	float
`param3`	float
`param4`	float
`param5`	string

Example

MoreThanTrigger 0,"MyLabel"

Notes

Value, Label name

LessThanTrigger

Syntax

lessthantrigger(float, string)lessthantrigger(float, float, float, float, string)

Parameters

Name	Type	Description
`param1`	float
`param2`	string
`param1`	float
`param2`	float
`param3`	float
`param4`	float
`param5`	string

Example

LessThanTrigger 0,"MyLabel"

Notes

Value, Label name

Object Property Animation

AnimateProp

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

Syntax

animateprop(string, float, float, float)animateprop(string, float, float, float, string)

Parameters

Name	Type	Description
`prop`	string	String with the identifier. It should be a writable object.property identifier, such as master.brightness
`from`	float	starting value
`to`	float	ending value
`duration`	float	duration in milliseconds
`prop`	string	String with the identifier. It should be a writable object.property identifier, such as master.brightness
`from`	float	starting value
`to`	float	ending value
`duration`	float	duration in milliseconds
`event`	string	Final event name. The event is triggered when the animation completes

Example

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

Notes

Fade in using master brightness over 1 second

AnimatePropDelta

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.

Syntax

animatepropdelta(string, float, float)animatepropdelta(string, float, float, float, string)

Parameters

Name	Type	Description
`prop`	string	String with the identifier. It should be a writable object.property identifier, such as master.brightness
`delta`	float	final change of value
`duration`	float	duration in milliseconds
`prop`	string	String with the identifier. It should be a writable object.property identifier, such as master.brightness
`delta`	float	final change of value
`duration`	float	duration in milliseconds
`event`	float	Final event name. The event is triggered when the animation completes
`error`	string

Example

AnimatePropDelta "master.brightness", -10,1000

Notes

Decrease master brightness by 10% over 1 second

DeletePropAni

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", ...]

Example

DeletePropAni

Notes

"variable", ["variable",..]

Advanced MIDI mapping

SetGrid1MSL

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

Syntax

setgrid1msl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetGrid1MSL 1

Notes

Set layer index for MIDI Main Grid table

SetGrid2MSL

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

Syntax

setgrid2msl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetGrid2MSL 1

Notes

Set layer index for MIDI Secondary Grid table

SetSliderMSL

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

Syntax

setslidermsl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetSliderMSL 1

Notes

Set layer index for MIDI Slider table

SetButtonMSL

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

Syntax

setbuttonmsl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetButtonMSL 1

Notes

Set layer index for MIDI Button table

SetZoneSelMSL

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

Syntax

setzoneselmsl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetZoneSelMSL 1

Notes

Set layer index for MIDI Zone-selected table

SetZoneMuteMSL

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

Syntax

setzonemutemsl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetZoneMuteMSL 1

Notes

Set layer index for MIDI Zone-mute table

SetFX1MSL

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

Syntax

setfx1msl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetFX1MSL 1

Notes

Set layer index for MIDI FX1 table

SetFX2MSL

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

Syntax

setfx2msl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetFX2MSL 1

Notes

Set layer index for MIDI FX2 table

SetFX3MSL

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

Syntax

setfx3msl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetFX3MSL 1

Notes

Set layer index for MIDI FX3 table

SetFX4MSL

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

Syntax

setfx4msl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetFX4MSL 1

Notes

Set layer index for MIDI FX4 table

SetFX5MSL

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

Syntax

setfx5msl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetFX5MSL 1

Notes

Set layer index for MIDI FX5 table

SetFX6MSL

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

Syntax

setfx6msl(float)

Parameters

Name	Type	Description
`ind`	float	layer index

Example

SetFX6MSL 1

Notes

Set layer index for MIDI FX6 table

Mesh

MeshPoint

Adds a point to the mesh being generated. Supply X, Y, Z, and a numeric color; an optional fifth argument names the point.

Syntax

meshpoint(float, float, float, integer)meshpoint(float, float, float, integer, string)

Parameters

Name	Type	Description
`x`	float	X coordinate.
`y`	float	Y coordinate.
`z`	float	Z coordinate.
`color`	integer	Windows color value: 0x0000FF is red, 0x00FF00 is green, and 0xFF0000 is blue.
`x`	float	X coordinate.
`y`	float	Y coordinate.
`z`	float	Z coordinate.
`color`	integer	Windows color value.
`name`	string	Name for referencing this point in mesh path commands.

Example

MeshPoint -100, -100, 0, 0xFFFFFF, "LeftBottom"

Notes

Use in a mesh script. These commands operate on the mesh being generated.

MeshPointChan

Assigns channel bindings for the X, Y, and Z coordinates of the most recently added mesh point.

Syntax

meshpointchan(float, float, float)

Parameters

Name	Type	Description
`xChannel`	float	Channel binding for X.
`yChannel`	float	Channel binding for Y.
`zChannel`	float	Channel binding for Z.

Example

MeshPoint 0, 0, 0, 0xFFFFFF
MeshPointChan 1, 0, 0

Notes

Use in a mesh script after adding a point. If the mesh has no points, the command has no effect.

MeshPolygon

Adds a polygon path connecting existing mesh points in the supplied order.

Example

MeshPolygon 1, 2

Notes

Use in a mesh script after creating the referenced points. Points can be addressed by index (starting at 1) or by name.

MeshCurve

Adds a quadratic spline path using three existing mesh points.

Example

MeshCurve 1, 2, 3

Notes

Use in a mesh script after creating the referenced points. Points can be addressed by index (starting at 1) or by name.

MeshSpline

Adds a cubic spline path using four existing mesh points. The first and fourth are endpoints; the second and third are control points.

Syntax

meshspline(float, float, float, float)meshspline(string, string, string, string)

Parameters

Name	Type	Description
`point1`	float	Index of an existing mesh point, starting at 1.
`point2`	float	Index of an existing mesh point, starting at 1.
`point3`	float	Index of an existing mesh point, starting at 1.
`point4`	float	Index of an existing mesh point, starting at 1.
`point1`	string	Name of an existing mesh point.
`point2`	string	Name of an existing mesh point.
`point3`	string	Name of an existing mesh point.
`point4`	string	Name of an existing mesh point.

Example

MeshSpline 1, 2, 3, 4

Notes

Use in a mesh script after creating the referenced points. Points can be addressed by index (starting at 1) or by name.

MeshTriangle

Adds a triangle path using three existing mesh points.

Syntax

meshtriangle(float, float, float)meshtriangle(string, string, string)

Parameters

Name	Type	Description
`point1`	float	Index of an existing mesh point, starting at 1.
`point2`	float	Index of an existing mesh point, starting at 1.
`point3`	float	Index of an existing mesh point, starting at 1.
`point1`	string	Name of an existing mesh point.
`point2`	string	Name of an existing mesh point.
`point3`	string	Name of an existing mesh point.

Example

MeshTriangle 1, 2, 3

Notes

Use in a mesh script after creating the referenced points. Points can be addressed by index (starting at 1) or by name.

MeshRect

Adds a quadrilateral path using four existing mesh points.

Syntax

meshrect(float, float, float, float)meshrect(string, string, string, string)

Parameters

Name	Type	Description
`point1`	float	Index of an existing mesh point, starting at 1.
`point2`	float	Index of an existing mesh point, starting at 1.
`point3`	float	Index of an existing mesh point, starting at 1.
`point4`	float	Index of an existing mesh point, starting at 1.
`point1`	string	Name of an existing mesh point.
`point2`	string	Name of an existing mesh point.
`point3`	string	Name of an existing mesh point.
`point4`	string	Name of an existing mesh point.

Example

MeshRect 1, 2, 3, 4

Notes

Use in a mesh script after creating the referenced points. Points can be addressed by index (starting at 1) or by name.

Not in “Commands by category”

198

DropFX

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.

Syntax

dropfx(integer, integer, float)

Parameters

Name	Type	Description
`layer`	integer	Effect layer index in the FX table
`index`	integer	Effect index in the line (layer)
`duration`	float	Execution duration

Example

DropFX 1,1, 1000

Notes

Layer, Index, duration ms

SetFXMute

Lets you mute (disable) FX layers of the Live Control. 0 - Off, 1 - On, 2 - Toggle.

Syntax

setfxmute(integer, float)

Parameters

Name	Type	Description
`layer`	integer	Layer index 1 to 8
`action`	float	0 - off, 1 - on, 2 - toggle.

Example

SetFXMute 1, 2

Notes

Toggle mute state of the first FX layer

SetFXMul

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

Syntax

setfxmul(integer, float, float)

Parameters

Name	Type	Description
`layer`	integer	Layer index (1..8)
`clock`	float	Clock multiplier. 1 is the default value.
`metro`	float	Metronome multiplier. 1 is the default value.

Example

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

Notes

Make the clock of FX layer 2 four times faster

ResetFxTiming

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

Example

ResetFxTiming

Notes

Set the Time settings of the current Live Control

SetFXAction1

Sets the action of FX layer 1. The command acts the same as clicking on the QuickFX grid.

Syntax

setfxaction1(float)

Parameters

Name	Type	Description
`action`	float	Action of the effect in percent (0 to 100)

Example

SetFXAction1 100

Notes

Set the action of a specific FX Layer

SetFXAction2

Sets the action of FX layer 2. The command acts the same as clicking on the QuickFX grid.

Syntax

setfxaction2(float)

Parameters

Name	Type	Description
`action`	float	Action of the effect in percent (0 to 100)

Example

SetFXAction2 100

Notes

Set the action of a specific FX Layer

SetFXAction3

Sets the action of FX layer 3. The command acts the same as clicking on the QuickFX grid.

Syntax

setfxaction3(float)

Parameters

Name	Type	Description
`action`	float	Action of the effect in percent (0 to 100)

Example

SetFXAction3 100

Notes

Set the action of a specific FX Layer

SetFXAction4

Sets the action of FX layer 4. The command acts the same as clicking on the QuickFX grid.

Syntax

setfxaction4(float)

Parameters

Name	Type	Description
`action`	float	Action of the effect in percent (0 to 100)

Example

SetFXAction4 100

Notes

Set the action of a specific FX Layer

SetFXMulAx

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

Syntax

setfxmulax(integer, integer, float)

Parameters

Name	Type	Description
`layer`	integer	FX Layer index (1 to 8).
`mask`	integer	1 clock, 2 metronome, 3 is both.
`rate`	float	Multiplier. The default value is 1. 0 is full stop.

Example

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

Notes

Make both time components run 2 times faster

FXTimeScaleDeltaAx

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

Syntax

fxtimescaledeltaax(float, float, float)

Parameters

Name	Type	Description
`layer`	float	Layer index 1 to 8
`mask`	float	1 - clock, 2 - beat, 3 - clock and beat
`delta`	float	Increment/decrement of current speed

Example

FXTimeScaleDeltaAx 1,2, 0.05

Notes

Increase the beat speed slowly, by 0.05

SetFXAction5

Sets the action of FX layer 5. The command acts the same as clicking on the QuickFX grid.

Syntax

setfxaction5(float)

Parameters

Name	Type	Description
`action`	float	Action of the effect in percent (0 to 100)

Example

SetFXAction5 100

Notes

Set the action of a specific FX Layer

SetFXAction6

Sets the action of FX layer 6. The command acts the same as clicking on the QuickFX grid.

Syntax

setfxaction6(float)

Parameters

Name	Type	Description
`action`	float	Action of the effect in percent (0 to 100)

Example

SetFXAction6 100

Notes

Set the action of a specific FX Layer

SetFXAction7

Sets the action of FX layer 7. The command acts the same as clicking on the QuickFX grid.

Syntax

setfxaction7(float)

Parameters

Name	Type	Description
`action`	float	Action of the effect in percent (0 to 100)

Example

SetFXAction7 100

Notes

Set the action of a specific FX Layer

SetFXAction8

Sets the action of FX layer 8. The command acts the same as clicking on the QuickFX grid.

Syntax

setfxaction8(float)

Parameters

Name	Type	Description
`action`	float	Action of the effect in percent (0 to 100)

Example

SetFXAction8 100

Notes

Set the action of a specific FX Layer

StrobeSpeed

Sets the strobe of the current Live Control.

Syntax

strobespeed(float)

Parameters

Name	Type	Description
`value`	float	speed value

Example

StrobeSpeed 0.2

Notes

Period, flickers per second

MulFXMulAx

Controls the speed/multiplier for FX playback.

Syntax

mulfxmulax(integer, integer, float)

Parameters

Name	Type	Description
`layer`	integer	Fx layer 1 to 8
`mask`	integer	1 - clock, 2 - beat, 3 - clock and beat
`value`	float	Speed/multiplier. 1 is default. Range is 0 to 8.

Example

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

Notes

Live Control FX time control

Hue

Sets the Hue component. Negative values are treated as inactive, and then hue has no impact on recoloring.

Syntax

hue(float)

Parameters

Name	Type	Description
`hue`	float	Hue value (-1 to 720)

Example

Hue -1

Notes

Set hue to the default value

HueDelta

Increments or decrements the Hue property by the specified value. This is a relative command.

Syntax

huedelta(float)

Parameters

Name	Type	Description
`delta`	float	Increment/decrement value

Example

HueDelta 5

Notes

Shift the current hue by 5 degrees

HueShift

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

Syntax

hueshift(float)

Parameters

Name	Type	Description
`offs`	float	Hue offset in degrees.

Example

HueShift 90

Notes

Set hue shift to 90 degrees

HueShiftDelta

Increases or decreases the current HueShift value by the supplied delta.

Syntax

hueshiftdelta(float)

Parameters

Name	Type	Description
`delta`	float	The Shift delta

Example

HueShiftDelta 5

Notes

Add 5 degrees to the hue-shift property

Saturation

Sets the saturation level of the current Live Control. Saturation is not a direct value; in Live Control it works as an offset. The incoming color is transformed to HSV, modified, and transformed back.

Syntax

saturation(float)

Parameters

Name	Type	Description
`sat`	float	Saturation level. 0 is neutral value. -100 is lowest offset down, and 100 is highest offset up.

Example

Saturation 0

Notes

Reset saturation offset

SaturationDelta

Shifts the saturation level of the current Live Control.

Syntax

saturationdelta(float)

Parameters

Name	Type	Description
`sat`	float	Increase/decrease the saturation level.

Example

SaturationDelta 0

SetPage

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

Syntax

setpage(integer)

Parameters

Name	Type	Description
`index`	integer	Page index of the main grid. 1-based.

Example

SetPage 1

Notes

Set the first page of the Grid

GetPage

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

GetTimeControl

Deprecated. Same as ControlFromTcTab.

Example

GetPage

GetLiveControl

Deprecated. Same as ControlFromLcTab.

Example

GetLiveControl

GetFxControl

Deprecated. Same as ControlFromFxTab.

Example

GetFxControl

LinePerCycle

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.

Syntax

linepercycle(integer)

Parameters

Name	Type	Description
`count`	integer	Script lines per iteration

Example

LinePerCycle 100 // put at beginning of script.

Notes

Increase lines per cycle limit to 100

DmxOutRange

DmxOutRange lets you write an array of DMX values. The first parameter is the channel index, 1 to 2048. The second, third, 4th, and so on are DMX values. -1 is the transparent DMX value; 0 to 255 are standard DMX values.

Example

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

Notes

Set the first DMX OUT channel

SetMidiLayer

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.

Syntax

setmidilayer(integer)

Parameters

Name	Type	Description
`layer`	integer	MIDI layer index

Example

SetMidiLayer 1 // default is 1

Notes

Set the MIDI layer of the current MIDI device related to this script

ControlProjector

Deprecated command. At one point BEYOND had Live Control in Projectors.

Syntax

controlprojector(integer)

Parameters

Name	Type	Description
`index`	integer	projector index

Example

ControlProjector 1

ControlFromUI

Deprecated. The new version is ControlFromLcTab.

Example

ControlFromUI

Notes

Bind the script to the Live Control tab destination selection

SetDmxEditorChannel

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

Syntax

setdmxeditorchannel(float, float)

Parameters

Name	Type	Description
`chan`	float	DMX channel index
`value`	float	Channel value 0..255

Example

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

Notes

QuickDMX editor slider control

ProjectionZonesDialog

Opens the Projection Zone Settings dialog. Suggested use: from UMAX, when you need to give access to zone adjustments.

Example

ProjectionZonesDialog

Notes

Show Zones dialog

MakeSecuredFile

This command is designed to help prepare secured Timeline files.

Syntax

makesecuredfile(string, string, float)

Parameters

Name	Type	Description
`infile`	string	Input file name
`outfile`	string	Output file name (secured input)
`serial`	float	Hardware serial number.

Example

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

Notes

How to secure the show file from a script

RestorePlayer

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.

Syntax

restoreplayer(float, float, float, float, string, float, float)

Parameters

Name	Type	Description
`page`	float	Page index
`cue`	float	Cue index
`options`	float	Options (bit mask)
`UserID`	float	Caller ID
`Routing`	string	Routing (char based)
`Clock`	float	Time in seconds
`Beat`	float	Time in beats

Notes

Deprecated

ExecCmd

ExecCmd is a bit fancy. The idea is to execute a script contained in a string. ExecCmd accepts any number of arguments; only strings are executed as commands, one command per string.

Examples

ExecCmd "Blackout"

var s
s = "Blackout"
ExecCmd s

Notes

Simple direct call
Command as a string in a variable

Write

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

Example

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

Notes

Script Universe component terminal
This is a local command of the Scripter.

WriteLn

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.

Example

writeln "Hello world!"

Notes

Script Universe component terminal
This is a local command of the Scripter.

ResetMidiFeedback

Forces a refresh of the MIDI feedback for the surface. The command resets the stored state cache, which causes the MIDI feedback to update.

Syntax

resetmidifeedback(float)

Parameters

Name	Type	Description
`devind`	float	MIDI device index (1 to 4)

Example

ResetMidiFeedback

Notes

Force MIDI feedback update for surfaces

ResetOscFeedback

Forces sending feedback for all OSC messages. BEYOND OSC feedback is based on checking specified variables and sending an OSC message when a value changes. This command sends the state of all variables regardless of whether they changed.

Example

ResetOscFeedback

Notes

Force OSC feedback update for all variables

DefineTcTrigger

Syntax

definetctrigger(string)

Parameters

Name	Type	Description
`param1`	string

Example

DefineTCTrigger "TC Test"

Notes

Hour, minute, second

HtmlClearHead

Read the HtmlBody description first. HtmlClearHead clears the Head string.

Example

HtmlClearHead

Notes

Guide reset command

HtmlHead

Read the HtmlBody description first. Sets the Header string.

Syntax

htmlhead(string)

Parameters

Name	Type	Description
`param1`	string

Example

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

Notes

Guide head command

HtmlClearBody

Read the HtmlBody description first. HtmlClearBody clears the Body string.

Example

HtmlClearBody

Notes

Guide reset command

HtmlBody

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

Syntax

htmlbody(string)

Parameters

Name	Type	Description
`txt`	string	HTML body

Example

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

Notes

Guide body command

HtmlUpdate

Read the HtmlBody description first. Updates the Guide window with the current Body and Header strings.

Example

HtmlUpdate

Notes

Update the Guide window with the current HTML strings

HtmlHide

Read the HtmlBody description first. Closes the Guide window.

Example

HtmlHide

Notes

Hide the Guide window

StartQuickRecord

Starts the recorder located in the QuickRecord tab. This feature is not publicly available yet.

Example

StartQuickRecord

Notes

Start recorder

StopQuickRecord

Stops the recorder located in the QuickRecord tab. This feature is not publicly available yet.

Example

StopQuickRecord

Notes

Stop

SetRecordFile

Sets the file name for the recording. The recording feature is not released yet.

Syntax

setrecordfile(string)

Parameters

Name	Type	Description
`fname`	string	File name

Example

SetRecordFile "C:\BEYOND50\MyFile.best"

Notes

Set the file for recording

MasterSpeed

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

Syntax

masterspeed(float)

Parameters

Name	Type	Description
`ratio`	float	1 is default, 0 is stop, 10 is 10 times faster than normal

Example

MasterSpeed 1 // From zero to one

Notes

Set master speed to the default value

StartPrevious

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

Example

StartPrevious

Notes

"Back" button

TogglePrevious

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

Example

TogglePrevious // "SWAP" button

Notes

Toggle previous cue (swap)

UnselectAllFixt

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

Example

UnselectAllFixt

Notes

Unselect all fixtures

SelectFixt

Sets the Selected state of the Fixture object.

Example

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

Notes

Select fixture by name

UnselectFixt

Clears the selection state of the specified Fixtures. The command accepts multiple arguments: strings as fixture names, and numbers as fixture indexes.

Example

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

Notes

Unselect some fixtures

ToggleSelectFixt

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.

Example

ToggleSelectFixt

Notes

Toggle the Selected property of fixtures

FXCellDown

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.

Syntax

fxcelldown(integer, integer)

Parameters

Name	Type	Description
`layer`	integer	layer index
`item`	integer	effect index in the layer

Example

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

Notes

FX table playback

UnmuteAllZone

Removes the muted state from all Projection Zones.

Example

UnmuteAllZone

Notes

Unmute all Projection Zones

MuteZone

Mutes the specified Projection Zones. The command accepts multiple arguments: strings as Zone names, and numbers as Zone indexes.

Example

MuteZone 0

Notes

Index(es) or name(s)

UnmuteZone

Removes the muted state from the specified Projection Zones. The command accepts multiple arguments: strings as zone names, and numbers as zone indexes.

Example

UnmuteZone 0

Notes

Index(es) or name(s)
0-based indexes

ToggleMuteZone

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

Example

ToggleMuteZone 0

Notes

Index(es) or name(s)

Warning

0-based indexing.

ToggleMuteZoneOfProjector

Toggles the mute state of all zones associated with the projector.

Syntax

togglemutezoneofprojector(float)togglemutezoneofprojector(float, float)

Parameters

Name	Type	Description
`index`	float	projector index
`index`	float	projector index
`state`	float	0 - off, 1 - on, 2 - toggle

Examples

ToggleMuteZoneOfProjector 1 // 1st projector

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

Notes

Toggle the mute state of the projector's zones
Unmute zones of projector 1

StartAudioRecord

Starts audio recording in the QuickAudio tab (for spectrum and audio triggers).

Example

StartAudioRecord

Notes

Audio - start recording

StopAudioRecord

Stops audio recording in the QuickAudio tab.

Example

StopAudioRecord

Notes

Audio - stop recording

SetAudioRelease

Sets the Audio Release speed (QuickAudio tab).

Syntax

setaudiorelease(float)

Parameters

Name	Type	Description
`value`	float	Release value (0.1 to 99)

Example

SetAudioRelease 75

Notes

1..99

SetAudioGain

Deprecated. FFT audio compensation (1 to 15). Not related to audio playback.

Syntax

setaudiogain(float)

Parameters

Name	Type	Description
`gain`	float	audio gain (1 to 15)

Example

SetAudioGain 10

Notes

1..15

MuteSelected

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

Syntax

muteselected(integer)

Parameters

Name	Type	Description
`action`	integer	0 - off, 1 - on, 2 - toggle

Example

MuteSelected 2 // 0,1,2

Notes

Toggle mute state of selected zones

SetGridSize

Sets the main grid size.

Syntax

setgridsize(float, float)

Parameters

Name	Type	Description
`col`	float	column count
`row`	float	row count

Example

SetGridSize 8,5

Notes

Set main Grid to 8x5

MasterPauseTime

Sets the master pause duration (the soft pause).

Syntax

masterpausetime(integer)

Parameters

Name	Type	Description
`ms`	integer	time in milliseconds

Example

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

Notes

Define soft pause time

SetGrid1Page

Sets the Main Grid page by index.

Syntax

setgrid1page(integer)

Parameters

Name	Type	Description
`index`	integer	Page index, 1-based

Example

SetGrid1Page 1

Notes

Set the 1st page visible on the Main Grid

SetGrid2Page

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

Syntax

setgrid2page(integer)

Parameters

Name	Type	Description
`index`	integer	Page index, 1-based

Example

SetGrid2Page 1

Notes

Set the 1st page on the secondary grid

MuteAllZones

Mutes all Projection Zones. A muted zone has no output to the laser projector.

Example

MuteAllZones

Notes

Mute all Projection Zones

PreviewNxN

Sets the Main Preview mode, same as the 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 the number of rows and columns.

Syntax

previewnxn(integer)previewnxn(integer, integer, integer)

Parameters

Name	Type	Description
`mode`	integer	Fixed mode 1,2,3,4, 11,12,13
`preset`	integer	1,2,3,4, 11,12,13
`x`	integer	X dimension for mode 11,12,13
`y`	integer	Y dimension for mode 11,12,13

Example

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

Notes

Set the main preview panel view mode

DisplayPopup

Shows a popup window. This is a purely UI-oriented command. It takes any number of parameters of any type.

Examples

DisplayPopup "Hello world!"

DisplayPopup Master.BPM

DisplayPopup 123, "hello!"

Notes

Hello world!
BPM demo
Mixed types
May change focus; might (rarely) be behind other windows

DisplayPreview

Displays a message in the Main Preview panel located in the top-right corner of the BEYOND window. Recommended for debug messages or action confirmations where you do not need a window-based message. The command takes any number of parameters of any type.

Example

DisplayPreview "Hello world!", 0x0000ff

Notes

Show a message in the main preview panel

PreviewMaster

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.

Example

PreviewMaster

Notes

Set the main preview panel to master view mode

TapByCueClick

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.

Syntax

tapbycueclick(integer)

Parameters

Name	Type	Description
`mode`	integer	0 - off, 1 - on, 2 - toggle

Example

TapByCueClick On // options: On,Off, Toggle

Notes

Cue click as tap tempo

ResyncByCueClick

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.

Syntax

resyncbycueclick(integer)

Parameters

Name	Type	Description
`state`	integer	0 - off, 1 - on, 2 - toggle.

Example

ResyncByCueClick On

Notes

Control resync by click

SynchronizePlayerToBeat

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.

Syntax

synchronizeplayertobeat(integer)

Parameters

Name	Type	Description
`action`	integer	0 - off, 1 - on, 2 - toggle

Example

SynchronizePlayerToBeat On

Notes

options: On, Off, Toggle

ResetCuesFX

Iterates through all cues in the workspace and performs the following actions: clears assigned FX, resets the FX Action parameter and timing, and clears the Drop-effect list. All these operations are part of the LiveControl object. The purpose of this command is to reset the entire playback FX state.

Example

ResetCuesFX

Notes

Reset FX playback

ResetZonesFX

Iterates through all Projection Zones and performs the following actions: clears assigned FX, resets the FX Action parameter and timing, and clears the Drop-effect list. All these operations are part of the LiveControl object. The purpose of this command is to reset the entire playback FX state.

Example

ResetZonesFX

Notes

Reset Live Control of all Projection Zones

ResetProTrackFX

Iterates through all ProTracks and performs the following actions: clears assigned FX, resets the FX Action parameter and timing, and clears the Drop-effect list. All these operations are part of the LiveControl object. The purpose of this command is to reset the entire playback FX state.

Example

ResetProTrackFX

Notes

Reset all ProTrackFX

ClickTCTabMode

The ClickTcTabMode command is the same as clicking the Master, Cue, Zone, or ProTrack buttons in the Time Control tab. The command defines which Live Control is connected to the Time Control tab. Use the following constants: 1-Master, 2-Cue, 3-Zone, 4-ProTrack

Syntax

clicktctabmode(float)

Parameters

Name	Type	Description
`param1`	float

Example

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

Notes

Connect the Time Control tab to the Master LC

ResetMasterFX

Resets the Master Live Control FX only.

Example

ResetMasterFX

Notes

Reset Master FX

InvertProTrackTime

Inverts the playback direction of the selected ProTracks. The main idea is to reverse the playback temporarily, allowing quick back-and-forth motion—similar to a DJ-style effect.

Example

InvertProTrackTime

Notes

Invert time direction of selected ProTracks

ProTrackSetJump

This command stores the current player time on the first call, and on the second call jumps back to the stored position. It is another variation of DJ-style live time effects.

Example

ProTrackSetJump

Notes

Set the jump point for the ProTrack

ProTrackResetJump

Clears the time stored in the player by the PlayerSetJump command. The command always applies to ProTracks only.

Example

ProTrackResetJump

Notes

Reset stored time of ProTracks

ProTrackSetLoop

Cycles loop setup on the selected ProTracks: the first call stores point A, the second stores point B and starts looping, and the third clears the loop.

Syntax

protracksetloop()

Example

ProTrackSetLoop

Notes

Playback A-B loop
Applicable to ProTracks only.

ProTrackDisk

Time Control command, applied to ProTracks only. The DJ Disk located in the Time Control tab can slow down playback as well as time-shift (scratch). If you need a time-shift-only action, see the PlayerDiskShift command.

Syntax

protrackdisk(float)protrackdisk(float, float)

Parameters

Name	Type	Description
`speed`	float	The speed ratio, in the 0 to 1 range. The DJ disk can slow down playback.
`speed`	float	The speed ratio, in the 0 to 1 range. The DJ disk can slow down playback.
`offset`	float	Time shift injected by the disk. Scratch effect.

Example

ProTrackDisk 1, 0.1

ProTrackDiskShift

Time Control command, applied to ProTracks only. This command is a simplified version of PlayerDisk. The shift is applied to the clock and beat time components.

Syntax

protrackdiskshift(float)

Parameters

Name	Type	Description
`shift`	float	Time shift injected by the disk. Scratch effect.

Example

ProTrackDiskShift 0.1

MasterAudioVolume

Controls the volume of Timeline audio players.

Syntax

masteraudiovolume(float)

Parameters

Name	Type	Description
`ratio`	float	Audio volume ratio, 0 to 100

Example

MasterAudioVolume 100 // volume in percent.

Notes

Audio playback volume

MasterShowBrightness

Sets the Timeline/Show brightness, specific to this content. Main intention: a quick and universal way to fade show playback regardless of where it plays.

Syntax

mastershowbrightness(float)

Parameters

Name	Type	Description
`b`	float	Brightness in percent (0..100)

Example

MasterShowBrightness 100

Notes

In percent

MasterClockShift

MasterClockShift sets the Master.MasterClockShift property. MasterClockShift is part of the base offset value applied to cue calculations on a per-zone basis. The offset is the sum of the master offset and the cue-level offset. A simple way to see it: route a cue to multiple zones and set the shift value.

Syntax

masterclockshift(float)

Parameters

Name	Type	Description
`shift`	float	time in seconds

Example

MasterClockShift 0 // in seconds

Notes

Reset Master Clock shift

MasterMetroShift

MasterMetroShift sets the Master.MasterMetroShift property. MasterMetroShift is part of the base offset value applied to cue calculations on a per-zone basis. The offset is the sum of the master offset and the cue-level offset. A simple way to see it: route a cue to multiple zones and set the shift value.

Syntax

mastermetroshift(float)

Parameters

Name	Type	Description
`shift`	float	time in seconds.

Example

MasterMetroShift 0

Notes

In beats

MasterEffectClockShift

Defines the global offset for effects (clock component). This shift works if the effect has master shift enabled, and works as an additional offset to other offsets.

Syntax

mastereffectclockshift(float)

Parameters

Name	Type	Description
`offset`	float	time in seconds

Example

MasterEffectClockShift 1 // 0 is default

Notes

Application-wide effect shift (clock)

MasterEffectMetroShift

Defines the global offset for effects (metronome component). This shift works if the effect has master shift enabled, and works as an additional offset to other offsets.

Syntax

mastereffectmetroshift(float)

Parameters

Name	Type	Description
`offset`	float	Time in beats

Example

MasterEffectMetroShift 1 // beats

Notes

Application-wide effect shift (beats)

MasterCueSpeed

The MasterCueSpeed command sets the CueSpeed value of the Master object. This parameter acts as a speed multiplier for all Player objects. The value is measured in percent, with 100 as the default.

Syntax

mastercuespeed(float)

Parameters

Name	Type	Description
`param1`	float

Example

MasterCueSpeed 200 // twice faster

Notes

Global cue playback speed
This parameter is also available as a property of the global Master object.

MasterCueLcSpeed

The MasterCueLcSpeed command sets the CueLcSpeed value of the Master object. This parameter acts as a speed multiplier for all Live Control objects, including those embedded in cues, zones, and other elements. The value is measured in percent, with 100 as the default.

Syntax

mastercuelcspeed(float)

Parameters

Name	Type	Description
`speed`	float	Speed in percent of normal. 100 is default speed.

Example

MasterCueLcSpeed 100 // default speed

Notes

Global Live Control speed
This parameter is also available as a property of the global Master object.

MasterLCSpeed

Sets the Master.MasterLcSpeed property. MasterLcSpeed is a multiplier applied to the time delta during time accumulation for Live Control objects.

Syntax

masterlcspeed(float)

Parameters

Name	Type	Description
`rate`	float	Speed in percent; 100 is default speed.

Example

MasterLCSpeed 100

Notes

In percent

MasterFXSpeed

Sets the Master.MasterFxSpeed property. MasterFxSpeed is a multiplier applied to the time delta during time accumulation for FX layers.

Syntax

masterfxspeed(float)

Parameters

Name	Type	Description
`rate`	float	Speed in percent; 100 is default speed.

Example

MasterFXSpeed 100

Notes

In percent

MasterZoneFxSpeed

Sets the Master.MasterZoneFxSpeed property. MasterZoneFxSpeed is a multiplier applied to the time delta during time accumulation for FX layers.

Syntax

masterzonefxspeed(float)

Parameters

Name	Type	Description
`param1`	float

Example

MasterZoneFxSpeed 100 // in percents

Notes

Set/reset zone master FX speed

MasterShowSpeed

Sets the Timeline/Show playback speed, specific to this content type. Main intention: a quick and universal way to control the timeline speed.

Syntax

mastershowspeed(float)

Parameters

Name	Type	Description
`ratio`	float	Speed in percent; 100 is default

Example

MasterShowSpeed 100

Notes

In percent

MasterAudioVolumeMute

Mutes or unmutes Timeline audio players.

Syntax

masteraudiovolumemute(float)

Parameters

Name	Type	Description
`mode`	float	0 - off, no mute. 1 - muted. 2 - toggle mute state

Example

MasterAudioVolumeMute 1 // On(1), Off(0), Toggle(2)

Notes

Mute BEYOND audio playback

EnableFb3StyleDmxIn

EnableFb3StyleDmxIn is a legacy-oriented command. BEYOND has multiple modules that react to DMX IN data. One of the oldest is FB3-style DMX IN, which came into BEYOND from QuickShow. It is a very simplified approach to DMX IN compared with modules like DMX to PangoScript and the BEYOND DMX Server. Anyway, this is a standard disable/enable/toggle command.

Syntax

enablefb3styledmxin(float)

Parameters

Name	Type	Description
`state`	float	0 - OFF, 1 - ON, 2 - TOGGLE

Example

EnableFb3StyleDmxIn 1

Notes

Enable legacy DMX IN module

MasterShowShift

Made to add an offset to the laser calculation. Audio may be delayed, if only due to distance. A client requested the ability to delay the laser a bit.

Syntax

mastershowshift(float)

Parameters

Name	Type	Description
`ms`	float	laser offset in milliseconds

Example

MasterShowShift 0

Notes

In milliseconds

ClickTrack

Enables Track click mode of the Live / Content Grid.

Syntax

clicktrack(float)

Parameters

Name	Type	Description
`grid`	float	1 for main grid. 2 for secondary grid

Example

ClickTrack

Notes

Optional argument: 1 or 2 (Grid number)

DisplayPopupOnTop

A version of DisplayPopup with higher visibility priority.

Example

DisplayPopupOnTop "Hello world!"

GoGridMode

Switches BEYOND to the Grid view, equivalent to clicking the corresponding button on the main toolbar.

Example

GoGridMode

Notes

Change BEYOND view to Grid

GoTimelineMode

Switches BEYOND to the Timeline view, equivalent to clicking the corresponding button on the main toolbar.

Example

GoTimelineMode

Notes

Change BEYOND view to Timeline

GoPlayListMode

Switches BEYOND to the Play List view, equivalent to clicking the corresponding button on the main toolbar.

Example

GoPlayListMode

Notes

Change BEYOND view to Play List

GoUniverseMode

Switches BEYOND to the Universe view, equivalent to clicking the corresponding button on the main toolbar.

Example

GoUniverseMode

Notes

Change BEYOND view to Universe

CloseUmax

UMAX is a full-screen “universe” window designed to cover the entire display. It responds only to the Alt + F4 shortcut and normally prevents manual closing. To close it from a MIDI command or script, use the Close UMAX command.

Example

CloseUmax

Notes

Close the UMAX window

EnableDmxIn

EnableDmxIn is a dual-action command that enables, disables, or toggles the DMX IN state, while also resetting the state of all DMX Server players. The reset of DMX Server players is always performed. When DMX IN is enabled, the command updates the state of the Script core and the FB3-style DMX IN object. It also updates the Master.DmxInButtonDown property and the corresponding UI button on the main toolbar.

Syntax

enabledmxin(float)

Parameters

Name	Type	Description
`state`	float	0 - OFF, 1 - ON, 2 - Toggle

Examples

EnableDmxIn Toggle // 0,1,2 Toggle

EnableDmxIn 0

Notes

Enable DMX IN toggle.
Disable DMX IN

SetEffectChannelAction

Defines the channel action parameter, which affects channel calculation.

Syntax

seteffectchannelaction(float)seteffectchannelaction(float, float)

Parameters

Name	Type	Description
`value`	float	effect action from 0 to 100
`value`	float	effect action from 0 to 100
`index`	float	0 to 7

Example

SetEffectChannelAction 0 // 0..100

Notes

Default effect action

SetChannelToChannelRatio

A Channel is a shell of 4 values and 4 multipliers with auto-gain correction. ChannelToChannel is the multiplier for the original channel value. The additional parts are the DMX, VDJ, and FFT multipliers. Overall logic: Gain = ChannelRatio + DmxRatio + FFTRatio + VdjRatio; OutValue = ChannelVal * (ChannelRatio/Chain) + DmxVal * (DmxRario/Gain) + FFTVal * (*FFTRatio/Gain) + VdgValue * (VdjRatio/Gain)

Syntax

setchanneltochannelratio(float)

Parameters

Name	Type	Description
`ratio`	float	ratio of Channel value (from 0 to 100)

Example

SetChannelToChannelRatio 100

Notes

Use the full channel value for output

SetDmxToChannelRatio

BEYOND Channels hide several internal mechanisms, one of which is the ability to mix DMX data with direct channel values. A channel is a general-purpose, global array of variables that can be used in Images and Effects. You can view them in the Channels tab. This command sets the multiplier (ratio) that defines how DMX data contributes to the Channel values. See SetChannelToChannel for more details.

Syntax

setdmxtochannelratio(float)

Parameters

Name	Type	Description
`ratio`	float	0 - no DMX at all, 100 - full DMX value from the channel value

Examples

SetDmxToChannelRatio 50

SetDmxToChannelRatio 100

Notes

Use 50% of DMX data in Channels output
Enable DMX data in Channels

SetFFTToChannelRatio

Sets the ratio of Audio/FFT data in the output channel value. See SetChannelToChannel for more details.

Syntax

setffttochannelratio(float)

Parameters

Name	Type	Description
`ratio`	float	ratio of FFT value (from 0 to 100)

Example

SetFFTToChannelRatio 100

Notes

Enable use of the Audio signal in Channel output

SetVdjToChannelRatio

Sets the ratio of VDJ data in the output channel value. See SetChannelToChannel for more details.

Syntax

setvdjtochannelratio(float)

Parameters

Name	Type	Description
`ratio`	float	ratio of VDJ value (from 0 to 100)

Example

SetVdjToChannelRatio 0 // 0 to 100.

Notes

Mute use of the VDJ signal in Channel output

TimelinePlay

Plays the current timeline.

Syntax

timelineplay()

Example

TimelinePlay

Notes

PlayTimeline is an alias for the same operation.

TimelineStop

Stops timeline playback.

Syntax

timelinestop()

Example

TimelineStop

Notes

StopTimeline is an alias for the same operation.

TimelineQuickSave

Saves the current timeline to file. The command uses the existing file name.

Example

TimelineQuickSave

Notes

Save the current timeline
BEYOND always creates a backup copy of the file and never deletes Workspace and Timeline file backups. Never. If you are using this command for timeline autosave, keep an eye on SSD usage.

SetLocation

Locations are in the prototype phase. Please do not use this command; it may change or be removed.

Syntax

setlocation(integer, float, float, float)

Parameters

Name	Type	Description
`index`	integer	"Location" index
`x`	float	x coordinate
`y`	float	y coordinate
`z`	float	z coordinate

Example

SetLocation 1, 0,0,0

Notes

Set one of 256 positions/locations (index 1..256; X, Y, Z as normalized values (0..1))

SetZoneMeshPointPos

This command provides control over the Free-Form Mesh component of the Projection Zones geo-correction system.

Syntax

setzonemeshpointpos(float, float, float, float, float)

Parameters

Name	Type	Description
`zone`	float	zone index
`col`	float	mesh point X index
`row`	float	mesh point Y index
`posx`	float	mesh point new value of X (-32K..32K)
`posy`	float	mesh point new value of Y

Example

SetZoneMeshPointPos 1, 1,1, 0,0

Notes

Zone index, X node index, Y node index, X coordinate (-32K..32K), Y coordinate

SetGridView

Goes to Grid view (main form, mode/view buttons).

Example

SetGridView

Notes

Set Grid view mode

SetTimelineView

Goes to Timeline view (main form, mode/view buttons).

Example

SetTimelineView

Notes

Set Timeline view mode

SetPlayListView

Goes to Play List view (main form, mode/view buttons).

Example

SetPlayListView

Notes

Set Playlist view mode

SetUniverseView

Goes to Universe view (main form, mode/view buttons).

Example

SetUniverseView

Notes

Set Universe view mode

UnselectAllProjectors

Deprecated command. Unselects all projectors.

Example

UnselectAllProjectors

SelectProjector

Deprecated command. Do not use.

Example

SelectProjector 1 // index(es) (1..N) or name(string). Can be used more than one argument

Notes

Select projectors

UnselectProjector

Deprecated command. Unselects projectors by index or name.

Example

UnselectProjector 1 // index(es) (1..N) or name(s)

Notes

Unselect projector

ToggleSelectProjector

Deprecated command. Toggles the selected/unselected state of all projectors.

Example

ToggleSelectProjector 1 // index(es) (1..N) or name(s)

Notes

Invert Projector selection state

FocusProjector

Deprecated command. Do not use.

Syntax

focusprojector(integer)focusprojector(string)

Parameters

Name	Type	Description
`index`	integer	projector index
`name`	string	projector name

Example

FocusProjector 1 // Projector index, 1..N.

Notes

Deprecated example

StartTvMode

Starts TV output mode. TV Mode is a global fixed-FPS mode applied to all projectors.

Syntax

starttvmode(float)

Parameters

Name	Type	Description
`FPS`	float	Frames per second (from 0.1 to 500)

Example

StartTvMode 30 // 30 FPS

Notes

Start TV mode

StopTvMode

Stops BEYOND's TV mode. This is the companion command to StartTvMode.

Example

StopTvMode

Notes

Stop TV Mode

Set4FxPerLine

Sets the QuickFX tab to extended four-effects-per-line mode.

Example

Set4FxPerLine

SetDropFxMode

Sets the FX Table to "drop effect" mode, which is the 3rd mode.

Example

SetDropFxMode

Notes

Set the FX table to drop-fx mode (1 per line, 4 per line, drop-fx)

Set1FxPerLine

Sets the QuickFX tab to standard one-effect-per-line mode.

Example

Set1FxPerLine

Notes

Set the default 1-per-line QuickFX mode

PreviewAsUninverse

Enables or disables Universe in the Main Preview panel.

Syntax

previewasuninverse(integer)

Parameters

Name	Type	Description
`enabled`	integer	1 - display Universe page in this panel. 0 - classic preview modes.

Example

PreviewAsUninverse 1

PreviewZoneGrid

This command is in the development/prototype phase.

Example

PreviewZoneGrid

PreviewZoneMatrix

Selects the zone matrix shown in the main preview.

Syntax

previewzonematrix(integer)

Parameters

Name	Type	Description
`index`	integer	0 is the default preview. 1 and above select a zone matrix.

Example

PreviewZoneMatrix 1

Notes

0 selects the default preview; 1 selects the first zone matrix.

LockScreen

The LockScreen command places BEYOND into a locked state, preventing unauthorized access or unintended changes to the user interface.

Example

LockScreen

Notes

Lock UI access

UnLockScreen

Unlocks the BEYOND UI. Used as a pair with the LockScreen command.

Example

UnLockScreen

Notes

Unlock BEYOND screen (access)

MoboNotify

Sends a text message to all connected MoboLaser applications.

Syntax

mobonotify(string)

Parameters

Name	Type	Description
`text`	string	text message

Example

MoboNotify "Hello!"

Notes

Send a message to the MoboLaser mobile app

SetUiFPS

The command sets the frequency of the BEYOND UI repaint. The default frequency is relatively low, only 25 FPS. If you use BEYOND primarily for show design, it may be a good idea to increase the FPS to 50 or 60. Keep in mind that a higher FPS can increase CPU load and may slightly reduce keyboard responsiveness in the worst case. BEYOND is designed to handle dropped frames and will not lock up, but this is a reminder to maintain a balance and avoid overloading the main thread.

Syntax

setuifps(integer)

Parameters

Name	Type	Description
`FPS`	integer	UI repaint frequency

Example

SetUiFPS 50

Notes

Set the design-time UI FPS

Fb4DiscoveryMode

Sets the FB4 detection mode. By default, BEYOND always searches for FB4 and establishes a connection as soon as it is detected. However, this can be changed. Mode values: 0 - always. Default mode. 1 - auto. Checks whether there is another BEYOND on the network; if yes, discovery does not start. If not, it starts searching for hardware. 2 - manual. Enable or disable discovery by command. A good option if you want to control it manually.

Syntax

fb4discoverymode(integer)

Parameters

Name	Type	Description
`mode`	integer	0 - always, 1 - auto, 2 - manual

Example

Fb4DiscoveryMode 0 // 0-always, 1-auto, 2-manual

Notes

Set FB4 connection / discovery mode
Using the mode makes sense only if you have multiple BEYOND PCs on the network.

StartFb4Discovery

Enables discovery of FB4 on the network.

Example

StartFb4Discovery

Notes

Enable FB4 discovery and auto-connect

StopFb4Discovery

Disables discovery of FB4 on the network.

Example

StopFb4Discovery

Notes

Disconnect FB4 and disable auto-connect

SetVdgPlugin

This command enables, disables, or toggles the data-retrieval state of the VirtualDJ plugin.

Syntax

setvdgplugin(integer)

Parameters

Name	Type	Description
`mode`	integer	0 - off, 1 - on, 2 - toggle

Example

SetVdgPlugin 2 // 0 disable, 1 enable, 2 toggle

Notes

Enable or disable VirtualDJ plugin

SetCueCaptionColor

Sets the cue caption background color.

Syntax

setcuecaptioncolor(float, float, float)

Parameters

Name	Type	Description
`page`	float	page index
`cue`	float	cue index
`color`	float	color in GDI format (0x0000FF is red)

Example

SetCueCaptionColor 1,2, 0x0000FF // page 1, cue 2, color (windows, 24bit color)

Notes

Set the cue caption color

PulseEvent

Pulses one or more Events. Each parameter is a string containing the Event name to pulse. This command is used to trigger other scripts that are waiting for an Event using WaitForEvent.

Example

PulseEvent "MyEventName"
// OTHER SCRIPT
WaitForEvent "MyEventName"
DisplayPopup "It works!"
restart

Notes

Pulsing another script

RefreshDmxIn

Forces BEYOND to regenerate commands for a state update. Related to PangoScript to DMX and legacy FB3-style DMX IN.

Example

RefreshDmxIn

Notes

Activate an update of DMX IN reactions, whether or not the data changed
In theory, DMX should define the control state and act as the sole source of input.
In BEYOND, however, multiple sources can control the same objects, which can lead to out-of-sync states.
For these modules, BEYOND responds to DMX value changes rather than the current state itself.
The Refresh command forces an update to resynchronize the affected modules.

ShutDownWindows

This command is intended for companies that operate permanent installations, where BEYOND needs to run on a schedule or be controlled remotely. The command requires the ShutDownWindows.exe application to function. On the BEYOND side, it simply calls ShellExecute().

Example

ShutDownWindows // require ShutDownWindows.exe application

Notes

Shut down PC

CaptureToClipboard

BEYOND can create a “Capture” content object from the currently playing cues and place it into the clipboard. The CaptureToClipboard command triggers the corresponding user interface action to perform this operation.

Example

CaptureToClipboard

Notes

Create a Capture object and store it to the clipboard

PasteToCue

Pastes the top object from the clipboard into the current cue.

Example

PasteToCue

Notes

Paste cue example

SelectZoneName

Deprecated command (acts the same as SelectZone).

Example

SelectZoneName "Main Graphics"

Notes

Selection of zone by name

UnSelectZoneName

Clears the selection state of the specified Projection Zones. Supply zone names as strings.

Example

UnSelectZoneName "Main Graphics"

Notes

Unselect zone by name (legacy)

FocusZone

Puts a zone in focus. Related to the QuickFX tab and the Effect tab.

Syntax

focuszone(integer)focuszone(string)

Parameters

Name	Type	Description
`index`	integer	zone index
`name`	string	zone name such as Main Graphics

Example

FocusZone 1

Notes

Focus zone by index

SelectAndFocusZone

Finds a Projection Zone by name or index, selects it, and updates the Effect and QuickFX tabs.

Syntax

selectandfocuszone(integer)selectandfocuszone(string)

Parameters

Name	Type	Description
`index`	integer	Projection zone index
`name`	string	Projection zone name

Example

SelectAndFocusZone 1

Notes

Select zone by index or name

MuteZonesOfProjector

Mutes the zones of one or more specified projectors. Use the projector indexes.

Example

MuteZonesOfProjector 1

Notes

Mute zones of 1st projector

UnMuteZonesOfProjector

Unmutes the zones of one or more specified projectors. Use the projector indexes.

Example

UnMuteZonesOfProjector 1,2,3 // projector 1,2 and 3

Notes

Unmute zones of multiple projectors

SetActiveGrid

Sets the active Grid to either the first (main) or second (secondary) Grid. The active Grid concept is used in many parts of BEYOND. In practice, the rule is simple: the last Grid you interacted with becomes the active one.

Syntax

setactivegrid(float)

Parameters

Name	Type	Description
`grid`	float	1 for main grid, 2 for secondary (located at QuickTools area)

Example

SetActiveGrid 1 // 1 or 2

Notes

Select the active grid for context-related operations

StartTalkClient

Starts the Talk client: UDP-based script messaging. The client sends messages.

Example

StartTalkClient

Notes

Start Talk client socket

StopTalkClient

Stops the Talk client: UDP-based script messaging. The client sends messages.

Example

StopTalkClient

Notes

Stop Talk client socket

StartTalkServer

Starts the Talk server: UDP-based script messaging. The server receives messages.

Example

StartTalkServer

Notes

Start Talk server socket

StopTalkServer

Stops the Talk server: UDP-based script messaging. The server receives messages.

Example

StopTalkServer

Notes

Stop Talk server socket

SelectNextCatGrid1

Goes to the next category in the workspace. The command is always associated with the Main Grid.

Example

SelectNextCatGrid1

Notes

Select next category (main grid).
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

SelectPrevCatGrid1

Goes to the previous category in the workspace. The command is always associated with the Main Grid.

Example

SelectPrevCatGrid1

Notes

Select previous category (main grid).

SelectNextPageGrid1

Goes to the next page in the workspace. The command is always associated with the Main Grid.

Example

SelectNextPageGrid1

Notes

Select next page (main grid).
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

SelectPrevPageGrid1

Selects the previous Page of the Grid. The command is always associated with the Main Grid.

Example

SelectPrevPageGrid1

Notes

Select previous page (main grid).
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

SelectNextTabGrid1

Goes to the next tab in the workspace. The command is always associated with the Main Grid.

Example

SelectNextTabGrid1

Notes

Select next tab (main grid).
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

SelectPrevTabGrid1

Selects the previous Tab of the Grid. The command is always associated with the Main Grid.

Example

SelectPrevTabGrid1

Notes

Select previous tab (main grid).
Page is an absolute index used as the cue address. Tab refers to the UI side. The Grid may display only a subset of pages depending on the selected category.

RebootConnectedFB4

Sends a Reboot command to all connected FB4s. Might help if you want to reboot the hardware remotely. Also might be required if you just uploaded firmware to the SD card and need to start the update process.

Example

RebootConnectedFB4

Notes

If you need to use this command, please contact Pangolin ([email protected]) and tell us what is wrong with your FB4. Thanks.

UnselectAllCue

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

Example

UnselectAllCue

Notes

Unselect all cues

Pub

Syntax

pub(string, string)pub(string, string, integer)pub(string, string, integer, integer)pub(string, float)

Parameters

Name	Type	Description
`param1`	string
`param2`	string
`param1`	string
`param2`	string
`param3`	integer
`param1`	string
`param2`	string
`param3`	integer
`param4`	integer
`param1`	string
`param2`	float

Example

pub "data/", "test text"

SubProp

Syntax

subprop(string, string)

Parameters

Name	Type	Description
`param1`	string
`param2`	string

SubJson

Syntax

subjson(string, string)

Parameters

Name	Type	Description
`param1`	string
`param2`	string

SubCmd

Syntax

subcmd(string)

Parameters

Name	Type	Description
`param1`	string

PubObject

Syntax

pubobject(string, string)pubobject(string, string, string)

Parameters

Name	Type	Description
`param1`	string
`param2`	string
`param1`	string
`param2`	string
`param3`	string

Chat

Prototype-stage command. Under construction. Do not use.

Syntax

chat(string)chat(string)

Parameters

Name	Type	Description
`text`	string
`text`	string

SetProp

Sets a property value. The idea is a universal setter, where you can use a string variable with the property name and a second one with the property value.

Syntax

setprop(string, string)setprop(string, integer)setprop(string, float)

Parameters

Name	Type	Description
`name`	string	object.property name
`strvalue`	string	Property value
`name`	string	object.property name
`intvalue`	integer	Property value
`name`	string	object.property name
`fvalue`	float	Property value

Example

SetProp "Master.bpm", 123

Notes

Universal property setter

QLog

Displays a message in the Quick Log panel. The command accepts any number of arguments and concatenates them into a single string without separators. The message is added as an Info-level entry.

Example

QLog "Hello World!"

Notes

Hello World in QuickLog tab

LogInfo

Sends an Info message to the QuickLog tab. Any number of parameters can be provided—they will be concatenated into a single string.

Example

LogInfo "My message to QLog tab"

Notes

Add an info message to the log

LogWarning

Sends a Warning message to the QuickLog tab. Any number of parameters can be provided—they will be concatenated into a single string.

Example

LogWarning "My message to QLog tab"

Notes

Add a Warning message to the log

LogError

Sends an Error message to the QuickLog tab. Any number of parameters can be provided—they will be concatenated into a single string.

Example

LogError "My message to QLog tab"

Notes

Add an error message to the log

AddSms

Adds a new message to the SMS FIFO queue for display on the laser projector. You can view the message FIFO in the QuickSMS tab, located at the bottom of the main window. This module was originally designed for compatibility with the Pangolin IMU software, which is now discontinued. However, the ability to add messages through scripting allows connectivity with various external input sources.

Syntax

addsms(string)addsms(string, string)addsms(string, string, string)addsms(string, string, string, integer)

Parameters

Name	Type	Description
`text`	string	message text
`text`	string	message text
`nick`	string	Nickname
`text`	string	message text
`nick`	string	Nickname
`phone`	string	phone number
`text`	string	message text
`nick`	string	Nickname
`phone`	string	phone number
`color`	integer	message color (GDI RGB color)

Examples

AddSMS "This is my demo message"

AddSMS "Red text message", "","", 0x0000FF

Notes

Add a basic text message to the text FIFO
Red message

ShowItNowSMS

Enables/disables laser output from the QuickSMS tab.

Syntax

showitnowsms(integer)

Parameters

Name	Type	Description
`online`	integer	0 - off, 1 - on (laser output enabled)

Example

ShowItNowSMS 1

Notes

Enable laser output from the QuickSMS tab

ExitBEYOND

The ExitBEYOND command closes the BEYOND application, equivalent to clicking the close button on the main window. Execution of this command is asynchronous.

Example

ExitBEYOND

Notes

Close application

RegisterOscFeedback

This command allows monitoring the state of a variable and sending an OSC message when the value of an object property changes. Implementation details: BEYOND maintains a dedicated list of property names to watch. Their values are checked periodically by a timer. When a value changes, BEYOND sends an OSC message automatically. This approach is somewhat CPU-intensive, but it is universal and works with all object properties accessible in PangoScript.

Syntax

registeroscfeedback(string, string)

Parameters

Name	Type	Description
`osc`	string	OSC address
`prop`	string	BEYOND Object property

Example

RegisterOscFeedback "/beyond/master/brightness", "master.brightness"

Notes

Add OSC feedback for object property

ShowMasterHelpFile

Shows the BEYOND help file. Legacy command.

Example

ShowMasterHelpFile

Notes

Show BEYOND help file

SetAudioInGain

FFT audio compensation (1 to 15). Not related to audio playback. Gain on the FFT input.

Syntax

setaudioingain(float)

Parameters

Name	Type	Description
`gain`	float	audio gain (1 to 15)

Example

SetAudioInGain 10

Notes

1 is min, 15 is max, 10 is default

SetAudioInRelease

FFT analyzer parameter: peak release speed. Reduces rapid jumping of the value up and down.

Syntax

setaudioinrelease(float)

Parameters

Name	Type	Description
`release`	float	Release value for FFT peak detector.

Example

SetAudioInRelease 75

Notes

1 is min, 99 is max (slowest), 75 is default

ShowHint

This command displays a popup window with hint text. It is useful for showing which slider is currently in motion and its value. This type of popup is used by the QuickShow MIDI-mapping system, and BEYOND allows you to use the same feature for any slider you are mapping.

Syntax

showhint(string)

Parameters

Name	Type	Description
`text`	string	popup window text

Example

ShowHint "Hello!"

Notes

Show a hint window in the center of the main window

LoadZoneFromBlob

Internal binary-stream command. Not supported for use in PangoScript.

Notes

This entry is retained for reference only; it is not a callable PangoScript example.

LoadCueFromBlob

Internal binary-stream command. Not supported for use in PangoScript.

Notes

This entry is retained for reference only; it is not a callable PangoScript example.

WaitForEvent

WaitForEvent is a general-purpose waiting command that works in conjunction with the PulseEvent command. It must include at least one event name, defined as a string of your choice. Multiple event names can be specified. As soon as any of the listed events is pulsed, the script resumes execution. The main purpose of this command pair is to enable coordination and interaction between multiple scripts. The syntax: WaitForEvent "Event1" WaitForEvent "Event1", "Event2","Event3"

Examples

// script 1:
WaitForEvent "MyEventName"
DisplayPopup "MyEventName pulsed"
restart
// script 2
PulseEvent "MyEventName"

// script 1:
codename "DrumAction"
var a
a = 0
LoopPoint:
WaitForEvent "Kick", "Snare"
DisplayPopup "Boom!"
goto LoopPoint
// script 2
DrumAction.a = 100
PulseEvent "Kick"
// script 3
DrumAction.a = 200
PulseEvent "Snare"
PulseEvent "Snare"

Notes

Single wait - pulse-script pair
Multiple waiting

Warning

Some contexts do not support waiting instructions.
A waiting instruction introduces a delay in execution, requiring the scripter object to remain active until completion.
In certain cases—such as during initialization or within timeline event input/output—scripts cannot wait because execution occurs synchronously in real time.
In these situations, BEYOND creates the scripter object, executes all commands immediately, then destroys the scripter and continues execution.
Waiting commands such as sleep, waitfor, and similar functions are not applicable in these contexts.

WaitForPageChange

The WaitForPageChange command puts the script into a waiting state, which ends when the main content grid page is changed. It does not apply to the secondary grid. param(1) returns the current page index (zero-based).

Example

WaitForPageChange

Warning

Some contexts do not support waiting instructions. See WaitForEvent warning.