ActivateAll

Example:
ActivateAll

Activates all parameters of all layers of all Servers within the Pandoras Box Project.

ActivateDevice(SiteID,DeviceID)

Example:
ActivateDevice(1,3)

Activates all parameters of layer 3 of site 1 within the Pandoras Box Project.

ActivateParam(SiteID,DeviceID,ParamName)

Example:
ActivateParam(1,3,"X Scale")

Activates the parameter X Scale of layer 3 of site 1 within the Pandoras Box Project.

ActivateSite(SiteID)

Example:
ActivateSite(1)

Activates all parameters of all layers of site 1 within the Pandoras Box Project.

AddEncryptionKey(Key)

Example:
AddEncryptionKey("Key1|uYxJLovsAK+ZAJplLQgpSf1u6wwaA5e0UurBJq2+MTsugQpLiXSOHRCAHdcMBVf2GSfZLRn5UoURjIfnmpJOF78d33pFdTfdKdj6YjnJEr0=")

This applies to the Media Encryption feature in Pandoras Box. Using this command you can import a key that was exported earlier with another PB project.

AddEncryptionPolicy(Policy)

Example:
AddEncryptionPolicy("Pol1|Y3dm4ld4S7XB0NzYLinuseF7jXzUexhTBWSysoPlXZKUmgnbuvWfG/t39j+qxUE5FdDSaoZpOzbQUuje0E13FeKfMHKbfFpvS5FATyI8LvU=")

This applies to the Media Encryption feature in Pandoras Box. Using this command you can import a policy that was exported earlier with another PB project.

AddFileToPBPlaylistByID(FileName,ProjectFolder,TempFolderID,TempFileID,PBPlaylistFolderID,PBPlaylistFileID)

Example:
AddFileToPBPlaylistByID("C:\Christie\content\playlist\image5.png","playlist",2,5,3,6)

First( the file )"image5.png" from the path "C:\Christie\content\playlist" is loaded and added to the subfolder "playlist" within your Pandoras Box project. Secondly, the file is assigned with the Folder and File ID 2,5. Last, this file is added to the Playlist with Folder/File ID 3,6.
If you do not need a Folder/File ID in the second step, simply use "0,0" instead of "2,5".

AddGraphicLayer(SiteID,Count)

Example:
AddVideoLayer(1,3)

Adds three new Graphic Layers to Site 1 (e.g. a Server). Note that graphic layers are discontinued since Pandoras Box version 8.0.0

AddVideoLayer(SiteID,Count)

Example:
AddVideoLayer(1,3)

Adds three new Video Layers to Site 1 (e.g. a Server). Note that, before version 8, some Pandoras Box products had a limited amount of Video Layers.

AddLayer(SiteID,LayerKind,Count)

Example:
AddLayer(1,3,2)

Adds two new Audio Tracks to Site 1 (e.g. a Server).

To add another Layer kind please refer to below table. All Layers are explained in the chapter "Devices and Layer Parameters".

1 = Video
2 = Graphic (deprecated, version 8)
3 = Audio Track
4 = Camera
5 = Output
6 = Light
7 = Pointer
8 = Particle System
13 = Notch
14 = Notch Camera

Depending on the Pandoras version or chosen Layer kind, there might be a limit of Layers to be added.

ApplicationClose(Processname)

Example:
ApplicationClose("notepad")

Closes all running notepad applications. Please have a look into the Windows Task Manager to get the correct process name of the running application you want to close, enter this name without ".exe".

ApplicationKill(Processname)

Example:
ApplicationKill("PB_Widget_Designer")

This ends the process of Widget Designer of the local WD computer without asking to save any projects. Please have a look into the Windows Task Manager to get the correct process name of the running application you want to close, enter this name without ".exe".

Other examples:
ApplicationKill("mspaint")
ApplicationKill("vlc")

These commands end the process of VLC Player and Microsoft Paint.

ApplicationKillAllOtherWDInstances

Example:
ApplicationKillAllOtherWDInstances

This ends all background processes of Widget Designer that do not belong to the one currently running and have added up by mistake. This command is of interest for permanent installations without technical staff.

ApplicationStart(Filepath,Commandline Arguments[optional])

Example:
ApplicationStart("C:\Program Files\Christie\Widget Designer 6.1.0\PB_Widget_Designer.exe")

The first examples use only the first parameter "Filepath". It starts Widget Designer on the local WD computer. The following examples start the VLC Player and Microsoft Paint.

ApplicationStart("C:\program files\VideoLAN\VLC\vlc.exe")
ApplicationStart("mspaint")
----------

Examples with optional parameter for commandline arguments:
ApplicationStart("C:\program files\VideoLAN\VLC\vlc.exe","C:\Music\Sound.mp3")
ApplicationStart("C:\Program Files\Christie\Widget Designer 6.1.0\PB_Widget_Designer.exe" STARTWDF)

If you would like to use the optional second parameter "Commandline Arguments", please find out first whether your application supports this and how the commandline should be written.
The first example from above starts the VLC Player and plays back the file "Sound.mp3". The second example starts the Widget Designer free edition.

Widget Designer starts with the following commandline arguments:
- STARTWDF: in the free edition
- STARTWD (or nothing): for the normal edition
- STARTWDU: for the edition with unlimited web clients

ApplyView(ViewID)

Example:
ApplyView(2)

This applies the View with ID 2 to the Pandoras Box user interface. Views can be saved in the Project tab or View tab.

ArtNetDisableAllUniverses

Example:
ArtNetDisableAllUniverses

Disables the Art-Net Output on all Universes. This command clears the Universe List in the Connection Manager.

ArtNetDisableUniverse(Subnet 0-15,Universe 0-15)

Example:
ArtNetDisableUniverse(0,1)

Disables the Art-Net Output on Art-Net Subnet 0, Universe 1. The specified Art-Net Universe will be removed from the Universe List in the Connection Manager.

ArtNetInputDisabled

Example:
ArtNetInputDisabled

Disables the Art-Net Input in the Connection Manager.

ArtNetInputEnabled

Example:
ArtNetInputEnabled

Enables the Art-Net Input in the Connection Manager.

ArtNetInputSetAdapter(NicAdapterName)

Example:
ArtNetInputSetAdapter("Lan1")

Enables the Art-Net Input in the Connection Manager and sets the network adapter to the entry "Lan1". Make sure, that the connection is disabled before setting the network adapter, e.g. via the command ArtNetInputDisabled.

ArtNetOutputDisabled

Example:
ArtNetOutputDisabled

Disables the Art-Net Output in the Connection Manager.

ArtNetOutputEnabled

Example:
ArtNetOutputEnabled

Enables the Art-Net Output in the Connection Manager.

ArtNetOutputSetAdapter(IP address,NicAdapterName)

Example:
ArtNetOutputSetAdapter(,"2.0.0.1","Lan1")

Enables the Art-Net Output in the Connection Manager, sets the IP to the address 2.0.0.1 and the network adapter to the entry "Lan1". Make sure, that the connection is disabled before setting the network adapter, e.g. via the command ArtNetOutputDisabled.

ArtNetSetVal16bit(Subnet 0-15,Universe 0-15,Channel,Value 0-65535)

Example:
ArtNetSetVal16bit(0,1,41,32768)

Sets the 16bit parameter with the following starting address to a value of 32768: Channels 41 on Art-Net Subnet 0, Universe 1.

Please note, that the next channel you can control is now Channel 43 as the 16 bit value occupied Channel 41 and 42.

Art-Net Output needs to be enabled in the Connection Manager.

ArtNetSetVal24bit(Subnet 0-15,Universe 0-15,Channel,Value 0-16.777.215)

Example:
ArtNetSetVal24bit(0,1,44,2.255.248)

Sets the 24bit parameter with the following starting address to a value of 2.255.248: Channels 44 on Art-Net Subnet 0, Universe 1.

Please note, that the next channel you can control is now Channel 47 as the 24 bit value occupied Channel 44, 45 and 46.

Art-Net Output needs to be enabled in the Connection Manager.

ArtNetSetVal8bit(Subnet 0-15,Universe 0-15,Channel,Value 0-255)

Example:
ArtNetSetVal8bit(0,1,38,255)

Sets the Channel 38 on Art-Net Subnet 0, Universe 1 to the value 255.

Art-Net Output needs to be enabled in the Connection Manager.

ClearActiveDevice(SiteID,DeviceID)

Example:
ClearActiveDevice(1,3)

Clears all active parameters of layer 3 of site 1 within the Pandoras Box Project.

ClearActiveParam(SiteID,DeviceID,ParamName)

Example:
ClearActiveParam(1,3,"X Scale")

Sets a clear active to the parameter X Scale of layer 3 of site 1 within the Pandoras Box Project.

ClearActiveSite(SiteID)

Example:
ClearActiveSite(1)

Clears all active parameters of all layers of site 1 within the Pandoras Box Project.

ClearAllActive

Example:
ClearAllActive

Clears all active parameters of all layers of all Servers within the Pandoras Box Project.

ClearSelection

Example:
ClearSelection

Clears the device selection within the Pandoras Box project.

CloseAirScanProperties

Example:
CloseAirScanProperties

Closes the dialog for the AirScan tool.

CloseAllDialogs

Example:
CloseAllDialogs

This closes all dialogs from Widget Designer.

CloseArtNetMonitor

Example:
CloseArtNetMonitor

Closes the Art-NetMonitor which can also be accessed through the Connection Manager.

CloseArtNetUniverseList

Example:
CloseArtNetUniverseList

Closes the Art-Net Universe List which can also be accessed through the Connection Manager.

CloseCameraTrackerDialog

Example:
CloseCameraTrackerDialog

Closes the Camera Tracker dialog.

CloseCitpBrowser

Example:
CloseCitpBrowser

Closes the Thumbnail Browser which can also be accessed through the dialog PB Network Configuration.

CloseComConnections

Example:
CloseComConnections

Closes the COM Connection dialog which gives an better overview than the Connection Manager.

CloseConnectionManager

Example:
CloseConnectionManager

Closes the Connection Manager.

CloseEmailSettings

Example:
CloseEmailSettings

Closes the Email Settings Tool.

CloseIpConfiguration

Example:
CloseIpConfiguration

Opens the PB Network Configuration dialog.

CloseKeyboardShortcuts

Example:
CloseKeyboardShortcuts

Closes the Keyboard Shortcut Editor.

CloseKinectDialog

Example:
CloseKinectDialog

Closes the Kinect Tool.

CloseMacroEditor(MacroName)

Example:
CloseMacroEditor("MyMacro")

Closes the Macro Editor with the macro "MyMacro".

CloseMidiNoteEditor

Example:
CloseMidiNoteEditor

Closes the Midi Note Editor.

ClosePageBrowser

Example:
ClosePageBrowser

Closes the Page Browser.

CloseRemoteInput

Example:
CloseRemoteInput

Closes the Remote Input Tool.

CloseSmsSettings

Example:
CloseSmsSettings

Closes the SMS Settings Tool.

CloseTcpConnections

Example:
CloseTcpConnections

Closes the TCP Connection dialog which gives an better overview than the Connection Manager.

CloseUdpConnections

Example:
CloseUdpConnections

Closes the UDP Connection dialog which gives an better overview than the Connection Manager.

CloseVariableList

Example:
CloseVariableList

Closes the dialog Variable List.

COMInject(ID,Message)

Example:
COMInject(1,"Play")

Injects the message "Play" directly into the stream of the COM Connection with ID 1, without waiting for other messages or packages to be finished.

The UDP Connection needs to be defined first in the Connection Manager.

Incoming or outgoing values in TCP-, UDP- and COM Port nodes can be entered as string, decimal or hexadecimal values as explained in the chapter Syntax TCP-/UDP-/Serial Messages.

For example:
Use [d13] to enter a carriage return as a decimal value.
Use [h0D] to enter a carriage return as a hexadecimal value.
Use [CR] to enter a carriage return as a ASCII symbol.

For two commands - e.g. a carriage return and a line feed - you may use this syntax: [d13 d10] respectively [h0D h0A] or [CR LF]. Mixed values are also possible, e.g: Example String[CR d10].

COMSend(ID,Message)

Example:
COMSend(1,"Play")

Sends the message "Play" via the COM Port Connection with the ID 1 in the Connection Manager.

COMSendDec(ID,Message)

Example:
COMSendDec(1,"72 105 33")

Sends the message "Hi!" in decimal values via the TCP Connection with the ID 1 in the Connection Manager. For more information see the chapter "Syntax TCP-/UDP-/Serial Messages".

COMSendHex(ID,Message)

Example:
COMSendHex(1,"48 69 21")

Sends the message "Hi!" in hexadecimal values via the COM Port Connection with the ID 1 in the Connection Manager. For more information see the chapter "Syntax TCP-/UDP-/Serial Messages".

COMStart(ID)

Example:
COMStart(1)

Starts the COM Port Connection with the ID 1 in the Connection Manager.

COMStop(ID)

Example:
COMStop(1)

Stops the COM Port Connection with the ID 1 in the Connection Manager.

DebugClear

Example:
DebugClear

This clears the log entries of the Debug Logger dialog.
Please note: This feature is currently not available for the WD Free Version.

DebugDisable

Example:
DebugDisable

Disables the Debug Logging so that error messages are not added to the Debug Logger dialog.
Please note: This feature is currently not available for the WD Free Version.

DebugEnable

Example:
DebugEnable

Enables the Debug Logging so that error messages are added to the Debug Logger dialog.
Please note: This feature is currently not available for the WD Free Version.

DebugJson(JsonVarName,Arbitrary Value(s)[Optional])

Example:
DebugJson(varJson)

Example2:
DebugJson(varJson.ToPrettyString)

This displays the value of the variable named varJson (with the JSON type) in the Debug Logger dialog. Using the member "ToPrettyString" improves the readability. You could also display multiple json variables.

Alternatively, you can also use the command DebugMessage.

Please note: This feature is currently not available for the WD Free Version.

DebugMessage(Message,Arbitrary Value(s)[Optional])

Example:
DebugMessage("Home Button clicked")

This writes the message "Home Button clicked" into the Debug Logger and stores it there for debugging or logging purposes. Text must be enclosed in double or single quotation marks and can be combined e.g. with variables using a plus sign as seen in the examples below. Note: Debug Logging has to be enabled via the command "DebugEnable" or in the Scripting menu. There you can also choose to open the Debug Logger manually..

Example2:
DebugMessage("Macro 'Restart' executed at "+Now)

The second example uses the global variable "Now" which expresses the current date and time. The Debug Logger displays:
Macro 'Restart' executed at 2017-03-09 09:21:05.472

Example3:
DebugMessage("info1","info2",varstring,varint)

If you would like to display various messages in one line, you can separate them using a comma as done in the third example. The Debug Logger displays:
"info1","info2","text stored in string variable",99

DebugShow

Example:
DebugShow

This opens Debug Logger dialog.
Please note: This feature is currently not available for the WD Free Version.

DeviceAcceptDmxById(SiteID,DeviceID,"On"/"Off")

Example:
DeviceAcceptDmxById(2,1,"On")

Patches Layer 1 of Site 2 in the Patch tab so that it can be controlled via an attached DMX / Art-Net device.

Example 2:
DeviceAcceptDmxById(2,1,"Off")

Unpatches Layer 1 of Site 2 in the Patch tab so that it cannot be controlled via an attached DMX / Art-Net device anymore.

Please note:
Art-Net Input needs to be enabled in Configuration Tab in order to remote control the Layer via Art-Net.

To change the Devices DMX / Art-Net start address (Channel, Art-Net Subnet and Universe) use either the Patch Tab in PB or the WD command DeviceSetDmxAddress.

DeviceAddToSelection(SiteID,DeviceID)

Example:
DeviceAddToSelection(1,3)

Selects layer 3 of Site 1 (e.g. a Server) and adds it to the current selection within the Pandoras Box project: If other layers were selected before, they are still selected. If you would like to select solely layer 3, use the command DeviceSelect(SiteID,DeviceID)

DeviceBringToFront(SiteID,DeviceID)

Example:
DeviceBringToFront(1,3)

Changes the layer order in the Pandoras Box Device Tree for Site 1 (e.g. a Server). Per default, the layer 3 is rendered after layer 1 and 2 and before layer 4,5,6 etc. With this command layer 3 is moved on top of all other layers. Please note that you might need to toggle the layers to be visible.

DeviceFadeParam(SiteID,DeviceID,Param,StartValue,EndValue,Time)

Example:
DeviceFadeParam(2,3,"Opacity",45,108,11)

The parameter "Opacity" of layer 3 of site 2 starts at value 45 and increases gradually to 108 in 11 seconds. In addition the parameter will be activated and highlighted in red.
Note that the parameter name is case-sensitive, see the topic "Parameter List"..

DeviceFadeToParam(SiteID,DeviceID,Param,Value,Time)

Example:
DeviceFadeToParam(2,4,"Opacity",103,8)

The parameter "Opacity" of layer 4 of site 2 will gradually change in 8 seconds to value 103. In addition the parameter will be activated and highlighted in red.
Note that the parameter name is case-sensitive, see the topic "Parameter List".

DeviceMoveToBack(SiteID,DeviceID)

Example:
DeviceMoveToBack(1,3)

Changes the layer order in the Pandoras Box Device Tree for Site 1 (e.g. a Server). Per default, the layer 3 is rendered after layer 1and 2 and before layer 4,5,6 etc. With this command layer 3 is moved one step behind layer 2 but stays in front of layer 1. To move it behind all other layers, use the command DeviceSendToBack(SiteID,DeviceID). Please note that you might need to toggle the layers to be visible.

DeviceMoveToFront(SiteID,DeviceID)

Example:
DeviceMoveToFront(1,3)

Changes the layer order in the Pandoras Box Device Tree for Site 1 (e.g. a Server). Per default, the layer 3 is rendered after layer 1and 2 and before layer 4,5,6 etc. With this command layer 3 is moved one step in front of layer 4 but stays behind layers 5,6 etc. To move it in front all other layers, use the command DeviceBringToFront(SiteID,DeviceID). Please note that you might need to toggle the layers to be visible.

DeviceSelect(SiteID,DeviceID)

Example:
DeviceSelect(1,3)

Selects layer 3 of Site 1 (e.g. a Server) within the Pandoras Box project: If other layers were selected before, they are now deselected. If you would like to add layer 3 to the current selection, use the command DeviceAddToSelection(SiteID,DeviceID)

DeviceSendToBack(SiteID,DeviceID)

Example:
DeviceSendToBack(1,3)

Changes the layer order in the Pandoras Box Device Tree for Site 1 (e.g. a Server). Per default, the layer 3 is rendered after layer 1and 2 and before layer 4,5,6 etc. With this command layer 3 is moved behind all other layers. Please note that you might need to toggle the layers to be visible.

DeviceSetDmxAddress(SiteID,DeviceID,DMXStart,Universe,Subnet)

Example:
DeviceSetDmxAddress(2,1,0,5,4)

Patches Layer [2,1] in Pandoras Box to the DMX start address 1, Art-Net Universe 5 and Subnet ID 4.

DeviceSetIp(SiteID,IP address)

Example:
DeviceSetIp(3,"2.0.0.103")

Sets the IP of Site 3 inside your PB project to 2.0.0.103.

Please note:
This command is only working from PB version 5237 on.

DeviceSetMedia(SiteID,DeviceID,FolderID,FileID)

Example:
DeviceSetMedia(1,3,2,4)

Assigns the media file with the File and Folder ID 2,4 to layer 3 of Site 1 (e.g. a Server).

DeviceSetMediaByName(SiteID,DeviceID,MediaName)

Example:
DeviceSetMediaByName(1,3,"Testpattern/Calibrate.png")

Assigns the media file with the name "Calibrate.png" from the subfolder "Testpattern" within the project folder to layer 3 of the Site 1 (e.g. a Server). If there is more than one file in the subfolder that holds this name, the first file is taken. If the file is not in a special subfolder, simply use "Calibrate.png". Please note that "MediaName" is case-sensitive.

DeviceSetMediaInSelection(FolderID,FileID)

Example:
DeviceSetMediaInSelection(2,4)

Assigns the media file with the File and Folder ID 2,4 to all layers that are currently selected.

DeviceSetMediaParamByID(SiteID,DeviceID,ParamName,FolderID,FileID)

Example:
DeviceSetMediaParamByID(1,3,"Quad Media Overlay|Media1",2,4)

Assigns the media file with the File and Folder ID 2,4 to layer 3 of the Site 1 (e.g. a Server) but not as the main media but the first media for the effect named "Quad Media Overlay".

DeviceSetMediaParamByName(SiteID,DeviceID,ParamName,MediaName)

Example:
DeviceSetMediaParamByName(1,3,"Quad Media Overlay|Media1","Testpattern/Calibrate.png")

Assigns the media file with the name "Calibrate.png" from the subfolder "Testpattern" within the project folder to layer 3 of the Site 1 (e.g. a Server) but not as the main media but the first media for the effect named "Quad Media Overlay".
If there is more than one file in the subfolder that holds this name, the first file is taken. If the file is not in a special subfolder, simply use "Calibrate.png". Please note that "MediaName" and "ParamName" is case-sensitive. "ParamName" consists of the name of the effect followed by the character pipe (vertical bar) and the name of the media field (in most cases simply "Media").

DeviceSetMesh(SiteID,DeviceID,FolderID,FileID)

Example:
DeviceSetMesh(1,3,2,4)

Assigns the mesh file with the File and Folder ID 2,4 to layer 3 of Site 1 (e.g. a Server).

DeviceSetMeshByName(SiteID,DeviceID,MediaName)

Example:
DeviceSetMeshByName(1,3,"Objects/Cone.x")

Assigns the mesh file with the name "Cone.x" from the subfolder "Objects" within the project folder to layer 3 of the Site 1 (e.g. a Server). If there is more than one file in the subfolder that holds this name, the first file is taken. If the file is not in a special subfolder, simply use "Cone.x". Please note that "MediaName" is case-sensitive.

DeviceSetMeshInSelection(FolderID,FileID)

Example:
DeviceSetMeshInSelection(2,4)

Assigns the mesh file with the File and Folder ID 2,4 to all layers that are currently selected.

DeviceSetMeshParamByID(SiteID,DeviceID,ParamName,FolderID,FileID)

Example:
DeviceSetMeshParamByID(1,3,"FXName|Mesh1",2,4)

Assigns the mesh file with the File and Folder ID 2,4 to layer 3 of the Site 1 (e.g. a Server) but not as the main mesh but the first mesh of the effect named "FXName".

DeviceSetMeshParamByName(SiteID,DeviceID,ParamName,MediaName)

Example:
DeviceSetMeshParamByName(1,3,"FXName|Mesh1","Objects/Car.x")

Assigns the mesh file with the name "Car.x" from the subfolder "Objects" within the project folder to layer 3 of the Site 1 (e.g. a Server) but not as the main mesh but the first mesh of the effect named "FXName".

If there is more than one file in the subfolder that holds this name, the first file is taken. If the file is not in a special subfolder, simply use "Car.x". Please note that "MediaName" and "ParamName" is case-sensitive. "ParamName" consists of the name of the effect followed by the character pipe (vertical bar) and the name of the mesh field.

DeviceSetParam(SiteID,DeviceID,ParamName,AbsoluteValue)

Example:
DeviceSetParam(1,2,"X Pos",3)

Sets the X Position of Server 1, Layer 2 to the value 3.
If you would like to send string values, use the command DeviceSetTextParam.

In the manual, there is a topic with all parameter names.

DeviceSetParamDirect(SiteID,DeviceID,ParamName,AbsoluteValue)

Example:
DeviceSetParamDirect(1,2,"X Pos",3)

In Pandoras Box, the X Position of Server 1, Layer 2 is set to the value 3 WITHOUT applying translation smoothing in the Device Inspector. Since PB 9088 all parameters can be smoothend. Before, this applied only to position, scaling and rotation.
Note that the parameter name is case-sensitive, see the topic "Parameter List".

DeviceSetParamDirectSilent(SiteID,DeviceID,ParamName,AbsoluteValue)

Example:
DeviceSetParamDirectSilent(1,2,"X Pos",3)

This command combines the commands DeviceSetParamDirect and DeviceSetParamSilent:
In Pandoras Box it sets the X Position of Server 1, Layer 2 to the value 3 WITHOUT applying translation smoothing in the Device Inspector and WITHOUT setting the parameter active in PB if it was not active before.
Note that the parameter name is case-sensitive, see the topic "Parameter Llist".

DeviceSetParamInSelection(ParamName,AbsoluteValue)

Example:
DeviceSetParamInSelection("Opacity",255)

Sets the Opacity of all selected Devices in PB to the value 255.
Note that the parameter name is case-sensitive, see the topic "Parameter List".

DeviceSetParamRelative(SiteID,DeviceID,ParamName,RelativeValue)

Example:
DeviceSetParamRelative(1,2,"Opacity",100)

Adds the value 100 to the parameter Opacity of Server 1, Layer 2.

DeviceSetParamRelativeInSelection(ParamName,RelativeValue)

Example:
DeviceSetParamRelativeInSelection("Opacity",20)

Adds the value 20 to the Opacity parameter of all selected Devices in PB.
Note that the parameter name is case-sensitive, see the topic "Parameter List".

DeviceSetParamSilent(SiteID,DeviceID,ParamName,AbsoluteValue)

Example:
DeviceSetParamSilent(1,2,"X Pos",3)

Sets the X Position of Server 1, Layer 2 to the value 3 WITHOUT setting the parameter active in PB if it was not active before.
Note that the parameter name is case-sensitive, see the topic "Parameter List".

DeviceSetPreset(SiteID,DeviceID,PresetID1,PresetID2)

Example:
DeviceSetPreset(1,3,2,4)

Applies the Preset with the ID 2.4 to layer 3 of Site 1 (e.g. a Server). Please note that the command will not paste keys into the timeline but apply the value of the first key.

DeviceSetTextParam(SiteID,DeviceID,ParamName,String)

Example:
DeviceSetTextParam(1,3,"Notch|Text|Input Name","New")

This applies the string "New" to the text parameter "Input Name" from the Notch Layer with ID 3 on Site ID 1. The parameter can be found in the group "Notch > Text" which is expressed using the pipe "|"character.

DeviceUnselect(SiteID,DeviceID)

Example:
DeviceUnselect(1,3)

Unselects layer 3 of Site 1 (e.g. a Server) within the Pandoras Box project. If other layers were selected before, they are still selected.

DirCopy(SourcePath,TargetPath)

Example:
DirCopy("C:\Christie\WD_test\Dir_1","C:\Christie\WD_test\Dir_2")

Copies the content of directory Dir_1 into directory Dir_2. If there are files in Dir_2 with the same name as in Dir_1, they are not being replaced.

DirCopyBackup(SourcePath)

Example:
DirCopyBackup("C:\Christie\WD_test\Dir_1")

Generates a backup of the selected folder Dir_1 and saves it with date and time at the same directory as the source folder "C:\Christie\WD_test\Dir_1(2015-09-08_10-12-09)".

DirCopyChanges(SourcePath,TargetPath)

Example:
DirCopyChanges("C:\Christie\WD_test\Dir_1","C:\Christie\WD_test\Dir_2")

Copies the content of directory Dir_1 into directory Dir_2, files in Dir_2 with the same name as files in Dir_1 are being overwritten.

DirCopyOverwrite(SourcePath,TargetPath)

Example:
DirCopyOverwrite("C:\Christie\WD_test\Dir_1","C:\Christie\WD_test\Dir_2")

Copies the content of directory Dir_1 into directory Dir_2, files in Dir_2 with the same name as files in Dir_1 are being overwritten.

DirCopyUi(SourcePath,TargetPath)

Example:
DirCopyUi("C:\Christie\WD_test\Dir_1","C:\Christie\WD_test\Dir_2")

Copies the content of directory Dir_1 into directory Dir_2. If there are files in Dir_2 with the same name as in Dir_1, a dialog window how to proceed with those files opens at the Widget Designer.

DirDelete(Path)

Example:
DirDelete("C:\Christie\WD_test\Dir_3")

Deletes the whole directory Dir_3 permanently including its content.

DmxLinkInDisable

Example:
DmxLinkInDisable

Disables the Widget Designer to receive values via the Christie DMX Link. This can also be done in the Connection Manager.

DmxLinkInEnable

Example:
DmxLinkInEnable

Enables the Widget Designer to receive values via the Christie DMX Link. This can also be done in the Connection Manager.

DmxLinkInReset

Example:
DmxLinkInReset

Resets the value of all channels received via the Christie DMX Link which is enabled in the Connection Manager.

DmxLinkOutDisable

Example:
DmxLinkOutDisable

Disables the Widget Designer to send out values via the Christie DMX Link. This can also be done in the Connection Manager.

DmxLinkOutEnable

Example:
DmxLinkOutEnable

Enables the Widget Designer to send out values via the Christie DMX Link. This can also be done in the Connection Manager.

DmxLinkOutReset

Example:
DmxLinkOutReset

Resets the value of all channels send out via the Christie DMX Link which is enabled in the Connection Manager.

DmxLinkOutSetVal16Bit(Channel,Value 0-65535)

Example:
DmxLinkOutSetVal16Bit(255,32768)

Sends out the value 32768 on channel 255 via the Christie DMX Link which is enabled in the Connection Manager.

DmxLinkOutSetVal8Bit(Channel,Value 0-255)

Example:
DmxLinkOutSetVal8Bit(255,20)

Sends out the value 20 on channel 255 via the Christie DMX Link which is enabled in the Connection Manager.

EmailClearInbox

Example:
EmailClearInbox

Clears the Email Inbox from the Email tool.

EmailClearOutbox

Example:
EmailClearOutbox

Clears the Email Outbox from the Email tool.

EmailExportInbox(FilePath)

Example:
EmailExportInbox("C:\Christie\content\Inbox.txt")

Exports all emails listed in the Inbox from the Email tool into the text file "Inbox.txt" under the path "C:\Christie\content".

EmailExportOutbox(FilePath)

Example:
EmailExportOutbox("C:\Christie\content\Outbox.txt")

Exports all emails listed in the Outbox from the Email tool into the text file "Outbox.txt" under the path "C:\Christie\content".

EmailOutputAddressSet(EmailAddress)

Example:
EmailOutputAddressSet("support.pandorasbox@christiedigital.com")

Sets the Email Address for the outgoing Email Server in the Email Settings Tool to "support.pandorasbox@christiedigital.com".

EmailOutputPasswordSet(Password)

Example:
EmailOutputPasswordSet("SECRET")

Sets the Email Password for the outgoing Email Server in the Email Settings Tool to "SECRET".

EmailOutputSendDisable

Example:
EmailOutputSendDisable

When this command is executed, no email can be sent out. Use the command EmailSendEnable to enable this function again.

Please use the Email Settings Tool to setup all incoming and outgoing Email communication.

EmailOutputUseDefaultAuthentication(True/False)

Example:
EmailOutputUseDefaultAuthentication("True")

Checks the option "Use Default Authentification" for the outgoing Email Server in the Email Settings Tool.

EmailOutputUsernameSet(Username)

Example:
EmailOutputUsernameSet("support")

Sets the Email Username for the outgoing Email Server in the Email Settings Tool to "support".

EmailSend(To,Subject,Message)

Example:
EmailSend("support.pandorasbox@christiedigital.com","Question WD","What are the system requirements for running WD?")

Sends an Email with the subject "Question WD" and the message "What are the system requirements for running WD?" to support.pandorasbox@christiedigital.com.

Please use the Email Settings Tool first to setup all incoming and outgoing Email communication.

EmailSendAtt(To,Att,Subject,Message)

Example:
EmailSendAtt("support.pandorasbox@christiedigital.com","C:\Christie\commandlist.txt","Question WD","Please explain the commands!")

Sends an Email with the subject "Question WD", the message "Please explain the commands!" and the attachment "commandlist.txt" from the specified directory (C:\Christie\commandlist.txt) to support.pandorasbox@christiedigital.com.

Please use the Email Settings Tool first to setup all incoming and outgoing Email communication.

EmailSendEnable

Example:
EmailSendEnable

Enables the EmailSend function after it was disabled.

Please use the Email Settings Tool to setup all incoming and outgoing Email communication.

EmailSendFromTextBox(To,Subject From TextBoxID,Message From TextBoxID)

Example:
EmailSendFromTextBox("support.pandorasbox@christiedigital.com",1,2 )

Sends an Email with the text of TextBox 1 as subject and with the text of TextBox 2 as message to support.pandorasbox@christiedigital.com.

Please use the Email Settings Tool first to setup all incoming and outgoing Email communication.

EmailSendHTML(To,Subject,HTMLcodedMessage)

Example:
EmailSendHTML("support.pandorasbox@christiedigital.com","Format",vCode)

Sends an HTML formatted Email with the subject "Format" to support.pandorasbox@christiedigital.com. The message of the Email is the content of the string variable "vCode" which contains HTML code (see below).

Please use the Email Settings Tool first to setup all incoming and outgoing Email communication.

Example for the message which can be copied to the variable for testing:
<!DOCTYPE html> <html> <head> <meta name="viewport" content="width=device-width"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">   <style>  @media only screen and (max-width: 400px)  {  body {font-size: 28px; color:red}  }</style> </head> <body style="background-color: #000">  Background Text  <div>  <p style="font-size: 12pt;background: yellow;">This is HTML formatted text.</p>  </div> </body> </html>

EmailServerSet(EmailServerSmpt)

Example:
EmailServerSet("smtp.googlemail.com")

Sets the SMTP Mail Server in the Email Settings Tool to smtp.googlemail.com.

EmailUseSSL(True/False)

Example:
EmailUseSSL(True)

Checks the option "Use SSL" for the outgoing Email Server in the Email Settings Tool.

FileCopy(SourcePath,TargetPath)

Example:
FileCopy("C:\Christie\WD_test\Dir_1\file_1.txt","C:\Christie\WD_test\Dir_2\file_flollop.txt")

Copies the Content of the file "file_1.txt" in directory Dir_1 and pastes it to the newly generated file "file_flollop.txt" in directory Dir_2.

FileDelete(FileName)

Example:
FileDelete("C:\Christie\WD_test\Dir_2\file_4.txt")

Deletes the file "file_4.txt" permanently.

FullScreenByID(SiteID)

Example:
FullScreenByID(4)

Switches the site 4 to fullscreen mode in Pandoras Box project whether it is in windowed mode or in fullscreen mode already.
For addressing the machines combined to a Virtual Site, you need to use the Site IDs of the single machines as displayed in the Virtual Site Tab.
To toggle the site back into windowed mode , use WindowedModeByID

FullScreenByIP(IP address)

Example:
FullScreenByIP("2.0.0.1")

Switches the Pandoras Box master or client with the IP address 2.0.0.1 to fullscreen mode.
For addressing the machines combined to a Virtual Site, you need to use the IPs of the single machines as displayed in the Virtual Site Tab or the command FullScreenByID and the individual SiteID.
To toggle the site back into windowed mode, use WindowedModeByIP

HTTPRequestToVar(URL,VarName for return value,Request method [optional; default = "GET"],Content type [optional; default = "application/json"],Payload [optional; default = ""])

Example:
HTTPRequestToVar("https://postman-echo.com/get?foo1=bar1&foo2=bar2","var1")

This allows you to send HTTP requests directly to another web server (REST API) and writes the answer to a (string) variable in Widget Designer. Widget Designer and the web server need to be connected via network but it is not necessary to add a TCP connection in the Connection Manager or Configuration dialog.

WD supports the following request methods: GET, DELETE, PATCH, POST, PUT. Depending on the verb, optional parameters need to be used, see examples.

The first example seen above refers to the web server from the website postman-echo.com and sends a simple GET request. No optional parameters need to be set when using the GET method.

Example 2 - GET:
HTTPRequestToVar("http://192.168.50.40/cgi-bin/shutter_on","var1")

You may also control external devices, e.g. a projector that supports the HTTP protocol. This is an alternative to controlling devices via a RS232 / serial protocol.

Example 3 - DELETE:
HTTPRequestToVar("https://reqbin.com/echo/delete/json","var1","DELETE")

The HTTP DELETE method is used to delete a resource from the server. The first optional parameter must be set to "DELETE", the others should be left blank.

Example 4a - POST, json:
HTTPRequestToVar("https://postman-echo.com/post","var1","POST","application/json",'{"n":"v"}')
HTTPRequestToVar("https://postman-echo.com/post?n1=v1","var1","POST","application/json",'{"n2":"v2"}')
HTTPRequestToVar("http://10.0.0.2:8080/devices","var1","POST","application/json",'{"name":"NewName","address":"NewAddress"}')

These three examples send POST requests; the first two address the website postman-echo.com and the third one a local web server. When using the POST (respectively PUT or PATCH) method, all three optional parameters must be set: The "Request method" is either "POST", "PUT" or "PATCH". The "Content type" defines the format of the last parameter "Payload", which is the actual data that is sent to the API as request body. There are two format options:
  Content type = "application/json" => Payload = JSON formatted string (as seen in Ex. 4a) or the name of a JSON variable
  Content type = "application/x-www-form-urlencoded" => Payload = simple string (as seen in Ex. 4b) or the name of a string variable

Example 4b - POST, URL-encoded:
HTTPRequestToVar("https://postman-echo.com/post","var1","POST","application/x-www-form-urlencoded","n=v")
HTTPRequestToVar("http://10.0.0.2:8080/devices","var1","POST","application/x-www-form-urlencoded","name=NewName&address=NewAddress"')
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Use the command HTTPRequestToVarWithLogin if the external web server requires a username and / or a password and supports a HTTP Basic Authentication (in most browsers that gives you a pop-up window asking for credentials).
The commands WDHTTPRequest and WDHTTPRequestWithLogin allow sending a request without writing the answer from the web server to a variable.
The commands starting with JsonRequest... are meant to be used with JSON return values.

HTTPRequestToVarWithLogin(Username,Password,URL,VarName for return value,Request method [optional; default = "GET"],Content type [optional; default = "application/json"],Payload [optional; default = ""])

Example:
HTTPRequestToVarWithLogin("postman","password","https://postman-echo.com/basic-auth","var1")

This allows you to send HTTP requests - including required login information - directly to another web server (REST API) and writes the answer to a (string) variable in Widget Designer. Widget Designer and the web server need to be connected via network but it is not necessary to add a TCP connection in the Connection Manager or Configuration dialog.

WD supports the following request methods: GET, DELETE, PATCH, POST, PUT. Depending on the verb, optional parameters need to be used, see examples.

The first example seen above refers to the web server from the website postman-echo.com and sends a simple GET request. No optional parameters need to be set when using the GET method.

Example 2 - GET:
HTTPRequestToVar("User1","Pw1","http://192.168.50.40/cgi-bin/shutter_on","var1")

You may also control external devices, e.g. a projector that supports the HTTP protocol. This is an alternative to controlling devices via a RS232 / serial protocol.

Example 3 - DELETE:
HTTPRequestToVar("User1","Pw1","https://reqbin.com/echo/delete/json","var1","DELETE")

The HTTP DELETE method is used to delete a resource from the server. The first optional parameter must be set to "DELETE", the others should be left blank.

Example 4a - POST, json:
HTTPRequestToVar("User1","Pw1","https://postman-echo.com/post","var1","POST","application/json",'{"n":"v"}')
HTTPRequestToVar("User1","Pw1","https://postman-echo.com/post?n1=v1","var1","POST","application/json",'{"n2":"v2"}')
HTTPRequestToVar("User1","Pw1","http://10.0.0.2:8080/devices","var1","POST","application/json",'{"name":"NewName","address":"NewAddress"}')

These three examples send POST requests - the first two address the website postman-echo.com and the third one a local web server. When using the POST (respectively PUT or PATCH) method, all three optional parameters must be set: The "Request method" is either "POST", "PUT" or "PATCH". The "Content type" defines the format of the last parameter "Payload", which is the actual data that is sent to the API as request body. There are two format options:
  Content type = "application/json" => Payload = JSON formatted string (as seen in Ex. 4a) or the name of a JSON variable
  Content type = "application/x-www-form-urlencoded" => Payload = simple string (as seen in Ex. 4b) or the name of a string variable

Example 4b - POST, URL-encoded:
HTTPRequestToVar("User1","Pw1","https://postman-echo.com/post","var1","POST","application/x-www-form-urlencoded","n=v")
HTTPRequestToVar("User1","Pw1","http://10.0.0.2:8080/devices","var1","POST","application/x-www-form-urlencoded","name=NewName&address=NewAddress"')
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Use the command HTTPRequestToVar if the external web server does not require a username and / or a password nor supports a HTTP Basic Authentication (in most browsers that gives you a pop-up window asking for credentials).
The commands WDHTTPRequest and WDHTTPRequestWithLogin allow sending a request without writing the answer from the web server to a variable.
The commands starting with JsonRequest... are meant to be used with JSON return values.

IncludeInSpread(SiteID)

Example:
IncludeInSpread(2)

This deactivates the option "Spare from Spread" for Site ID 2 in Pandoras Box. The option can be found in the Device Inspector .

JsonLoadFileToVar(FilePath,VarName)

Example:
JsonLoadFileToVar("C:\Christie\content\participants.txt","varJson")

This loads the JSON formatted content of the text file "participants.txt" and writes it in the variable "varJson".
The variable can be either of String or of Json type.

Exemplary content of the JSON file:
{
 "person": [
   {
   "id": "1",
   "name": "Alan",
   "country": "Wales"
   },{
   "id": "2",
   "name": "Louis",
   "country": "France"
   }
 ]
}

In case the imported data does not show the same letters etc., check the encoding of your file. Widget Designer imports the following encodings: UCS-2 LE / BE (also called Unicode or Unicode big endian) and UTF-8 with a byte order mark (BOM).

JsonLoadXmlFileToVar(FilePath,VarName)

Example:
JsonLoadFileToVar("C:\Christie\content\participants.xml","varJson")

This loads the XML formatted content of the text file "participants.xml" and writes it in the variable "varJson".
The variable can be either of String or of Json type and the file format can be XML or TXT.

Exemplary content of the XML file:
<root>
 <person id='1'>
   <name>Alan</name>
   <country>Wales</country>
 </person>
 <person id='2'>
   <name>Louis</name>
   <country>France</country>
 </person>
</root>

Resulting Json Variable:
{
 "root": {
   "person": [
     {
       "@id": "1",
       "name": "Alan",
       "country": "Wales"
     },
     {
       "@id": "2",
       "name": "Louis",
       "country": "France"
     }
   ]
 }
}

In case the imported data does not show the same letters etc., check the encoding of your file. Widget Designer imports all common encodings except ANSI. That is: UCS-2 LE / BE (also called Unicode or Unicode big endian) and UTF-8 (with or without BOM).

JsonRequestItemToVar(URL,JsonItem,VarName for return value,Request method [optional; default = "GET"],Content type [optional; default = "application/json"],Payload [optional; default = ""])

Example:
JsonRequestItemToVar("http://time.jsontest.com/","date","varString")

This allows you to send HTTP JSON requests directly to another web server (REST API) and write the answer to a (String or Json) variable in Widget Designer. Widget Designer and the web server need to be connected via network but it is not necessary to add a TCP connection in the Connection Manager or Configuration dialog.

The first example above shows how to write the requested Json item "date" from the URL "http://time.jsontest.com/" into the variable "varString". As this is a simple GET request, no further (optional) parameters need to be set.

Widget Designer supports the following request methods: GET, DELETE, PATCH, POST, PUT. Depending on the verb, the optional parameters need to be used as explained in the description from the commands HTTPRequestToVar and HTTPRequestToVarWithLogin.

JsonRequestToVar(URL,VarName for return value,Request method [optional; default = "GET"],Content type [optional; default = "application/json"],Payload [optional; default = ""])

Example:
JsonRequestToVar("http://time.jsontest.com/","varJson")

This allows you to send HTTP JSON requests directly to another web server (REST API) and write the answer to a (String or Json) variable in Widget Designer. Widget Designer and the web server need to be connected via network but it is not necessary to add a TCP connection in the Connection Manager or Configuration dialog.

The first example above shows how to write the value of the requested JSON data from the URL "http://time.jsontest.com/" into the variable "varJson". As this is a simple GET request, no further (optional) parameters need to be set.

Widget Designer supports the following request methods: GET, DELETE, PATCH, POST, PUT. Depending on the verb, the optional parameters need to be used as explained in the description from the commands HTTPRequestToVar and HTTPRequestToVarWithLogin.

JsonRequestToVarWithLogin(Username,Password,URL,VarName for return value,Request method [optional; default = "GET"],Content type [optional; default = "application/json"],Payload [optional; default = ""])

Example:
JsonRequestToVarWithLogin("christie",abc","http:\\localhost:8000\timeEntry.json","varJson")

This allows you to send HTTP JSON requests - including required login information - directly to another web server (REST API) and write the answer to a (String or Json) variable in Widget Designer. Widget Designer and the web server need to be connected via network but it is not necessary to add a TCP connection in the Connection Manager or Configuration dialog.

The first example above shows how to connect to "http:\\localhost:8000\timeEntry.json", log in with the username "christie" and password "abc" and then store the Json data into the variable "varJson". As this is a simple GET request, no further (optional) parameters need to be set.

Widget Designer supports the following request methods: GET, DELETE, PATCH, POST, PUT. Depending on the verb, the optional parameters need to be used as explained in the description from the commands HTTPRequestToVar and HTTPRequestToVarWithLogin.

KeyboardKeyPress(Keycode)

Example:
KeyboardKeyPress("A")

The first example executes a keystroke with the character A.

KeyboardKeyPress("Abc")
This example executes a keystroke with the characters A, then b and c.

KeyboardKeyPress("^c^v")
This example executes the shortcuts to copy and paste.

To combine a key with [Shift], precede the key code with + (plus sign).
To combine a key with [Ctrl], precede the key code with ^ (caret).
To combine a key with [Alt], precede the key code with % (percent sign).

To specify repeating keys, use the form {key number}. You must put a space between key and number.

KeyboardKeyPress("{h 10}")
This example presses the letter h 10 times.

KeyboardKeyPress("{LEFT 42}")
This example presses the [left arrow] key 42 times.

KeyboardKeyPress("{DEL}")
This example presses the [Delete] key.

These keys are available:

{BACKSPACE} or {BS}
{BREAK}
{CAPSLOCK}
{CLEAR}
{DELETE} or {DEL}
Arrow keys: {LEFT} {RIGHT} {DOWN} {UP}
{END}
Enter on the numeric keypad {ENTER}
ENTER ~
ESC {ESCAPE} or {ESC}
{HELP}
{HOME}
{INSERT}
{NUMLOCK}
Page Down and up {PGDN} {PGUP}
{RETURN}
{SCROLLLOCK}
{TAB}
{F1} through {F15}.

If you want to send a keystroke to an application that currently is not activated, you may want to use the command WindowFocus(WindowTitleText).

KeyboardToggleVolume

Example:
KeyboardToggleVolume

Toggles the Keyboards Sound On / Off Button.

KeyboardVolumeDown

Example:
KeyboardVolumeDown

Executes the Keyboards Volume Down Button.

KeyboardVolumeUp

Example:
KeyboardVolumeUp

Executes the Keyboards Volume Up Button.

KinectDisable

Example:
KinectDisable

Disables the Kinect device.

KinectEnable

Example:
KinectEnable

Enables the Kinect device.

KinectHideDialog

Example:
KinectHideDialog

This hides the Kinect Settings dialog.

KinectSetBlur(0-15)

Example:
KinectSetBlur(8)

Changes the blur option in the Kinect Tool to the value 8.

KinectSetDamping(Value)

Example:
KinectSetDamping(0.1)

Sets the damping in the Kinect tool to 0,1.

The damping allows to reduce noisy input values. This value can be changed from 0,1 = maximum damping up to 1 = no damping.

KinectSetDepthThreshold(0-2047)

Example:
KinectSetDepthThreshold(1000)

Sets the Depth Threshold in the Kinect Tool to the value 1000.

KinectSetInflate(0-15)

Example:
KinectSetInflate(8)

Changes the inflate option in the Kinect Tool to the value 8.

KinectSetMaxDelta(Value)

Example:
KinectSetMaxDelta(50)

Changes the maximum delta option in the Kinect Tool to 50 (px).

KinectSetMaxHeight(Value)

Example:
KinectSetMaxHeight(250)

Sets the maximum height of a point in the Kinect Tool to the value 250 (px).

KinectSetMaxWidth(Value)

Example:
KinectSetMaxWidth(250)

Sets the maximum width of a point in the Kinect Tool to the value 250 (px).

KinectSetMinHeight(Value)

Example:
KinectSetMinHeight(50)

Sets the minimum height of a point in the Kinect Tool to the value 50 (px).

KinectSetMinWidth(Value)

Example:
KinectSetMinWidth(50)

Sets the minimum width of a point in the Kinect Tool to the value 50 (px).

KinectSetNearThreshold(0-2047)

Example:
KinectSetNearThreshold(800)

Sets the Near Threshold in the Kinect Tool to the value 900.

KinectSetPoints(1-8)

Example:
KinectSetPoints(4)

Changes the current amount of points in the Kinect Tool to 4 points.

KinectShowDialog

Example:
KinectShowDialog

This shows the Kinect Settings dialog.

LogitechPresenterR400Disabled

Example:
LogitechPresenterR400Disabled

Disables the Logitech Presenter R400.

LogitechPresenterR400Enabled

Example:
LogitechPresenterR400Enabled

Enables the Logitech Presenter R400.

MagicQActivatePlayback(ID)

Example:
MagicQActivatePlayback(8)

Activates (starts) the playback 8 within MagicQ.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQChangePage(ID)

Example:
MagicQChangePage(11)

Changes to playback page 11 within MagicQ.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQChannelLevel(ID,Level)

Example:
MagicQChannelLevel(8,90)

Sets the Level of channel 8 within MagicQ to 90%.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQFastBackOnPlayback(ID)

Example:
MagicQFastBackOnPlayback(8)

Goes back one step in the Cue Stack of Playback 8 without taking the step and fade times into account.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQFastForwardOnPlayback(ID)

Example:
MagicQFastForwardOnPlayback(8)

Goes back one step in the Cue Stack of Playback 8 without taking the step and fade times into account.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQGoOnPlayback(ID)

Example:
MagicQGoOnPlayback(8)

Gives a Go on playback 8 within MagicQ.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQJumpToCue(ID,CueID)

Example:
MagicQJumpToCue(8,4)

Jumps to cue 4 at playlist 8 within MagicQ.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQPlaybackLevel(ID,Level)

Example:
MagicQPlaybackLevel(8,90)

Sets the Level of Playback 8 within MagicQ to 90%.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQReleasePlayback(ID)

Example:
MagicQReleasePlayback(8)

Releases (stops) the playback 8 within MagicQ.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQRemoteTrigger(State)

Example:
MagicQRemoteTrigger(State)

Sends a remote trigger signal to MagicQ.

Note: The absolute state is 0 or 1, 2 can be used for toggling the current state.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQStopOnPlayback(ID)

Example:
MagicQStopOnPlayback(8)

Sets playback 8 within MagicQ to pause.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQTestCue(ID)

Example:
MagicQTestCue(4)

Sets cue 4 in test mode within MagicQ.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQTestCueStack(ID)

Example:
MagicQTestCueStack(6)

Sets cue stack 6 in test mode within MagicQ.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQTestPlayback(ID)

Example:
MagicQTestPlayback(8)

Sets the playback 8 in test mode within MagicQ: activates playback 8 and sets the level to 100%.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQUntestCue(ID)

Example:
MagicQUntestCue(4)

Takes cue 4 out of test mode within MagicQ.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQUntestCueStack(ID)

Example:
MagicQUntestCueStack(6)

Takes cue stack 6 out of test mode within MagicQ.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MagicQUntestPlayback(ID)

Example:
MagicQUntestPlayback(8)

Takes the playback 8 out of test mode within MagicQ: releases the playback 8 and sets the level to 0%.

This command is a Chamsys MagicQ Remote Playback Command based on the MagicQ default UDP Port 6553.

MANetInputDisabled

Example:
MANetInputDisabled

Disables the MA Net Input in the Connection Manager.

MANetInputEnabled

Example:
MANetInputEnabled

Enables the MA Net Input in the Connection Manager.

MANetSessionID(ID)

Example:
MANetSessionID(2)

Sets the MA Net Session ID in the Connection Manager to 2.

MidiInputDisabled

Example:
MidiInputDisabled

Disables the Midi Input in the Connection Manager.

MidiInputEnabled

Example:
MidiInputEnabled

Enables Midi Input in the Connection Manager. Please choose a Midi Device first.

MidiNotesMuteDisable

Example:
MidiNotesMuteDisable

Disables incoming Midi Notes in the Midi Notes Editor Tool.

MidiNotesMuteEnable

Example:
MidiNotesMuteEnable

Activates incoming Midi Notes in the Midi Notes Editor Tool.

MidiOutputDisabled

Example:
MidiOutputDisabled

Disables the Midi Output in the Connection Manager.

MidiOutputEnabled

Example:
MidiOutputEnabled

Enables Midi Output in the Connection Manager. Please choose a Midi Device first.

MidiSendControlChange(Channel 1-16,Control 0-127,Value 0-127)

Example:
MidiSendControlChange(1,35,127)

Sets the Control 35 on Midi Channel 1 to the value 127.

The Midi connection needs to be enabled in the Connection Manager.
If you have more than one Midi device, please use the command "MidiSendControlChangeByID".

MidiSendControlChangeByID(ConnectionID,Channel 1-16,Control 0-127,Value 0-127)

Example:
MidiSendControlChangeByID(3,1,35,127)

This sends a message to the Midi device set up as "Midi Output 3" in the Connections > Midi Connections dialog. It sets the Control 35 on Midi Channel 1 to the value 127.

MidiSendNoteOff(Channel 1-16,Note C0-G10)

Example:
MidiSendNoteOff(1,"E5")

Sends the Midi Note Off command to Note E5 on channel 1.

The Midi connection needs to be enabled in the Connection Manager.
If you have more than one Midi device, please use the command "MidiSendNoteOffByID".

MidiSendNoteOffByID(ConnectionID,Channel 1-16,Note C0-G10)

Example:
MidiSendNoteOffByID(3,1,"E5")

This sends a message to the Midi device set up as "Midi Output 3" in the Connections > Midi Connections dialog. It sends the Midi Note Off command to Note E5 on channel 1.

MidiSendNoteOn(Channel 1-16,Note C0-G10,Velocity 0-127)

Example:
MidiSendNoteOn(1,"E5",80)

Sends the Midi Note On command to Note E5 on channel 1 with velocity 80.

The Midi connection needs to be enabled in the Connection Manager.
If you have more than one Midi device, please use the command "MidiSendNoteOnByID".

MidiSendNoteOnByID(ConnectionID,Channel 1-16,Note C0-G10,Velocity 0-127)

Example:
MidiSendNoteOnByID(3,1,"E5",80)

This sends a message to the Midi device set up as "Midi Output 3" in the Connections > Midi Connections dialog. It sends the Midi Note On command to Note E5 on channel 1 with velocity 80.

MidiSendProgramChange(Channel 1-16,Program 0-127)

Example:
MidiSendProgramChange(1,20)

Changes the current program for Midi channel 1 to the program 20.

The Midi connection needs to be enabled in the Connection Manager.
If you have more than one Midi device, please use the command "MidiSendProgramChangeByID".

MidiSendProgramChangeByID(ConnectionID,Channel 1-16,Program 0-127)

Example:
MidiSendProgramChangeByID(3,1,20)

This sends a message to the Midi device set up as "Midi Output 3" in the Connections > Midi Connections dialog. It changes the current program for Midi channel 1 to the program 20.

MidiSendRawMsg(Status,Channel,Data1,Data2,Data3)

Example:
MidiSendRawMsg(10,11,127,0,0)

Sends a Midi Raw Message with the 5 Midi control bytes 10,11,127,0,0.

The Midi connection needs to be enabled in the Connection Manager.

MidiSendRawMsgByID(ConnectionID,Status,Channel,Data1,Data2,Data3)

Example:
MidiSendRawMsgByID(3,10,11,127,0,0)

Sends a Midi Raw Message with the 5 Midi control bytes 10,11,127,0,0 via the Midi device with ID 3. Please select and activate the according MIDI output device in the Connections > Midi Connections dialog.

MidiSendSysEx([Data])

Example:
MidiSendSysEx("[hf0 h7f h01 h02 h01 h01 h32 h34 hF7]")

This sends a Midi "System Exclusive Message". Please select and activate a Midi output device in the Connection Manager. The hexadecimal message needs to be enclosed in square brackets and as any string it is put in quotation marks. The data itself is written in the hxx format. The command MSCSend allows to send MSC messages without converting them to the hex format.

If you send this example to Pandoras Box (with activated MSC), it will go to cue 24. For more information about Pandoras Box SysEx please go to the chapter "MSC Midi Show Control" in the manual.
If you have more than one Midi device, please use the command MidiSendSysExByID.

MidiSendSysExByID(ID,[Data])

Example:
MidiSendSysExByID(3,"[hf0 h7f h01 h02 h01 h01 h32 h34 hF7]")

This sends a Midi "System Exclusive Message" via the Midi device with ID 3. Please select and activate the according MIDI output device in the Connections > Midi Connections dialog. The hexadecimal message needs to be enclosed in square brackets and as any string it is put in quotation marks. The data itself is written in the hxx format. The command MSCSendById allows to send MSC messages without converting them to the hex format.

If you send this example to Pandoras Box (with activated MSC), it will go to cue 24. For more information about Pandoras Box SysEx please go to the chapter "MSC Midi Show Control" in the manual.

MouseLeftClick

Example:
MouseLeftClick

Executes a Mouse Left Click.

MouseLeftDown

Example:
MouseLeftDown

Simulates the depression of the left mouse button.

MouseLeftUp

Example:
MouseLeftUp

Simulates the release of the left mouse button

MouseMove(xPos,yPos)

Example:
MouseMove(200,100)

Moves the mouse cursor to the X Position 200 px and Y Position 100 px.

Tip: If you want to display the current mouse values, create a Mouse Input Node and see its Item Properties.

MouseRightClick

Example:
MouseRightClick

Executes a Mouse Right Click.

MouseRightDown

Example:
MouseRightDown

Simulates the depression of the right mouse button.

MouseRightUp

Example:
MouseRightUp

Simulates the release of the right mouse button.

MSCSend(DeviceID,Command-Format,Command,Cue[optional],CueList[optional],CuePath[optional])

Example:
MSCSend("all","all-types","stop")

Example2:
MSCSend("1","VIDEO","GO",24)

This sends a Midi Show Control (MSC) message. Please select and activate a Midi output device in the Connection Manager.

The possible values for the command are:
DeviceID: "all" or IDs "1" to "127"
Command-Format: "all-types", "lighting", "video", "projection" (case-insensitive)
Command: "go", "stop", "resume", "load", "set", "reset", "go_off" (case-insensitive)
Cue,CueList and CuePath: all optional integer values 1-127

If you send the first example to Pandoras Box (with activated MSC), it will pause the timeline whilst the second jumps to cue 24 and plays. For more information about Pandoras Box MSC/SysEx please go to the chapter "MSC Midi Show Control" in the manual.
If you have more than one Midi device, please use the command MSCSendById.

The command MidiSendSysEx allows to send all kinds of Midi "System Exclusive Messages" but the data needs to be in the hexadecimal format.

MSCSendById(MidiID,DeviceID,Command-Format,Command,Cue[optional],CueList[optional],CuePath[optional])

Example:
MSCSendById(3,"all","all-types","stop")

Example2:
MSCSendById(3,"1","VIDEO","GO",24)

This sends a Midi Show Control (MSC) message via the Midi device with ID 3. Please select and activate the according MIDI output device in the Connections > Midi Connections dialog.

The possible values for the command are:
DeviceID: "all" or IDs "1" to "127"
Command-Format: "all-types", "lighting", "video", "projection" (case-insensitive)
Command: "go", "stop", "resume", "load", "set", "reset", "go_off" (case-insensitive)
Cue,CueList and CuePath: all optional integer values 1-127

If you send the first example to Pandoras Box (with activated MSC), it will pause the timeline whilst the second jumps to cue 24 and plays. For more information about Pandoras Box MSC/SysEx please go to the chapter "MSC Midi Show Control" in the manual.
If you have more than one Midi device, please use the command MSCSendById.

The command MidiSendSysExByID allows to send all kinds of Midi "System Exclusive Messages" but the data needs to be in the hexadecimal format.

OpenAirScanProperties

Example:
OpenAirScanProperties

Opens the dialog for the AirScan tool.

OpenArtNetMonitor

Example:
OpenArtNetMonitor

Opens the Art-NetMonitor which can also be accessed through the Connection Manager.

OpenArtNetUniverseList

Example:
OpenArtNetUniverseList

Opens the Art-Net Universe List which can also be accessed through the Connection Manager.

OpenCameraTrackerDialog

Example:
OpenCameraTrackerDialog

Opens the Camera Tracker dialog.

OpenCITPBrowser

Example:
OpenCITPBrowser

Opens the Thumbnail Browser which can also be accessed through the dialog PB Network Configuration.

OpenComConnections

Example:
OpenComConnections

Opens the COM Connection dialog which gives an better overview than the Connection Manager.

OpenConnectionManager

Example:
OpenConnectionManager

Opens the Connection Manager.

OpenEmailSettings

Example:
OpenEmailSettings

Opens the Email Settings Tool.

OpenHelp

Example:
OpenHelp

Opens this Help File.

OpenIPConfiguration

Example:
OpenIPConfiguration

Opens the PB Network Configuration dialog.

OpenKeyboardShortcuts

Example:
OpenKeyboardShortcuts

Opens the Keyboard Shortcut Editor.

OpenKinectDialog

Example:
OpenKinectDialog

Opens the Kinect Tool.

OpenLoadFileDialog

Example:
OpenLoadFileDialog

Opens the "Load File" dialog in WD to load an existing project.

OpenMacroEditor(MacroName)

Example:
OpenMacroEditor("MyMacro")

Opens the Macro Editor dialog in WD and loads the macro "MyMacro".

OpenMidiNoteEditor

Example:
OpenMidiNoteEditor

Opens the Midi Note Editor.

OpenPageBrowser

Example:
OpenPageBrowser

Opens the Page Browser.

OpenRemoteInput

Example:
OpenRemoteInput

Opens the Remote Input Tool.

OpenSaveAsFileDialog

Example:
OpenSaveAsFileDialog

Opens the "Save as" dialog in WD to save the current project to a different name and directory.

OpenSmsSettings

Example:
OpenSmsSettings

Opens the SMS Settings Tool.

OpenTcpConnections

Example:
OpenTcpConnections

Opens the TCP Connection dialog which gives an better overview than the Connection Manager.

OpenUdpConnections

Example:
OpenUdpConnections

Opens the UDP Connection dialog which gives an better overview than the Connection Manager.

OpenVariableList

Example:
OpenVariableList

Opens the dialog Variable List.

PBApplicationClose(IP address,Processname,NicAdapterName[optional])

Example:
PBApplicationClose("10.169.10.60","notepad","Lan1")

Closes the running notepad application on the PB computer with the IP address 10.169.10.60 in the local network. Please have a look into the Windows Task Manager to get the correct process name of the running application you want to close, enter this name without ".exe". Depending on your Windows version, this is either displayed in the tab "Processes" or "Details".

The command is sent out via NIC adapter "Lan1" of the local PC.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center. Since version 7, the "Remoting" setting "Allow execution of files" must be enabled for this command.

PBApplicationCloseAll(Processname,NicAdapterName[optional])

Example:
PBApplicationCloseAll("notepad","Lan1")

Closes the running notepad application on all PB computers in the local network. Please have a look into the Windows Task Manager to get the correct process name of the running application you want to close, enter this name without ".exe". Depending on your Windows version, this is either displayed in the tab "Processes" or "Details".

The command is sent out via NIC adapter "Lan1" of the local PC.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center. Since version 7, the "Remoting" setting "Allow execution of files" must be enabled for this command.

PBApplicationStart(IP address,Filepath,NicAdapterName[optional])

Example:
PBApplicationStart("10.169.10.60","notepad.exe","Lan1")

Opens the notepad on the PB computer with the IP address 10.169.10.60 in the local network. The command is sent out via NIC adapter "Lan1" of the local PC.

Example 2:
PBApplicationStart("10.169.10.60","C:\Program Files\Internet Explorer\iexplore.exe")

Opens the Internet Explorer on the PB computer with the IP address 10.169.10.60 in the local network.
If the application you want to start is not a standard Windows application, please use the whole file path.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center. Since version 7, the "Remoting" setting "Allow execution of files" must be enabled for this command.

PBApplicationStartAll(Filepath,NicAdapterName[optional])

Example:
PBApplicationStartAll("notepad.exe","Lan1")

Opens the notepad on all PB computers in the local network. The command is sent out via NIC adapter "Lan1" of the local PC.

Example 2:
PBApplicationStartAll("C:\Program Files\Internet Explorer\iexplore.exe")

Opens the Internet Explorer on all PB computers in the local network.
If the application you want to start is not a standard Windows application, please use the whole file path.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center. Since version 7, the "Remoting" setting "Allow execution of files" must be enabled for this command.

PBApplicationStartAllEx(Filepath,Application arguments,NicAdapterName[optional])

Example:
PBApplicationStartEx("C:\path\the_answer.bat","42","Lan1")

Executes "the_answer.bat" on the PB computers in the local network and passes the argument "42". The command is sent out via NIC adapter "Lan1" of the local PC.
If your application or file requires more than one argument, you can separate them by a white space, e.g. "mattresses flollopping and volluing floopily".

If the application you want to start is not a standard Windows application, please use the whole file path.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center. Since version 7, the "Remoting" setting "Allow execution of files" must be enabled for this command.

PBApplicationStartEx(IP address,Filepath,Application arguments,NicAdapterName[optional])

Example:
PBApplicationStartEx("10.169.10.60","C:\path\the_answer.bat","42","Lan1")

Executes "the_answer.bat" on the PB computer with the IP address 10.169.10.60 in the local network and passes the argument "42". The command is sent out via NIC adapter "Lan1" of the local PC.
If your application or file requires more than one argument, you can separate them by a white space, e.g. "STARTWDF --viewer".

If the application you want to start is not a standard Windows application, please use the whole file path.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center. Since version 7, the "Remoting" setting "Allow execution of files" must be enabled for this command.

PBCanvasUpdatesDisableForSite(FolderID,FileID,SiteID)

Example:
PBCanvasUpdatesDisableForSite(1,3,2)

This applies to the Canvas with Folder ID 1 and File ID 3 and sets the option "Block canvas updates for selected nodes" in the Canvas Inspector so that the Site with ID 2 is blocked. The Site does not receive Canvas updates any more even if it is listed in the File Location Table (at the bottom of the Inspector).

Note that this command works only with a PB version below 6.0.4 as then, the option was removed. Now, a Canvas is spread like other Resource too, so simply restrict the spreading to those Sites that should display the Canvas. The following commands could be helpful: ResourceAttachByID, ResourceDetachByID or ResourceSpreadToSiteById

PBCanvasUpdatesEnableForSite(FolderID,FileID,SiteID)

Example:
PBCanvasUpdatesEnableForSite(1,3,2)

This applies to the Canvas with Folder ID 1 and File ID 3 and removes the option "Block canvas updates for selected nodes" in the Canvas Inspector for Site with ID 2 if it was blocked before. The Site does receive Canvas updates again if it is listed in the File Location Table (at the bottom of the Inspector).

Note that this command works only with a PB version below 6.0.4 as then, the option was removed. Now, a Canvas is spread like other Resource too, so simply restrict the spreading to those Sites that should display the Canvas. The following commands could be helpful: ResourceAttachByID, ResourceDetachByID or ResourceSpreadToSiteById

PBCanvasUpdatesExclusiveForSite(FolderID,FileID,SiteID)

Example:
PBCanvasUpdatesExclusiveForSite(1,3,2)

This applies to the Canvas with Folder ID 1 and File ID 3 and sets the option "Block canvas updates for selected nodes" in the Canvas Inspector so that only the Site with ID 2 is not blocked. The Site does receive Canvas updates if it is listed in the File Location Table (at the bottom of the Inspector).

Note that this command works only with a PB version below 6.0.4 as then, the option was removed. Now, a Canvas is spread like other Resource too, so simply restrict the spreading to those Sites that should display the Canvas. The following commands could be helpful: ResourceAttachByID, ResourceDetachByID or ResourceSpreadToSiteById

PBClose(IP address,NicAdapterName[optional])

Example:
PBClose("10.169.10.65","Lan1")

Closes the PB software on the computer with the IP address 10.169.10.65 in the local network. The command is sent out via NIC adapter "Lan1" of the local PC.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBCloseAll(NicAdapterName[optional])

Example:
PBCloseAll("Lan1")

Closes the PB software on all computers in the local network. The command is sent out via NIC adapter "Lan1" of the local PC.

Example2:
PBCloseAll()

Use this, if you do not need to specify the NIC adapter explicitly.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBCloseProject(SaveCurrent)

Example:
PBCloseProject(True)

Closes the current project in PB after saving it.

Example 2:
PBCloseProject(False)

Closes the current project in PB without saving it.

PBCueMap(ButtonID,SeqID,CueID)

Example:
PBCueMap(2,1,10)

Links Button 2 of the PB Jog/Shuttle Board to Cue 10 of sequence 1 in Pandoras Box Master System.

PBDeactivateOutput2(IP address)

Example:
PBDeactivateOutput2("10.169.10.65")

Deactivates output 2 of the PB computer with the IP address 10.169.10.65.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBDeactivateOutput2All

Example:
PBDeactivateOutput2All

Deactivates output 2 of all PB computers in the local network.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBFaderMap(FaderID,SeqID)

Example:
PBFaderMap(3,1)

Links Fader 3 of the PB Fader Board to the sequence 1 in Pandoras Box Master System.

PBLoadProject(Path,Name,SaveCurrent)

Example:
PBLoadProject("C:\Christie\content\projects","Rotation.pbb",True)

Saves the current PB project and opens the project "Rotation.pbb" from the specified directory.

Example 2:
PBLoadProject("C:\Christie\content\projects","Rotation.pbb",False)

Opens the PB project "Rotation.pbb" from the specified directory without saving the current project.

PBPlaylistJumpToNextItemByID(SiteID,DeviceID,FolderID,FileID)

Example:
PBPlaylistJumpToNextItemByID(2,1,3,5)

This jumps to the next entry in the PB Playlist with the Folder/File ID [3,5] which is assigned to the Device 1 of Site 2.

Please use Pandoras Box version 8.3 or higher to navigate its Playlists.

PBPlaylistJumpToNextItemByName(SiteID,DeviceID,ProjectPath)

Example:
PBPlaylistJumpToNextItemByName(2,1,"test/Videoloop")

This jumps to the next entry in the PB Playlist named "Videoloop" from the project folder "test" which is assigned to the Device 1 of Site 2.

Please use Pandoras Box version 8.3 or higher to navigate its Playlists.

PBPlaylistJumpToPreviousItemByID(SiteID,DeviceID,FolderID,FileID)

Example:
PBPlaylistJumpToPreviousItemByID(2,1,3,5)

This jumps to the previous entry in the PB Playlist with the Folder/File ID [3,5] which is assigned to the Device 1 of Site 2.

Please use Pandoras Box version 8.3 or higher to navigate its Playlists.

PBPlaylistJumpToPreviousItemByName(SiteID,DeviceID,ProjectPath)

Example:
PBPlaylistJumpToPreviousItemByID(2,1,"test/Videoloop")

This jumps to the previous entry in the PB Playlist named "Videoloop" from the project folder "test" which is assigned to the Device 1 of Site 2.

Please use Pandoras Box version 8.3 or higher to navigate its Playlists.

PBProjectRefresh

Example:
PBProjectRefresh

This reads-out information from a Pandoras Box project and stores it in a temporary cache. The command needs to be called before other commands like VGetAsset...

PBReboot(IP address,NicAdapterName[optional])

Example:
PBReboot("10.169.10.65","Lan1")

Reboots the PB computer with the IP address 10.169.10.65 in the local network. The example names the optional NIC adapter for sending the command with "Lan1". If you do not need to specify the NIC adapter explicitly, simply write PBReboot("10.169.10.65")

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBRebootAll(NicAdapterName[optional])

Example:
PBRebootAll("Lan1")

Reboots all PB computers in the local network. The example names the optional NIC adapter for sending the command with "Lan1".

Example2:
PBRebootAll()

Use this, if you do not need to specify the NIC adapter explicitly.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBSaveProject

Example:
PBSaveProject

Saves the current project of the PB Master device that is connected to the Widget Designer.

PBSetIP1(IP address,New IP address,New SubnetMask,NicAdapterName[optional])

Example:
PBSetIP1("10.169.10.65","2.0.0.115","255.255.255.0","Lan1")

Changes the first IP address of the PB computer with the IP address 10.169.10.65 to the IP 2.0.0.115 with the subnet mask 255.255.255.0.
The example names the optional NIC adapter for sending the command with "Lan1". If you do not need to specify the NIC adapter explicitly, simply write PBSetIP1("10.169.10.65","2.0.0.115","255.255.255.0")

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBSetIP1Dhcp(IP address)

Example:
PBSetIP1Dhcp("2.0.0.111")

Sets the first network adapter of the PB computer with the IP address 2.0.0.111 to DHCP.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBSetIP2(IP address,New IP address,New SubnetMask,NicAdapterName[optional])

Example:
PBSetIP2("10.169.10.65","2.0.0.115","255.255.255.0","Lan1")

Changes the second IP address of the PB computer with the IP address 10.169.10.65 to the IP 2.0.0.115 with the subnet mask 255.255.255.0
The example names the optional NIC adapter for sending the command with "Lan1". If you do not need to specify the NIC adapter explicitly, simply write PBSetIP2("10.169.10.65","2.0.0.115","255.255.255.0")

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBSetIP2Dhcp(IP address)

Example:
PBSetIP2Dhcp("2.0.0.111")

Sets the second network adapter of the PB computer with the IP address 2.0.0.111 to DHCP.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBSetOutput1Resolution(IP address,1024 768 60)

Example:
PBSetOutput1Resolution("10.169.10.65",1920 1080 60)

Sets the resolution of output 1 of the PB computer with the IP address 10.169.10.65 to 1920x1080 px and 60 Hz.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBSetOutput1Resolutionall(1024 768 60)

Example:
PBSetOutput1Resolutionall(1024 768 60)

Sets the resolution of output 1 of all PB computers in the local network to 1024x786 px @ 60 Hz.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBSetOutput2Resolution(IP address,1024 768 60)

Example:
PBSetOutput2Resolution("10.169.10.65",1920 1080 60)

Sets the resolution of output 2 of the PB computer with the IP address 10.169.10.65 to 1920x1080 px and 60 Hz.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBSetOutput2Resolutionall(1024 768 60)

Example:
PBSetOutput2Resolutionall(1024 768 60)

Sets the resolution of output 2 of all PB computers in the local network to 1024x786 px @ 60 Hz.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBShutDown(IP address,NicAdapterName[optional])

Example:
PBShutDown("10.169.10.65","Lan1")

Turns off the PB computer with the IP address 10.169.10.65 in the local network.
The example names the optional NIC adapter for sending the command with "Lan1". If you do not need to specify the NIC adapter explicitly, simply write PBShutDown("10.169.10.65")

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBShutDownAll(NicAdapterName[optional])

Example:
PBShutDownAll("Lan1")

Shuts down all PB computers in the local network.
The example names the optional NIC adapter for sending the command with "Lan1".

Example2:
PBShutDownAll()

Use this, if you do not need to specify the NIC adapter explicitly.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBStandby(IP address,NicAdapterName[optional])

Example:
PBStandby("10.169.10.65","Lan1")

Sets the PB computer with the IP address 10.169.10.65 in standby mode.
The example names the optional NIC adapter for sending the command with "Lan1". If you do not need to specify the NIC adapter explicitly, simply write PBStandby("10.169.10.65")

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBStandbyAll(NicAdapterName[optional])

Example:
PBStandbyAll("Lan1")

Sets all PB computer with the same IP range in standby mode
The example names the optional NIC adapter for sending the command with "Lan1".

Example2:
PBStandbyAll()

Use this, if you do not need to specify the NIC adapter explicitly.

Please note:
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBStartClient(IP address,NicAdapterName[optional])

Example:
PBStartClient("10.169.10.65","Lan1")

Launches the PB Client software on the computer with the IP address 10.169.10.65 in the local network. The command is sent out via NIC adapter "Lan1" of the local PC.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBStartClientAll(NicAdapterName[optional])

Example:
PBStartClientAll("Lan1")

Launches the PB Client software on all computers in the local network. The command is sent out via NIC adapter "Lan1" of the local PC.

Example2:
PBStartClientAll()

Use this, if you do not need to specify the NIC adapter explicitly.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBStartMaster(IP address,NicAdapterName[optional])

Example:
PBStartMaster("10.169.10.65","Lan1")

Launches the PB Master software on the computer with the IP address 10.169.10.65 in the local network. The command is sent out via NIC adapter "Lan1" of the local PC.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PBStartMasterAll(NicAdapterName[optional])

Example:
PBStartMasterAll("Lan1")

Launches the PB Master software on all computers in the local network. The command is sent out via NIC adapter "Lan1" of the local PC.

Example2:
PBStartMasterAll()

Use this, if you do not need to specify the NIC adapter explicitly.

Please note:
If you do not specify the NIC adapter name, it might happen that the command binds to the wrong adapter and therefore does not send it out where it was intended to.
All PB commands will only work when the PB Menu is installed on the computers, the current version can be found in our Download-Center.

PlayClientSound(Filename)

Example:
PlayClientSound("C:\Christie\media\instrument.wav")

Plays the wave file "instrument.wav" from the specified directory on the current client (depending on the script's context). Please note, that WD does not play another format than wave files.

PlayClientSoundLoop(Filename)

Example:
PlayClientSoundLoop(C:\Christie\media\instrument.wav)

Plays (and loops) the wave file "instrument.wav" from the specified directory on the current client (depending on the script's context). Please note, that WD does not play another format than wave files.

PlaySound(Filename)

Example:
PlaySound("C:\Christie\media\instrument.wav")

Plays the wave file "instrument.wav" from the specified directory. Please note, that WD does not play another format than wave files.

PlaySoundLoop(Filename)

Example:
PlaySoundLoop(C:\Christie\media\instrument.wav)

Loops the wave file "instrument.wav" from the specified directory. Please note, that WD does not play another format than WAV files.

ReconnectFaderboardDevices

Example:
ReconnectFaderboardDevices

This command resets the USB connection to all available fader board controllers (i.e. Jog/Shuttle and Fader Extension) of your Pandoras Box Master and Backup connection. The IP address and Domain for the "Master Connection" and "Backup Connection" to Pandoras Box can to be set up in the menu: Connections > PB Configuration.

ReconnectFaderboardDevicesBackup

Example:
ReconnectFaderboardDevicesBackup

This command resets the USB connection to all available fader board controllers (i.e. Jog/Shuttle and Fader Extension) of your Pandoras Box Backup connection. The IP address and Domain for the "Backup Connection" to Pandoras Box can to be set up in the menu: Connections > PB Configuration.

ReconnectFaderboardDevicesMaster

Example:
ReconnectFaderboardDevicesMaster

This command resets the USB connection to all available fader board controllers (i.e. Jog/Shuttle and Fader Extension) of your Pandoras Box Master connection. The IP address and Domain for the "Master Connection" and "Backup Connection" to Pandoras Box can to be set up in the menu: Connections > PB Configuration.

RemoveGraphicLayer(SiteID,DeviceID)

Example:
RemoveGraphicLayer(1,3)

Removes Layer 3 from the Site 1 (e.g. a Server) if it is a Graphic Layer. This command does not just toggle the layer invisible, it deletes it entirely. Note that graphic layers are discontinued since Pandoras Box version 8.0.0

RemoveLayer(SiteID,DeviceID)

Example:
RemoveLayer(1,3)

Removes Layer 3 from the Site 1 (e.g. a Server). This command does not just toggle the layer invisible, it deletes it entirely.

RemoveVideoLayer(SiteID,DeviceID)

Example:
RemoveVideoLayer(1,3)

Removes Layer 3 from the Site 1 (e.g. a Server) if it is a Video Layer. This command does not just toggle the layer invisible, it deletes it entirely.

ResetAll

Example:
ResetAll

Resets all parameters of all layers of all Servers within the Pandoras Box Project.

ResetDevice(SiteID,DeviceID)

Example:
ResetDevice(1,3)

Resets all parameters of layer 3 of site 1 within the Pandoras Box Project.

ResetParam(SiteID,DeviceID,ParamName)

Example:
ResetParam(1,3,"X Scale")

Resets the parameter X Scale of layer 3 of site 1 within the Pandoras Box Project.

ResetSerialLinkDeviceConnection(SiteID,DeviceID)

Example:
ResetSerialLinkDeviceConnection(3,1)

Resets the connection of the Serial Link Device with the Device ID [2.1] of your Pandoras Box Master and Backup connection. In the status bar of PB and the Devices Tree, you will see that the device is dis- and reconnected.
The IP address and Domain for the "Master Connection" and "Backup Connection" to Pandoras Box can to be set up in the menu: Connections > PB Configuration.

ResetSerialLinkDeviceConnectionBackup(SiteID,DeviceID)

Example:
ResetSerialLinkDeviceConnectionBackup(3,1)

Resets the connection of the Serial Link Device with the Device ID [3.1] of your Pandoras Box Backup connection. In the status bar of PB and the Devices Tree, you will see that the device is dis- and reconnected.
The IP address and Domain for the "Backup Connection" to Pandoras Box can to be set up in the menu: Connections > PB Configuration.

ResetSerialLinkDeviceConnectionMaster(SiteID,DeviceID)

Example:
ResetSerialLinkDeviceConnectionMaster(3,1)

Resets the connection of the Serial Link Device with the Device ID [3.1] of your Pandoras Box Master connection. In the status bar of PB and the Devices Tree, you will see that the device is dis- and reconnected.
The IP address and Domain for the "Master Connection" to Pandoras Box can to be set up in the menu: Connections > PB Configuration.

ResetSite(SiteID)

Example:
ResetSite(1)

Resets all parameters of all layers of site 1 within the Pandoras Box Project.

ResetTcpDeviceConnection(SiteID,DeviceID)

Example:
ResetTcpDeviceConnection(3,1)

Resets the connection of the TCP Device with the Device ID [2.1] of your Pandoras Box Master and Backup connection. In the status bar of PB and the Devices Tree, you will see that the device is dis- and reconnected.
The IP address and Domain for the "Master Connection" and "Backup Connection" to Pandoras Box can to be set up in the menu: Connections > PB Configuration.

ResetTcpDeviceConnectionBackup(SiteID,DeviceID)

Example:
ResetTcpDeviceConnectionBackup(2,1)

Resets the connection of the TCP Device with the Device ID [2.1] of your Pandoras Box Backup connection. In the status bar of PB and the Devices Tree, you will see that the device is dis- and reconnected.
The IP address and Domain for the "Backup Connection" to Pandoras Box can to be set up in the menu: Connections > PB Configuration.

ResetTcpDeviceConnectionMaster(SiteID,DeviceID)

Example:
ResetTcpDeviceConnectionMaster(3,1)

Resets the connection of the TCP Device with the Device ID [3.1] of your Pandoras Box Master connection. In the status bar of PB and the Devices Tree, you will see that the device is dis- and reconnected.
The IP address and Domain for the "Master Connection" to Pandoras Box can to be set up in the menu: Connections > PB Configuration.

ResourceAdd(FilePath,SiteID,FolderID,FileID)

Example:
ResourceAdd("C:\Christie\content\Video.mpg",3,4,2)

This adds a file from a remote or local node (i.e. Client or Master) to the main folder of your Pandoras Box project.
The file "Video.mpg" is loaded from the Site with ID 3 from the path "C:\Christie\content". It is added to the project folder and assigned with Folder and File ID 4,2. If you do not need a Folder/File ID you may set it to "0,0" in the command.

ResourceAddFileFromLocal(FilePath)

Example:
ResourceAddFileFromLocal("C:\Christie\content\Image.png")

This adds a file from your local node (i.e. the Master) to the main folder of your Pandoras Box project.
The file "Image.png" is loaded from the path "C:\Christie\content" and added to the project folder.

ResourceAddFileFromLocalToProjectPath(FilePath,ProjectPath)

Example:
ResourceAddFileFromLocalToProjectPath("C:\Christie\content\Image.png","background\images")

This adds a file from your local node (i.e. the Master) to a subfolder of your Pandoras Box project.
The file "Image.png" is loaded from the path "C:\Christie\content" and added to the subfolder "images" in the subfolder "background" within the project folder.

ResourceAddFolder(FolderName)

Example:
ResourceAddFolder("loops")

This adds a subfolder to your Pandoras Box project.
A new subfolder named "loops" is generated.

ResourceAddFolderFromLocal(FilePath)

Example:
ResourceAddFolderFromLocal("C:\Christie\content\testpattern")

This adds a folder from your local node (i.e. the Master) to the main folder of your Pandoras Box project.
The folder "testpattern" including all files is loaded from the path "C:\Christie\content" and added to the project folder.

ResourceAddFolderFromLocalByID(FolderPath,FolderID,FileID)

Example:
ResourceAddFolderFromLocalByID("C:\Christie\content\testpattern",5,1)

This adds a folder from your local node (i.e. the Master) to the main folder of your Pandoras Box project and assigns Folder/File IDs.
The folder "testpattern" including all files is loaded from the path "C:\Christie\content" and added to the project folder. In addition all files are numbered consecutively with a Folder/File ID starting from 5,1.

ResourceAddFolderFromLocalToProjectPath(FilePath,ProjectPath)

Example:
ResourceAddFolderFromLocalToProjectPath("C:\Christie\content\testpattern","background\images")

This adds a folder from your local node (i.e. the Master) to a subfolder of your Pandoras Box project.
The folder "testpattern" including all files is loaded from the path "C:\Christie\content" and added to the subfolder "images" in the subfolder "background" within the project folder.

ResourceAddFolderFromLocalToProjectPathByID(FolderPath,ProjectPath,FolderID,FileID)

Example:
ResourceAddFolderFromLocalToProjectPathByID("C:\Christie\content\testpattern","background\images",5,1)

This adds a folder from your local node (i.e. the Master) to a subfolder of your Pandoras Box project and assigns Folder/File IDs.
The folder "testpattern" including all files is loaded from the path "C:\Christie\content" and added to the subfolder "images" in the subfolder "background" within the project folder. In addition all files are numbered consecutively with a Folder/File ID starting from 5,1.

ResourceAddFolderToPath(FolderName,ProjectPath)

Example:
ResourceAddFolderToPath("loops","background\images")

This adds a subfolder to an existing subfolder in your Pandoras Box project.
A new subfolder named "loops" is generated in the subfolder "images" in the subfolder "background" within the project folder.

ResourceAddImageSeq(FolderPath,FPS,SiteID,FolderID,FileID)

Example:
ResourceAddImageSeq("C:\ImgSeq\Intro",25,1,2,3)

This adds the image sequence saved under "C:\ImgSeq\Intro" on the hard disc of Site 1 to the main folder in the Pandoras Box Project tab. The frame rate of the image sequence is set to 25 frames/second and the File and Folder ID is [2,3]. If you do not need a Folder and File ID you may set it to "0,0" in the command.