Command List |
|
Command List |
|
Command List |
|
Command List |
|
Please wait. Due to its content this page might take a while to load...
This topic lists all commands that are available in Widget Designer. How they are used is explained in the introducing topic.
ActivateAll Example: Activates all parameters of all layers of all Servers within the Pandoras Box Project. |
ActivateDevice(SiteID,DeviceID) Example: Activates all parameters of layer 3 of site 1 within the Pandoras Box Project. |
ActivateParam(SiteID,DeviceID,ParamName) Example: Activates the parameter X Scale of layer 3 of site 1 within the Pandoras Box Project. |
ActivateSite(SiteID) Example: Activates all parameters of all layers of site 1 within the Pandoras Box Project. |
AddEncryptionKey(Key) Example: 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: 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: 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. |
AddGraphicLayer(SiteID,Count) Example: 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: 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. |
ApplicationClose(Processname) Example: 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: 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: These commands end the process of VLC Player and Microsoft Paint. |
ApplicationKillAllOtherWDInstances Example: 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: 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") Examples with optional parameter for commandline arguments: If you 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. Widget Designer starts with the following commandline arguments: |
ApplyView(ViewID) Example: 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: 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: 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: Disables the Art-Net Input in the Connection Manager. |
ArtNetInputEnabled Example: Enables the Art-Net Input in the Connection Manager. |
ArtnetInputSetAdapter(NicAdapterName) Example: 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: Disables the Art-Net Output in the Connection Manager. |
ArtNetOutputEnabled Example: Enables the Art-Net Output in the Connection Manager. |
ArtnetOutputSetAdapter(IP address,NicAdapterName) Example: 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: 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: 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: 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: Clears all active parameters of layer 3 of site 1 within the Pandoras Box Project. |
ClearActiveParam(SiteID,DeviceID,ParamName) Example: Sets a clear active to the parameter X Scale of layer 3 of site 1 within the Pandoras Box Project. |
ClearActiveSite(SiteID) Example: Clears all active parameters of all layers of site 1 within the Pandoras Box Project. |
ClearAllActive Example: Clears all active parameters of all layers of all Servers within the Pandoras Box Project. |
ClearSelection Example: Clears the device selection within the Pandoras Box project. |
CloseAirScanProperties Example: Closes the dialog for the AirScan tool. |
CloseAllDialogs Example: This closes all dialogs from Widget Designer. |
CloseArtNetMonitor Example: Closes the Art-NetMonitor which can also be accessed through the Connection Manager. |
CloseArtNetUniverselist Example: Closes the Art-Net Universe List which can also be accessed through the Connection Manager. |
CloseCameraTrackerDialog Example: Closes the Camera Tracker dialog. |
CloseCitpBrowser Example: Closes the Thumbnail Browser which can also be accessed through the dialog PB Network Configuration. |
CloseComConnections Example: Closes the COM Connection dialog which gives an better overview than the Connection Manager. |
CloseConnectionManager Example: Closes the Connection Manager. |
CloseEmailSettings Example: Closes the Email Settings Tool. |
CloseIpConfiguration Example: Opens the PB Network Configuration dialog. |
CloseKeyboardShortcuts Example: Closes the Keyboard Shortcut Editor. |
CloseKinectDialog Example: Closes the Kinect Tool. |
CloseMacroEditor(MacroName) Example: Closes the Macro Editor with the macro "MyMacro". |
CloseMidiNoteEditor Example: Closes the Midi Note Editor. |
ClosePageBrowser Example: Closes the Page Browser. |
CloseRemoteInput Example: Closes the Remote Input Tool. |
CloseSmsSettings Example: Closes the SMS Settings Tool. |
CloseTcpConnections Example: Closes the TCP Connection dialog which gives an better overview than the Connection Manager. |
CloseUdpConnections Example: Closes the UDP Connection dialog which gives an better overview than the Connection Manager. |
CloseVariableList Example: Closes the dialog Variable List. |
COMInject(ID,Message) Example: 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. Example: 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: Sends the message "Play" via the COM Port Connection with the ID 1 in the Connection Manager. |
COMSendDec(ID,Message) Example: 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: 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: Starts the COM Port Connection with the ID 1 in the Connection Manager. |
COMStop(ID) Example: Stops the COM Port Connection with the ID 1 in the Connection Manager. |
DebugClear Example: This clears the log entries of the Debug Logger dialog. |
DebugDisable Example: Disables the Debug Logging so that error messages are not added to the Debug Logger dialog. |
DebugEnable Example: Enables the Debug Logging so that error messages are added to the Debug Logger dialog. |
DebugJson(JsonVarName) Example: This displays the value of the variable named varJson (with the JSON type) in the Debug Logger dialog. |
DebugMessage(Message,Arbitrary Value) Example: 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. Here you can also choose to open the Debug Logger manually.. Example2: The second example uses the global variable "Now" which expresses the current date and time. The Debug Logger displays: Example3: If you 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: |
DebugShow Example: This opens Debug Logger dialog. |
DeviceAcceptDmxById(SiteID,DeviceID,"On"/"Off") Example: 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: 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: 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: 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 like to select solely layer 3, use the command DeviceSelect(SiteID,DeviceID) |
DeviceBringToFront(SiteID,DeviceID) Example: 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: 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. |
DeviceFadeToParam(SiteID,DeviceID,Param,Value,Time) Example: 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. |
DeviceMoveToBack(SiteID,DeviceID) Example: 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: 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: 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 like to add layer 3 to the current selection, use the command DeviceAddToSelection(SiteID,DeviceID) |
DeviceSendToBack(SiteID,DeviceID) Example: 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: 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: Sets the IP of Site 3 inside your PB project to 2.0.0.103. Please note: |
DeviceSetMedia(SiteID,DeviceID,FolderID,FileID) Example: 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: 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: 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: 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: 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". |
DeviceSetMesh(SiteID,DeviceID,FolderID,FileID) Example: 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: 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: 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: 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: 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: Sets the X Position of Server 1, Layer 2 to the value 3. In the manual, there is a topic with all parameter names. |
DeviceSetParamDirect(SiteID,DeviceID,ParamName,AbsoluteValue) Example: 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. |
DeviceSetParamDirectSilent(SiteID,DeviceID,ParamName,AbsoluteValue) Example: This command combines the commands DeviceSetParamDirect and DeviceSetParamSilent: |
DeviceSetParamInSelection(ParamName,AbsoluteValue) Example: Sets the Opacity of all selected Devices in PB to the value 255. |
DeviceSetParamRelative(SiteID,DeviceID,ParamName,RelativeValue) Example: Adds the value 100 to the parameter Opacity of Server 1, Layer 2. |
DeviceSetParamRelativeInSelection(ParamName,RelativeValue) Example: Adds the value 20 to the Opacity parameter of all selected Devices in PB. |
DeviceSetParamSilent(SiteID,DeviceID,ParamName,AbsoluteValue) Example: 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. |
DeviceSetPreset(SiteID,DeviceID,PresetID1,PresetID2) Example: 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: 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: 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: 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: 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: 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: 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: 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: Deletes the whole directory Dir_3 permanently including its content. |
DMXLinkInDisable Example: Disables the Widget Designer to receive values via the Christie DMX Link. This can also be done in the Connection Manager. |
DMXLinkInEnable Example: Enables the Widget Designer to receive values via the Christie DMX Link. This can also be done in the Connection Manager. |
DMXLinkInReset Example: Resets the value of all channels received via the Christie DMX Link which is enabled in the Connection Manager. |
DMXLinkOutDisable Example: Disables the Widget Designer to send out values via the Christie DMX Link. This can also be done in the Connection Manager. |
DMXLinkOutEnable Example: Enables the Widget Designer to send out values via the Christie DMX Link. This can also be done in the Connection Manager. |
DMXLinkOutReset Example: 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: 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: Sends out the value 20 on channel 255 via the Christie DMX Link which is enabled in the Connection Manager. |
EmailClearInbox Example: Clears the Email Inbox from the Email tool. |
EmailClearOutbox Example: Clears the Email Outbox from the Email tool. |
EmailExportInbox(FilePath) Example: 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: 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: Sets the Email Address for the outgoing Email Server in the Email Settings Tool to "support.pandorasbox@christiedigital.com". |
EmailOutputPasswordSet(Password) Example: Sets the Email Password for the outgoing Email Server in the Email Settings Tool to "SECRET". |
EmailOutputSendDisable Example: 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: Checks the option "Use Default Authentification" for the outgoing Email Server in the Email Settings Tool. |
EmailOutputUsernameSet(Username) Example: Sets the Email Username for the outgoing Email Server in the Email Settings Tool to "support". |
EmailSend(To,Subject,Message) Example: 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: 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: 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: 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: 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: |
EmailServerSet(EmailServerSmpt) Example: Sets the SMTP Mail Server in the Email Settings Tool to smtp.googlemail.com. |
EmailUseSSL(True/False) Example: Checks the option "Use SSL" for the outgoing Email Server in the Email Settings Tool. |
FileCopy(SourcePath,TargetPath) Example: 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: Deletes the file "file_4.txt" permanently. |
FullScreenByID(SiteID) Example: Switches the site 4 to fullscreen mode in Pandoras Box project whether it is in windowed mode or in fullscreen mode already. |
FullScreenByIP(IP address) Example: Switches the Pandoras Box master or client with the IP address 2.0.0.1 to fullscreen mode. |
HTTPRequestToVar(URL,VarName) Example: This allows to send single HTTP commands via scripts directly to a web server and writes the answer to a WD Variable. Please make sure the variable has the correct type. It is not necessary to establish the connection from Widget Designer to the external web server using the Connection Manager but they need to be connected via a switch for example. The HTTP Request is useful when working with an external web server. The first example refers to the web server from the web site postman-echo.com Example 2: As well, you may control external devices, e.g. a projector supporting the HTTP protocol. This is an alternative to controlling them via a RS232 / Serial protocol.
Use the command HTTPRequestToVarWithLogin if the external web server requires a username and / or a passwort and supports a HTTP Basic Authentication (in most browsers that gives you a pop-up window asking for credentials). |
HTTPRequestToVarWithLogin(Username,Password,URL,VarName) Example: This allows to send single HTTP commands via scripts directly to a web server including required login information and writes the answer to a WD Variable. Please make sure the variable has the correct type. It is not necessary to establish the connection from Widget Designer to the external web server using the Connection Manager but they need to be connected via a switch for example. The HTTP Request is useful when working with an external web server. The first example refers to the web server from the web site postman-echo.com Example 2: As well, you may control external devices, e.g. a projector supporting the HTTP protocol. This is an alternative to controlling them via a RS232 / Serial protocol.
Use the command HTTPRequestToVar if the external web server does not require a username and / or a passwort nor supports a HTTP Basic Authentication (in most browsers that gives you a pop-up window asking for credentials). |
IncludeInSpread(SiteID) Example: 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: This loads the JSON formatted content of the text file "participants.txt" and writes it in the variable "varJson". Exemplary content of the JSON file: 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: This loads the XML formatted content of the text file "participants.xml" and writes it in the variable "varJson". Exemplary content of the XML file: Resulting Json Variable: 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) Example: Writes the value of the requested Json item "date" from the URL "http://time.jsontest.com/" into the variable "varString". |
JsonRequestToVar(URL,VarName) Example: Writes the value of the requested JSON data from the URL "http://time.jsontest.com/" into the variable "varJson". |
JsonRequestToVarWithLogin(Username,Password,URL,VarName) Example: This command logs in to "http:\\localhost:8000\timeEntry.json" with username "christie" and password "abc" and stores the Json data into the variable varJson. |
KeyboardKeyPress(Keycode) Example: The first example executes a keystroke with the character A. KeyboardKeyPress("Abc") KeyboardKeyPress("^c^v") To combine a key with [Shift], precede the key code with + (plus sign). To specify repeating keys, use the form {key number}. You must put a space between key and number. KeyboardKeyPress("{h 10}") KeyboardKeyPress("{LEFT 42}") KeyboardKeyPress("{DEL}") These keys are available: {BACKSPACE} or {BS} 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: Toggles the Keyboards Sound On / Off Button. |
KeyboardVolumeDown Example: Executes the Keyboards Volume Down Button. |
KeyboardVolumeUp Example: Executes the Keyboards Volume Up Button. |
KinectDisable Example: Disables the Kinect device. |
KinectEnable Example: Enables the Kinect device. |
KinectHideDialog Example: This hides the Kinect Settings dialog. |
KinectSetBlur(0-15) Example: Changes the blur option in the Kinect Tool to the value 8. |
KinectSetDamping(Value) Example: 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: Sets the Depth Threshold in the Kinect Tool to the value 1000. |
KinectSetInflate(0-15) Example: Changes the inflate option in the Kinect Tool to the value 8. |
KinectSetMaxDelta(Value) Example: Changes the maximum delta option in the Kinect Tool to 50 (px). |
KinectSetMaxHeight(Value) Example: Sets the maximum height of a point in the Kinect Tool to the value 250 (px). |
KinectSetMaxWidth(Value) Example: Sets the maximum width of a point in the Kinect Tool to the value 250 (px). |
KinectSetMinHeight(Value) Example: Sets the minimum height of a point in the Kinect Tool to the value 50 (px). |
KinectSetMinWidth(Value) Example: Sets the minimum width of a point in the Kinect Tool to the value 50 (px). |
KinectSetNearThreshold(0-2047) Example: Sets the Near Threshold in the Kinect Tool to the value 900. |
KinectSetPoints(1-8) Example: Changes the current amount of points in the Kinect Tool to 4 points. |
KinectShowDialog Example: This shows the Kinect Settings dialog. |
LogitechPresenterR400Disabled Example: Disables the Logitech Presenter R400. |
LogitechPresenterR400Enabled Example: Enables the Logitech Presenter R400. |
MagicQActivatePlayback(ID) Example: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: Disables the MA Net Input in the Connection Manager. |
MANetInputEnabled Example: Enables the MA Net Input in the Connection Manager. |
MANetSessionID(ID) Example: Sets the MA Net Session ID in the Connection Manager to 2. |
MidiInputDisabled Example: Disables the Midi Input in the Connection Manager. |
MidiInputEnabled Example: Enables Midi Input in the Connection Manager. Please choose a Midi Device first. |
MidiNotesMuteDisable Example: Disables incoming Midi Notes in the Midi Notes Editor Tool. |
MidiNotesMuteEnable Example: Activates incoming Midi Notes in the Midi Notes Editor Tool. |
MidiOutputDisabled Example: Disables the Midi Output in the Connection Manager. |
MidiOutputEnabled Example: Enables Midi Output in the Connection Manager. Please choose a Midi Device first. |
MidiSendControlChange(Channel 1-16,Control 0-127,Value 0-127) Example: Sets the Control 35 on Midi Channel 1 to the value 127. The Midi connection needs to be enabled in the Connection Manager. |
MidiSendControlChangeByID(ConnectionID,Channel 1-16,Control 0-127,Value 0-127) Example: 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: Sends the Midi Note Off command to Note E5 on channel 1. The Midi connection needs to be enabled in the Connection Manager. |
MidiSendNoteOffByID(ConnectionID,Channel 1-16,Note C0-G10) Example: 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: 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. |
MidiSendNoteOnByID(ConnectionID,Channel 1-16,Note C0-G10,Velocity 0-127) Example: 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: Changes the current program for Midi channel 1 to the program 20. The Midi connection needs to be enabled in the Connection Manager. |
MidiSendProgramChangeByID(ConnectionID,Channel 1-16,Program 0-127) Example: 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: 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(Status,Channel,Data1,Data2,Data3) Example: 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: 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. 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. |
MIDISendSysExByID(ID,[Data]) Example: 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. 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: Executes a Mouse Left Click. |
MouseLeftDown Example: Simulates the depression of the left mouse button. |
MouseLeftUp Example: Simulates the release of the left mouse button |
MouseMove(xPos,yPos) Example: 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: Executes a Mouse Right Click. |
MouseRightDown Example: Simulates the depression of the right mouse button. |
MouseRightUp Example: Simulates the release of the right mouse button |
OpenAirScanProperties Example: Opens the dialog for the AirScan tool. |
OpenArtNetMonitor Example: Opens the Art-NetMonitor which can also be accessed through the Connection Manager. |
OpenArtNetUniverseList Example: Opens the Art-Net Universe List which can also be accessed through the Connection Manager. |
OpenCameraTrackerDialog Example: Opens the Camera Tracker dialog. |
OpenCITPBrowser Example: Opens the Thumbnail Browser which can also be accessed through the dialog PB Network Configuration. |
OpenComConnections Example: Opens the COM Connection dialog which gives an better overview than the Connection Manager. |
OpenConnectionManager Example: Opens the Connection Manager. |
OpenEmailSettings Example: Opens the Email Settings Tool. |
OpenHelp Example: Opens this Help File. |
OpenIPConfiguration Example: Opens the PB Network Configuration dialog. |
OpenKeyboardShortcuts Example: Opens the Keyboard Shortcut Editor. |
OpenKinectDialog Example: Opens the Kinect Tool. |
OpenLoadFileDialog Example: Opens the "Load File" dialog in WD to load an existing project. |
OpenMacroEditor(MacroName) Example: Opens the Macro Editor dialog in WD and loads the macro "MyMacro". |
OpenMidiNoteEditor Example: Opens the Midi Note Editor. |
OpenPageBrowser Example: Opens the Page Browser. |
OpenRemoteInput Example: Opens the Remote Input Tool. |
OpenSaveAsFileDialog Example: Opens the "Save as" dialog in WD to save the current project to a different name and directory. |
OpenSMSSettings Example: Opens the SMS Settings Tool. |
OpenTcpConnections Example: Opens the TCP Connection dialog which gives an better overview than the Connection Manager. |
OpenUdpConnections Example: Opens the UDP Connection dialog which gives an better overview than the Connection Manager. |
OpenVariableList Example: Opens the dialog Variable List. |
PBApplicationClose(IP address,Processname,NicAdapterName(optional)) Example: 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". The command is sent out via NIC adapter "Lan1" of the local PC.
Please note: |
PBApplicationCloseAll(Processname,NicAdapterName(optional)) Example: 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". The command is sent out via NIC adapter "Lan1" of the local PC.
Please note: |
PBApplicationStart(IP address,Filepath,NicAdapterName(optional)) Example: 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: Opens the Internet Explorer on the PB computer with the IP address 10.169.10.60 in the local network. Please note: |
PBApplicationStartAll(Filepath,NicAdapterName(optional)) Example: 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: Opens the Internet Explorer on all PB computers in the local network. Please note: |
PBApplicationStartAllEx(Filepath,Application arguments,NicAdapterName(optional)) Example: 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 the application you want to start is not a standard Windows application, please use the whole file path. Please note: |
PBApplicationStartEx(IP address,Filepath,Application arguments,NicAdapterName(optional)) Example: 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 the application you want to start is not a standard Windows application, please use the whole file path. Please note: |
PBCanvasUpdatesDisableForSite(FolderID,FileID,SiteID) Example: 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: 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: 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: 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: |
PBCloseAll(NicAdapterName(optional)) Example: 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: Use this, if you do not need to specify the NIC adapter explicitly. Please note: |
PBCloseProject(SaveCurrent) Example: Closes the current project in PB after saving it. Example 2: Closes the current project in PB without saving it. |
PBCueMap(ButtonID,SeqID,CueID) Example: Links Button 2 of the PB Jog/Shuttle Board to Cue 10 of sequence 1 in Pandoras Box Master System. |
PBDeactivateOutput2(IP address) Example: Deactivates output 2 of the PB computer with the IP address 10.169.10.65. Please note: |
PBDeactivateOutput2All Example: Deactivates output 2 of all PB computers in the local network. Please note: |
PBFaderMap(FaderID,SeqID) Example: Links Fader 3 of the PB Fader Board to the sequence 1 in Pandoras Box Master System. |
PBLoadProject(Path,Name,SaveCurrent) Example: Saves the current PB project and opens the project "Rotation.pbb" from the specified directory. Example 2: Opens the PB project "Rotation.pbb" from the specified directory without saving the current project. |
PbPlaylistJumpToNextItemByID(SiteID,DeviceID,FolderID,FileID) Example: 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: 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) 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) 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: 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: 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: |
PBRebootAll(NicAdapterName(optional)) Example: Reboots all PB computers in the local network. The example names the optional NIC adapter for sending the command with "Lan1". Example2: Use this, if you do not need to specify the NIC adapter explicitly. Please note: |
PBSaveProject Example: Saves the current project of the PB Master device that is connected to the Widget Designer. |
PBSetIP1(IP address,NewIP,NewMask,NicAdapterName(optional)) Example: 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. Please note: |
PBSetIP1DHCP(IP address) Example: Sets the first network adapter of the PB computer with the IP address 2.0.0.111 to DHCP. Please note: |
PBSetIP2(IP address,NewIP,NewMaskNicAdapterName(optional)) Example: 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 Please note: |
PBSetIP2DHCP(IP address) Example: Sets the second network adapter of the PB computer with the IP address 2.0.0.111 to DHCP. Please note: |
PBSetOutput1Resolution(IP address,1024 768 60) Example: 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: |
PBSetOutput1ResolutionAll(1024 768 60) Example: Sets the resolution of output 1 of all PB computers in the local network to 1024x786 px @ 60 Hz. Please note: |
PBSetOutput2Resolution(IP address,1024 768 60) Example: 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: |
PBSetOutput2ResolutionAll(1024 768 60) Example: Sets the resolution of output 2 of all PB computers in the local network to 1024x786 px @ 60 Hz. Please note: |
PBShutDown(IP address,NicAdapterName(optional)) Example: Turns off the PB computer with the IP address 10.169.10.65 in the local network. Please note: |
PBShutDownAll(NicAdapterName(optional)) Example: Shuts down all PB computers in the local network. Example2: Use this, if you do not need to specify the NIC adapter explicitly. Please note: |
PBStandby(IP address,NicAdapterName(optional)) Example: Sets the PB computer with the IP address 10.169.10.65 in standby mode. Please note: |
PBStandbyAll(NicAdapterName(optional)) Example: Sets all PB computer with the same IP range in standby mode Example2: Use this, if you do not need to specify the NIC adapter explicitly. Please note: |
PBStartClient(IP address,NicAdapterName(optional)) Example: 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: |
PBStartClientAll(NicAdapterName(optional)) Example: 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: Use this, if you do not need to specify the NIC adapter explicitly. Please note: |
PBStartMaster(IP address,NicAdapterName(optional)) Example: 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: |
PBStartMasterAll(NicAdapterName(optional)) Example: 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: Use this, if you do not need to specify the NIC adapter explicitly. Please note: |
PlayClientSound(Filename) Example: 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: 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: 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: Loops the wave file "instrument.wav" from the specified directory. Please note, that WD does not play another format than WAV files. |
ReconnectFaderboardDevices Example: 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: 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: 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: 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 |
RemoveVideoLayer(SiteID,DeviceID) Example: 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: Resets all parameters of all layers of all Servers within the Pandoras Box Project. |
ResetDevice(SiteID,DeviceID) Example: Resets all parameters of layer 3 of site 1 within the Pandoras Box Project. |
ResetParam(SiteID,DeviceID,ParamName) Example: Resets the parameter X Scale of layer 3 of site 1 within the Pandoras Box Project. |
ResetSerialLinkDeviceConnection(SiteID,DeviceID) Example: 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. |
ResetSerialLinkDeviceConnectionBackup(SiteID,DeviceID) Example: 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. |
ResetSerialLinkDeviceConnectionMaster(SiteID,DeviceID) Example: 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. |
ResetSite(SiteID) Example: Resets all parameters of all layers of site 1 within the Pandoras Box Project. |
ResetTcpDeviceConnection(SiteID,DeviceID) Example: 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. |
ResetTcpDeviceConnectionBackup(SiteID,DeviceID) Example: 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. |
ResetTcpDeviceConnectionMaster(SiteID,DeviceID) Example: 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. |
ResourceAdd(FilePath,SiteID,FolderID,FileID) Example: This adds a file from a remote or local node (i.e. Client or Master) to the main folder of your Pandoras Box project. |
ResourceAddFileFromLocal(FilePath) Example: This adds a file from your local node (i.e. the Master) to the main folder of your Pandoras Box project. |
ResourceAddFileFromLocalToProjectPath(FilePath,ProjectPath) Example: This adds a file from your local node (i.e. the Master) to a subfolder of your Pandoras Box project. |
ResourceAddFolder(FolderName) Example: This adds a subfolder to your Pandoras Box project. |
ResourceAddFolderFromLocal(FilePath) Example: This adds a folder from your local node (i.e. the Master) to the main folder of your Pandoras Box project. |
ResourceAddFolderFromLocalByID(FolderPath,FolderID,FileID) Example: 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. |
ResourceAddFolderFromLocalToProjectPath(FilePath,ProjectPath) Example: This adds a folder from your local node (i.e. the Master) to a subfolder of your Pandoras Box project. |
ResourceAddFolderFromLocalToProjectPathByID(FolderPath,ProjectPath,FolderID,FileID) Example: 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. |
ResourceAddFolderToPath(FolderName,ProjectPath) Example: This adds a subfolder to an existing subfolder in your Pandoras Box project. |
ResourceAddImageSeq(FolderPath,FPS,SiteID,FolderID,FileID) Example: 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. |
ResourceAddImageSeqFromLocal(FolderPath,FPS) Example: This adds the image sequence saved under "C:\ImgSeq\Intro" on the hard disc of the local Site to the main folder in the Pandoras Box Project tab. The frame rate of the image sequence is set to 25 frames/second. |
ResourceAddImageSeqFromLocalByID(FolderPath,FPS,FolderID,FileID) Example: This adds the image sequence saved under "C:\ImgSeq\Intro" on the hard disc of the local Site 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]. |
ResourceAddImageSeqFromLocalToProjectPath(FolderPath,FPS,ProjectPath) Example: This adds the image sequence saved under "C:\ImgSeq\Intro" on the hard disc of the local Site to the folder "Image Sequences" in the Pandoras Box Project tab. The frame rate of the image sequence is set to 25 frames/second. |
ResourceAddImageSeqFromLocalToProjectPathByID(FolderPath,FPS,ProjectPath,FolderID,FileID) Example: This adds the image sequence saved under "C:\ImgSeq\Intro" on the hard disc of the local Site to the folder "Image Sequences" 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]. |
ResourceAddImageSeqToProjectPath(FolderPath,FPS,SiteID,ProjectPath,FolderID,FileID) Example: This adds the image sequence saved under "C:\ImgSeq\Intro" on the hard disc of Site 1 to the sub folder "Image Sequences" 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. |
ResourceAddToProjectPath(FilePath,SiteID,FolderID,FileID,ProjectPath) Example: This adds a file from a remote or local node (i.e. Client or Master) to a subfolder of your Pandoras Box project. |
ResourceAttachByID(FolderID,FileID,SiteID,FilePath) Example: This attaches a file link in your Pandoras Box project so that the specified node loads another file than the one the Master system calls, e.g. as an active value or from the timeline. The node can be a remote or local node (i.e. Client or Master). See the topic "Attaching Files". |
ResourceAttachByPath(ProjectPath,SiteID,FilePath) Example: This attaches a file link in your Pandoras Box project so that the specified node loads another file than the one the Master system calls, e.g. as an active value or from the timeline. The node can be a remote or local node (i.e. Client or Master). See the topic "Attaching Files". |
ResourceBrowserClearCacheByID(FolderID,FileID) Example: This clears the browser cache from the Browser Asset with the Folder and File ID [2,3] in the Pandoras Box Project tab. Clear the web cache to renew stored document information including images. Alternatively, click "Clear Cache" in the Browser Inspector. |
ResourceBrowserClearCacheByName(BrowserNamePath) Example: This clears the browser cache from the Browser Asset "file:///C:\website\index.html" in the main folder in the Pandoras Box Project tab. Clear the web cache to renew stored document information including images. Alternatively, click "Clear Cache" in the Browser Inspector. |
ResourceBrowserSetURLbyID(FolderID,FileID,URL) Example: In PB, the Browser Asset with Folder and File ID 2,4 changes its URL to "www.coolux.de". |
ResourceBrowserSetURLbyName(BrowserNamePath,URL) Example: In PB, the Browser Asset that is displayed with the name "coolux.de" in the Project tab, changes its URL to "https://www.christiepandorasbox.com/". |
ResourceCanvasClearByID(FolderID,FileID) Example: This clears the Canvas Asset in your Pandoras Box project so that it is empty. |
ResourceCreatePBPlaylistByID(FolderID,FileID) Example: This creates a new empty Pandoras Box playlist and assigns the folder and file ID [1,2]. |
ResourceCreatePBPlaylistByPath(ProjectPath) Example: This creates a new empty Pandoras Box playlist and adds it to the subfolder "First" in the subfolder "Playlist Test" within the project folder. |
ResourceCreatePBPlaylistByPathWithID(ProjectPath,FolderID,FileID) Example: This creates an new empty Pandoras Box playlist. It is added to the subfolder "Second" in the subfolder "Playlist Test" within the project folder and then assigned with the folder and file ID [4,8]. |
ResourceCreatePBPlaylistFromFolderByPath(PlaylistPath,SourceFolderPath) Example: This creates a new Pandoras Box playlist and adds it to the subfolder "First" in the subfolder "Playlist Test" within the project folder. The content from "Content\Medialoops" will be added to the playlist. |
ResourceCreatePBPlaylistFromFolderByPathWithID(PlaylistPath,SourceFolderPath,FolderID,FileID) Example: This creates a new Pandoras Box playlist and adds it to the subfolder "First" in the subfolder "Playlist Test" within the project folder. The content from "Content\Medialoops" will be added to the playlist and the folder and file ID [3,5] is assigned. |
ResourceCreateText(FolderID,FileID,Text) Example: Creates a new text asset with the folder and file ID [2,10] in PB with the text "design2". |
ResourceDetachByID(FolderID,FileID,SiteID) Example: This detaches a file link in your Pandoras Box project so that the specified node does not load this file anymore when the Master system calls it, e.g. as an active value or from the timeline. It is now possible to attach another file that should be loaded instead. The node can be a remote or local node (i.e. Client or Master). See the topic "Attaching Files". |
ResourceDetachByPath(ProjectPath,SiteID) Example: This detaches a file link in your Pandoras Box project so that the specified node does not load this file anymore when the Master system calls it, e.g. as an active value or from the timeline. It is now possible to attach another file that should be loaded instead. The node can be a remote or local node (i.e. Client or Master). See the topic "Attaching Files". |
ResourceEncodeFile(FileName,Preset) Example: This sends the file "loop.wmv" from the folder "Videos" in the Pandoras Box Project tab to the internal Encoder Extension and encodes it with the Preset named "Auto". The encoded file is saved in the original path. Obviously, the Encoder Extension needs to be available in the PB Master. |
ResourceEncodeFileByID(FolderID,FileID,Preset) Example: This sends the file with the File and Folder ID [1,2] in the Pandoras Box Project tab to the internal Encoder Extension and encodes it with the Preset named "Auto". The encoded file is saved in the original path. Obviously, the Encoder Extension needs to be available in the PB Master. |
ResourceEncodeFileByIDToPath(FolderID,FileID,TargetPath,Preset) Example: This sends the file with the File and Folder ID [1,2] in the Pandoras Box Project tab to the internal Encoder Extension and encodes it with the Preset named "Auto". The encoded file is saved in a new path under "C:\Encoded". Obviously, the Encoder Extension needs to be available in the PB Master. |
ResourceEncodeFileToPath(FileName,TargetPath,Preset) Example: This sends the file "loop.wmv" from the folder "Videos" in the Pandoras Box Project tab to the internal Encoder Extension and encodes it with the Preset named "Auto". The encoded file is saved in a new path under "C:\Encoded". Obviously, the Encoder Extension needs to be available in the PB Master. |
ResourceExportCanvasByID(FolderID,FileID,FileName) Example: This exports the Canvas resource with the Folder and File ID [1,2] as a PNG image including the alpha channel with the name "Canvas_1" to the existing path "C:\Christie\content". |
ResourceExportCanvasByName(ProjectPath,FileName) Example: This exports the Canvas resource "Tree.ccm" from the folder Canvas as PNG image including Alpha channel with the name "Tree_1" to the existing path "C:\Christie\content". |
ResourceExportSeq(SeqID,FileName,Preset,StartHH,MM,SS,FF,StopHH,MM,SS,FF) Example: This records what you have programmed on a sequence using the Video Export feature in the Pandoras Box project. The feature is limited to some Pandoras Box products. |
ResourceExportSeqF(SeqID,FileName,Preset,StartHH:MM:SS:FF,StopHH:MM:SS:FF) Example: This records what you have programmed on a sequence using the Video Export feature in the Pandoras Box project. The feature is limited to some Pandoras Box products. |
ResourceGetTextFromLabel(LabelID,FolderID,FileID) Example: Sets the text of the text asset with the Folder and File ID [2.9] in PB to the text of label 3 in WD. |
ResourceGetTextFromLabelUnicode(LabelID,FolderID,FileID) Example: Sets the text of the text asset with the Folder and File ID [2.9] in PB to the text of label 3 in WD. |
ResourceGetTextFromTextbox(TextboxID,FolderID,FileID) Example: Sets the text of the text asset with the Folder and File ID [2.10] in PB to the text of textbox 4 in WD. |
ResourceGetTextFromTextboxUnicode(TextboxID,FolderID,FileID) Example: Sets the text of the text asset with the Folder and File ID [2.10] in PB to the text of textbox 4 in WD. |
ResourceMove(Content,ProjectPath) Example: This moves the file "Image.png" that is already part of your Pandoras Box project to the subfolder "images" in the subfolder "background" within the project folder. |
ResourcePBPlaylistAddItemByID(PlaylistFolderID,PlaylistFileID,ItemFolderID,ItemFileID) Example: This adds the media file with the folder and file ID [1,8] to the end of the Pandoras Box playlist with the folder and file ID [4,5]. |
ResourcePBPlaylistAddItemByPath(PlaylistPath,ItemPath) Example: This adds the media file "Calibrate.png" to the end of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder, |
ResourcePBPlaylistInsertItemByID(PlaylistFolderID,PlaylistFileID,ItemFolderID,ItemFileID,Index) Example: This inserts the media file with the folder and file ID [1,8] to the Pandoras Box playlist with the folder and file ID [4,5] as index 3. All following items increase their indices by one, e.g. the former item number 3 becomes item number 4. |
ResourcePBPlaylistInsertItemByPath(PlaylistPath,ItemPath,Index) Example: This inserts the media file "Calibrate.png" to the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder. The new media is assigned with index 3. All following items increase their indices by one, e.g. the item number 3 becomes item number 4. |
ResourcePBPlaylistRemoveAllItemByID(FolderID,FileID) Example: This removes the content from the Pandoras Box playlist with the folder and file ID [1,9]. |
ResourcePBPlaylistRemoveAllItemByPath(PlaylistPath) Example: This removes the content from the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder. |
ResourcePBPlaylistRemoveItemByID(FolderID,FileID,RemoveID) Example: This removes the item with index number 5 from the Pandoras Box playlist with the folder and file ID [1,9]. All following items decrease their indices by one, e.g. item number 6 becomes item number 5. |
ResourcePBPlaylistRemoveItemByPath(PlaylistPath,RemoveID) Example: This removes the item with index number 5 from the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder. All following items decrease their indices by one, e.g. item number 6 becomes item number 5. |
ResourcePBPlaylistSetItemDurationByID(PlaylistFolderID,PlaylistFileID,Index,HH,MM,SS,FF) Example: This sets the duration of the item with index 8 of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). |
ResourcePBPlaylistSetItemDurationByIDF(PlaylistFolderID,PlaylistFileID,Index,HH:MM:SS:FF) Example: This sets the duration of the item with index 8 of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). With this command, the timecode can also be stored and recalled using a string variable. |
ResourcePBPlaylistSetItemDurationByPath(PlaylistPath,Index,HH,MM,SS,FF) Example: This sets the duration of the item with index 8 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder to 00:05:22:12 (hh:mm:ss:ff). |
ResourcePBPlaylistSetItemDurationByPathF(PlaylistPath,Index,HH:MM:SS:FF) Example: This sets the duration of the item with index 8 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder to 00:05:22:12 (hh:mm:ss:ff). With this command, the timecode can also be stored and recalled using a string variable. |
ResourcePBPlaylistSetItemFadeOutByID(PlaylistFolderID,PlaylistFileID,Index,HH,MM,SS,FF) Example: This sets the fade out time of the item with index 8 of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). |
ResourcePBPlaylistSetItemFadeOutByIDF(PlaylistFolderID,PlaylistFileID,Index,HH:MM:SS:FF) Example: This sets the fade out time of the item with index 8 of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). With this command, the timecode can also be stored and recalled using a string variable. |
ResourcePBPlaylistSetItemFadeOutByPath(PlaylistPath,Index,HH,MM,SS,FF) Example: This sets the fade out time of the item with index 8 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder to 00:05:22:12 (hh:mm:ss:ff). |
ResourcePBPlaylistSetItemFadeOutByPathF(PlaylistPath,Index,HH:MM:SS:FF) Example: This sets the fade out time of the item with index 8 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder to 00:05:22:12 (hh:mm:ss:ff). With this command, the timecode can also be stored and recalled using a string variable. |
ResourcePBPlaylistSetItemIndexByID(PlaylistFolderID,PlaylistFileID,OldIndex,NewIndex) Example: This sets the item with index 7 to index 4 of the Pandoras Box playlist with the folder and file ID [2,1]. All original items 4-6 increase their indices by one, e.g. the item of index 4 moves forward to index 5. |
ResourcePBPlaylistSetItemIndexByPath(PlaylistPath,OldIndex,NewIndex) Example: This sets the item with index 7 to index 4 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder. All original items 4-6 increase their indices by one, e.g. the item of index 4 moves forward to index 5. |
ResourcePBPlaylistSetItemInPointByID(PlaylistFolderID,PlaylistFileID,Index,HH,MM,SS,FF) Example: This sets the inpoint time of the item with index 8 of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). |
ResourcePBPlaylistSetItemInPointByIDF(PlaylistFolderID,PlaylistFileID,Index,HH:MM:SS:FF) Example: This sets the inpoint time of the item with index 8 of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). With this command, the timecode can also be stored and recalled using a string variable. |
ResourcePBPlaylistSetItemInPointByPath(PlaylistPath,Index,HH,MM,SS,FF) Example: This sets the inpoint time of the item with index 8 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder to 00:05:22:12 (hh:mm:ss:ff). |
ResourcePBPlaylistSetItemInPointByPathF(PlaylistPath,Index,HH:MM:SS:FF) Example: This sets the inpoint time of the item with index 8 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder to 00:05:22:12 (hh:mm:ss:ff). With this command, the timecode can also be stored and recalled using a string variable. |
ResourcePBPlaylistSetItemOutPointByID(PlaylistFolderID,PlaylistFileID,Index,HH,MM,SS,FF) Example: This sets the outpoint time of the item with index 8 of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). |
ResourcePBPlaylistSetItemOutPointByIDF(PlaylistFolderID,PlaylistFileID,Index,HH:MM:SS:FF) Example: This sets the outpoint time of the item with index 8 of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). With this command, the timecode can also be stored and recalled using a string variable. |
ResourcePBPlaylistSetItemOutPointByPath(PlaylistPath,Index,HH,MM,SS,FF) Example: This sets the outpoint time of the item with index 8 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder to 00:05:22:12 (hh:mm:ss:ff). |
ResourcePBPlaylistSetItemOutPointByPathF(PlaylistPath,Index,HH:MM:SS:FF) Example: This sets the outpoint time of the item with index 8 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder to 00:05:22:12 (hh:mm:ss:ff). With this command, the timecode can also be stored and recalled using a string variable. |
ResourcePBPlaylistSetItemTransitionFXByID(PlaylistFolderID,PlaylistFileID,Index,FXID) Example: This sets the Transition FX of the item with index 8 of the Pandoras Box playlist with the folder and file ID [2,1] to "TransitionFX 001". If you like to change it back to the default "Crossfade", use 0. |
ResourcePBPlaylistSetItemTransitionFXByPath(PlaylistPath,Index,FXID) Example: This sets the Transition FX of the item with index 8 of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder to "TransitionFX 001". If you like to change it back to the default "Crossfade", use 0. |
ResourceRecordLiveInput(InputName,FileName,Preset,HH,MM,SS,FF) Example: This records a Live Input using the Video Recording feature in the Pandoras Box project. The feature is limited to some Pandoras Box products. |
ResourceRecordLiveInputByID(FolderID,FileID,FileName,Preset,HH,MM,SS,FF) Example: This records a Live Input using the Video Recording feature in the Pandoras Box project. The feature is limited to some Pandoras Box products. |
ResourceRecordLiveInputByIDF(FolderID,FileID,FileName,Preset,HH:MM:SS:FF) Example: This records a Live Input using the Video Recording feature in the Pandoras Box project. The feature is limited to some Pandoras Box products. |
ResourceRecordLiveInputByIDStart(FolderID,FileID,FileName,Preset) Example: This starts to record a Live Input using the Video Recording feature in the Pandoras Box project. The feature is limited to some Pandoras Box products. |
ResourceRecordLiveInputF(InputName,FileName,Preset,HH:MM:SS:FF) Example: This records a Live Input using the Video Recording feature in the Pandoras Box project. The feature is limited to some Pandoras Box products. |
ResourceRecordLiveInputStart(InputName,FileName,Preset) Example: This starts to record a Live Input using the Video Recording feature in the Pandoras Box project. The feature is limited to some Pandoras Box products. |
ResourceRecordLiveInputStop Example: This stops to record a Live Input using the Video Recording feature in the Pandoras Box project. |
ResourceReloadMedia(FolderID,FileID) Example: Reloads the media file with the Folder and File ID [2,5] in the Pandoras Box project. In PB, this option can be found in the File Inspector. |
ResourceReloadMesh(FolderID,FileID) Example: Reloads the mesh file with the Folder and File ID [3,9] in the Pandoras Box project. In PB, this option can be found in the File Inspector. |
ResourceRemove(Name) Example: This removes the file "Image.png" from your Pandoras Box project. It does not matter whether the file is in the main folder or a subfolder but if there is more than one file in the project that holds this name, the first file is deleted. |
ResourceRemoveAll(RemoveFolderStructure) Example: This removes all files from your Pandoras Box project including the folder structure. When "False" is chosen, all files from the folders are deleted but the folders stay. |
ResourceRemoveFolder(ProjectPath\) Example: This removes the sub folder "Background" from the folder "Videos" in the Pandoras Box Project tab. |
ResourceRemoveInconsistent Example: Removes all inconsistent files from the Pandoras Box Master system. In PB, this option can be found in the Folder Inspector. |
ResourceRemoveMedia(FolderID,FileID) Example: Removes the media file with the Folder and File ID [2,5] from the PB project. |
ResourceRemoveMesh(FolderID,FileID) Example: Removes the mesh file with the Folder and File ID [3,9] from the Pandoras Box Project Tab. |
ResourceResize(FilePath,Width,Height) Example: This command does not necessarily apply to a Pandoras Box project. It simply resizes an image (here: the file named "image2.png" saved under the path "C:\Christie\content") on the hard drive and saves it under the same name but with the different size. The image from the example would have a new height and width of 256 pixels. If the image is part of a Pandoras Box project it then needs to be reloaded to read-out the new size. The reload happens automatically with the default options and a Revision 9088 or higher. When using an older revision, please reload the file manually, e.g. by using the File Inspector or reloading the project. |
ResourceSetAlphaChannel(FolderID,FileID,State)(True or False) Example: Disables the alpha channel of the media file with the Folder and File ID [2,5] in the File Inspector in Pandoras Box. Use "True" if movie type supports embedded alpha. |
ResourceSetAnisotropicFiltering(FolderID,FileID,State)(True or False) Example: Deactivates anisotropic filtering (pixel smoothing for real-time video and image scaling) for the media file with the Folder and File ID [2,5] in the File Inspector in Pandoras Box. |
ResourceSetDeinterlacing(FolderID,FileID,State)(0,1,2,3) Example: Activates the deinterlacing mode "fieldblending" for the media file with the Folder and File ID [2,5] in the File Inspector in Pandoras Box. Deinterlacing Modes: |
ResourceSetFrameBlending(FolderID,FileID,State)(True or False) Example: Activates frameblending for the media file with the Folder and File ID [2,5] in the File Inspector in Pandoras Box. Choose this option for slow motion or smooth motion frame-adaptive frameblending and framerate conversion. |
ResourceSetID(ProjectPath,FolderID,FileID) Example: This applies to the subfolder "images" in the subfolder "background" within the Pandoras Box project folder. All files included in the subfolder are assigned consecutively with a Folder and File ID starting from 5,1. |
ResourceSetMpegColorSpace(FolderID,FileID,State)(True or False) Example: Enables the optimization of MPEG Colorspace for the media file with the Folder and File ID [2,5] in the File Inspector in Pandoras Box. |
ResourceSetText(FolderID,FileID,Text) Example: Sets the text of text asset [2,9] in PB to "design". |
ResourceSetTextCentered(FolderID,FileID ) Example: Centers the text of text asset [1,2] in PB on its texture. |
ResourceSetTextFullSize(FolderID,FileID ) Example: Removes the center-option of the text asset [1,2] in PB. |
ResourceSetTextSize(FolderID,FileID,Width,Height ) Example: Sets the texture size of text asset [1,2] in PB to 800x600 px. |
ResourceSetTextStyle(FolderID,FileID,Font,Size,Style,Alignment,Red,Green,Blue ) Example: Sets the Text Asset [1,2] to the following properties: This command is available from PB Rev. 4982 or higher. Style options: Regular, Bold, Italic, BoldItalic, Underline. |
ResourceSetTextUnicode(FolderID,FileID,Text) Example: Sets the text of text asset [1,2] in PB to "?a?? µ??a". |
ResourceSetUnderscan(FolderID,FileID,State)(True or False) Example: Enables Underscan for the media file with the Folder and File ID [2,5] in the File Inspector in Pandoras Box. |
ResourceSpreadAll Example: Spreads all resources in PB. |
ResourceSpreadMedia(FolderID,FileID) Example: Spreads the media file with the Folder and File ID [2,10] in PB. |
ResourceSpreadMesh(FolderID,FileID) Example: Spreads the mesh file with the Folder and File ID [3,7] in PB. |
ResourceSpreadToSite(ProjectPath,SiteID) Example: Spreads all resources which are located under the PB project path "Images\HD" to the Site with ID 2. |
ResourceSpreadToSiteById(FolderID,FileID,SiteID) Example: Spreads the resource with the Folder and File ID [2,1] to the Site 4. |
ScriptCancel(Filter(optional)) Example: The first example shows, how to cancel (i.e. stop) all scripts that are currently running and which were started from a page in WD called "Page1". Likewise can you cancel all scripts from a WD window, e.g. "Window1". In general, the command can be used in many ways as you see in the other examples. The "Running Scripts" dialog (from the Scripting menu) might be helpful as it shows which scripts are currently running and how their so called context is, meaning what started them, e.g. a Custom Script Button on a certain page, a Macro or Function, a Script Output node, etc. The second example cancels a specific script, in this case the Macro with the name "FaderM", no matter how many times it was started. However, if you are using this example inside the Macro itself (in this case "FaderM") it would cancel the instance that was started before but not the current one. Keep in mind: a script cannot cancel itself with this command, just other ones. Following the second example, here, Label1 displays how many scripts where canceled. You could also use the Debug Logger instead: DebugMessage(ScriptCancel("FaderM")). If no filter is specified, the current context is applied automatically. So if this command is executed from a Macro, the context is the Macro name but if it is executed from a Custom Script Button, it would refer to the button's script name. If you write "ScriptCancel()" at the beginning of a script and execute this script twice, the second call would cancel the first one because it is a previous instance of itself and then start the script again. As already explained, with this command a script cancels other instances but not itself. |
ScriptCancelAll Example: Cancels all running scripts, no matter from which Macros, Function, Custom Script Button or other script field. |
ScriptError(ErrorMessage) Example: Displays your own error messages like "The value you've entered is not valid, please enter a Double or Integer value between 10 and 80." in the Debug Logger. This helps to find errors in your programmed scripts. This feature is currently not available for the WD Free Version. |
SeqAddJumpCue(SeqID,CueID,HH,MM,SS,FF,Name) Example: A Jump Cue with the ID 5 will be added to Sequence 1 at the timecode 00:02:22:12. It will be named "Scene2". |
SeqAddJumpCueF(SeqID,CueID,HH:MM:SS:FF,Name) Example: A Jump Cue with the ID 6 will be added to Sequence 1 at the timecode 00:01:20:15. It will be named "Scene2". |
SeqAddPauseCue(SeqID,CueID,HH,MM,SS,FF,Name) Example: A Pause Cue with the ID 2 will be added in Sequence 1 at the timecode 00:01:22:15. It will be named "Scene4. |
SeqAddPauseCueF(SeqID,CueID,HH:MM:SS:FF,Name) Example: A Pause Cue with the ID 2 will be added in Sequence 1 at the timecode 00:01:22:15. It will be named "Scene4. |
SeqAddPlayCue(SeqID,CueID,HH,MM,SS,FF,Name) Example: A Play Cue with the ID 5 will be added in Sequence 1 at the timecode 00:01:22:15. It will be named "Scene3". |
SeqAddPlayCueF(SeqID,CueID,HH:MM:SS:FF,Name) Example: A Play Cue with the ID 5 will be added in Sequence 1 at the timecode 00:01:22:15. It will be named "Scene3". |
SeqAddWaitCue(SeqID,CueID,HH,MM,SS,FF,Name) Example: A Wait Cue with the ID 7 will be added to Sequence 2 at the timecode 00:01:30:10. It will be named "Pause1". |
SeqAddWaitCueF(SeqID,CueID,HH:MM:SS:FF,Name) Example: A Wait Cue with the ID 4 will be added to Sequence 1 at the timecode 00:05:11:13. It will be named "Pause2". |
SeqContentAtTime(SiteID,DevID,SeqID,HH,MM,SS,FF,FolderID,FileID) Example: If a clip container exists at timecode 00:05:22:12 in Sequence 1, the content inside this clip container will get exchanged by the content with the Folder and File ID 1,1 and it also will be re-synced. |
SeqContentAtTimeF(SiteID,DevID,SeqID,HH:MM:SS:FF,FolderID,FileID) Example: If a clip container exists at timecode 00:05:22:12 in Sequence 1, the content inside this clip container will get exchanged by the content with the Folder and File ID 1,1 and it also will be re-synced. |
SeqContentReplaceAtTime(Site,Device,SeqID,HH,MM,SS,FF,FolderID,FileID) Example: This applies to layer 3 of Site 1 (e.g. a Server) in your Pandoras Box project. The container in Sequence 2 at timecode 00:05:22:12 (hh,mm,ss,ff) is filled with the media file that holds the Folder and File ID 4,6. Please note, that this command requires an existing container whereto it can drop the media file. |
SeqContentReplaceAtTimeByPath(Site,Device,SeqID,HH,MM,SS,FF,ProjectPath) Example: This applies to layer 3 of Site 1 (e.g. a Server) in your Pandoras Box project. The container in Sequence 2 at timecode 00:05:22:12 (hh,mm,ss,ff) is filled with the media file "Calibrate.png" from the subfolder "Testpattern" within the project folder. 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 "ProjectPath" is case-sensitive and that this command requires an existing container whereto it can drop the media file. |
SeqContentReplaceAtTimeByPathF(Site,Device,SeqID,HH:MM:SS:FF,ProjectPath) Example: This applies to layer 3 of Site 1 (e.g. a Server) in your Pandoras Box project. The container in Sequence 2 at timecode 00:05:22:12 (hh:mm:ss:ff) is filled with the media file "Calibrate.png" from the subfolder "Testpattern" within the project folder. 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 "ProjectPath" is case-sensitive and that this command requires an existing container whereto it can drop the media file. |
SeqContentReplaceAtTimeF(Site,Device,SeqID,HH:MM:SS:FF,FolderID,FileID) Example: This applies to layer 3 of Site 1 (e.g. a Server) in your Pandoras Box project. The container in Sequence 2 at timecode 00:05:22:12 (hh:mm:ss:ff) is filled with the media file that holds the Folder and File ID 4,6. Please note, that this command requires an existing container whereto it can drop the media file. |
SeqDeleteAllCues(SeqID) Example: All Cues in Sequence 1 will be deleted. |
SeqDeleteCue(SeqID,CueID) Example: Cue 4 in Sequence 1 will be deleted. |
SeqEdit(ID) Example: This command toggles Sequence with ID 2 into the Sequence tab of Pandoras Box so that it is visible and editable. |
SeqGotoCue(SeqID,CueID) Example: Sets the nowpointer of sequence 2 to the third cue. |
SeqLastCue(SeqID) Example: Sets the nowpointer of sequence 1 to the last cue. |
SeqLastFrame(SeqID) Example: Sets the nowpointer of sequence 2 to the last frame. |
SeqNextCue(SeqID) Example: Sets the nowpointer of sequence 1 to the next cue. |
SeqNextFrame(SeqID) Example: Sets the nowpointer of sequence 2 to the next frame ahead. |
SeqResetJumps(SeqID,CueID) Example: This applies to Sequence 2 in Pandoras Box. The "Repeat Count" of the Cue with ID 3 is reset to the value it was programmed with. In PB, this can be done in the Cue Inspector. |
SeqSetCueJumpCount(SeqID,CueID,Count) Example: This applies to Sequence 2 in Pandoras Box. The "Repeat Count" of the Cue with ID 3 is set to 5. In PB, this can be done in the Cue Inspector. |
SeqSetCueJumpTargetTime(SeqID,CueID,HH,MM,SS,FF) Example: This applies to Sequence 2 in Pandoras Box. The "Jump Target" of the Cue with ID 3 is set to 00:05:22:12 (hh:mm:ss:ff). Please note that the Cue must be a Jump Cue. In PB, this can be done in the Cue Inspector. |
SeqSetCueJumpTargetTimeF(SeqID,CueID,HH:MM:SS:FF) Example: This applies to Sequence 2 in Pandoras Box. The "Jump Target" of the Cue with ID 3 is set to 00:05:22:12 (hh:mm:ss:ff). In PB, this can be done in the Cue Inspector. |
SeqSetCueName(SeqID,CueID,Name1) Example: This renames the Cue 3 of Sequence 1 in Pandoras Box to "Scene4". In PB, this can be done in the Cue Inspector. |
SeqSetCuePlayMode(SeqID,CueID,Play/Pause/Stop/Jump/Wait) Example: Sets the play mode of cue 17 in Sequence 1 to "Pause". |
SeqSetCueWaitTime(SeqID,CueID,HH,MM,SS,FF) Example: This applies to Sequence 2 in Pandoras Box. The "Wait Time" of the Cue with ID 3 is set to 00:05:22:12 (hh:mm:ss:ff). In PB, this can be done in the Cue Inspector. |
SeqSetCueWaitTimeF(SeqID,CueID,HH:MM:SS:FF) Example: This applies to Sequence 2 in Pandoras Box. The "Wait Time" of the Cue with ID 3 is set to 00:05:22:12 (hh:mm:ss:ff). The timecode can also be stored and recalled using a string variable. In PB, this can be done in the Cue Inspector. |
SeqSetDoNotIgnoreNextCue(SeqID) Example: The next cue in Sequence 1 will not be ignored . |
SeqSetIgnoreNextCue(SeqID) Example: The next cue in Sequence 1 will be ignored (cue turns orange). |
SeqSetNextCuePlayMode(SeqID,Play/Pause/Stop/Jump/Wait) Example: Sets the play mode of the next cue in Sequence 1 to "Pause". |
SeqSetState(SeqID,"Play"/"Pause"/"Stop") Example: Sets sequence 2 to Play. Example 2: Example 3: |
SeqSetTimecode(SeqID,HH,MM,SS,FF) Example: Sets sequence 2 within the Pandoras Box project to the timecode 00:05:22:12 (hh:mm:ss:ff) |
SeqSetTimecodeF(SeqID,HH:MM:SS:FF) Example: Sets sequence 2 within the Pandoras Box project to the timecode 00:05:22:12 (hh:mm:ss:ff). With this command the timecode can also be stored and recalled using a string variable. |
SeqSetTimecodeMode(SeqID,"None"/"Send"/"Receive") Example: Sets the timecode mode of sequence 2 in Pandoras Box to "None". In PB, this can be done in the Sequence Inspector. Example 2: Example 3: |
SeqSetTimecodeOffset(SeqID,HH,MM,SS,FF) Example: Sets an offset of 00:05:22:12 (hh:mm:ss:ff) to the timecode of sequence 2. |
SeqSetTimecodeOffsetF(SeqID,HH:MM:SS:FF) Example: Sets an offset of 00:05:22:12 (hh:mm:ss:ff) to the timecode of sequence 2. The timecode can also be stored and recalled using a string variable. |
SeqSetTimecodeRelative(SeqID,HH,MM,SS,FF) Example: Adds an time interval of 00:05:22:12 (hh:mm:ss:ff) to the timecode of sequence 2 within the Pandoras Box project. If the timecode was at 00:01:02:03, it is now at 00:06:24:15. Example2: The second example subtracts the same time interval again. The command is the same but in front of each time value there is a minus (-) symbol. |
SeqSetTimecodeRelativeF(SeqID,HH:MM:SS:FF) Example: Adds an time interval of 00:05:22:12 (hh:mm:ss:ff) to the timecode of sequence 2 within the Pandoras Box project. If the timecode was at 00:01:02:03, it is now at 00:06:24:15. Example2: Instead of typing the timecode, you could also use a string variable if it has the correct format of course. Example3: The third example subtracts the same time interval as in the first example. The command is the same but in front of each time value there is a minus (-) symbol. |
SeqSetTimecodeStopAction(SeqID,"Stop"/"Pause"/"Continue") Example: Stops sequence 1 in Pandoras Box if the incoming timecode stops. In PB, this can be done in the Sequence Inspector. Example 2: Example 3: |
SeqStoreActive(SeqID) Example: Stores all active parameters in Pandoras Box to sequence 2. |
SeqStoreActiveDevice(SeqID,SiteID,DeviceID) Example: Stores all active parameters of layer 4 of site 2 in Pandoras Box to sequence 1 to the position of the nowpointer. |
SeqStoreActiveParameter(SeqID,SiteID,DeviceID,Parameter) Example: Stores all active "Opacity" parameters of layer 4 of site 2 in Pandoras Box to sequence 1 to the position of the nowpointer. |
SeqStoreActiveSite(SeqID,SiteID) Example: Stores all active parameters of site 1 in Pandoras Box to sequence 2 to the position of the nowpointer. |
SeqStoreActiveToTime(SeqID,HH,MM,SS,FF) Example: Stores all active parameters in Pandoras Box to sequence 2 at timecode 00:05:22:12 (hh,mm,ss,ff). |
SeqStoreActiveToTimeF(SeqID,HH:MM:SS:FF) Example: Stores all active parameters in Pandoras Box to sequence 2 at timecode 00:05:22:12 (hh,mm,ss,ff). The timecode can also be stored and recalled using a string variable. |
SetAudioMaster(SiteID) Example: Ticks the checkbox "Use Audio Clock As Master" for Site 2 in the Pandoras Box Configuration tab under ASIO Audio. |
SetExcelCellValue(File,Table,Cell,Value) Example: Sets the value of Excel document "excel.xls", table "Sheet1", cell C7 to 42. Note: The document has to be an XLS file and has to be closed during function call. If it is opened, a Windows dialog will open and propose to save a copy of the file. |
SetPBPlaylistAllItemsDurationByID(Folder,File,HH,MM,SS,FF) Example: This sets the duration of all items of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). |
SetPBPlaylistAllItemsDurationByIDF(Folder,File,HH:MM:SS:FF) Example: This sets the duration of all items of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). With this command, the timecode can also be stored and recalled using a string variable. |
SetPBPlaylistItemDurationByID(Folder,File,ItemID,HH,MM,SS,FF) Example: This sets the duration of the item with index 7(!) of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). Note that ItemID 0 refers to the PB index 1! |
SetPBPlaylistItemDurationByIDF(Folder,File,ItemID,HH:MM:SS:FF) Example: This sets the duration of the item with index 7(!) of the Pandoras Box playlist with the folder and file ID [2,1] to 00:05:22:12 (hh:mm:ss:ff). Note that ItemID 0 refers to the PB index 1! |
ShareLayerTexture(SiteID,SourceDevice,TargetDevice) Example: This shares the texture from Layer 1 of Site 3 with Layer 2. Note that Texture Sharing is only available for PB Servers. |
ShareLayerTextureByName(SiteID,SourceDevice,TargetDevice,TargetParam) Example: This shares the texture from Layer 1 of Site 3 with Layer 2, but not as the main media but the first media of the effect named "Quad Media Overlay". Note that Texture Sharing is only available for PB Servers. Please note that "TargetParam" is case-sensitive and 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"). |
ShowEnvironmentVariables Example: Opens a dialog showing the current Windows environment variables, to ease remote debugging for example. More information can be found under: |
SiteAcceptDmxById(SiteID,"On"/"Off") Example: Patches Site 2 in the Patch tab so that it can be controlled via an attached DMX / Art-Net device. Example 2: Unpatches Site 2 in the Patch tab so that it cannot be controlled via an attached DMX / Art-Net device anymore. Please note: 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. |
SMPTELinkModeNone Example: Sets the SMPTE Link Mode in the Connection Manager to "None". |
SMPTELinkModeReceive Example: Sets the SMPTE Link Mode in the Connection Manager to "Receive". |
SMPTELinkReConnect Example: This re-connects your SMPTE Link connection in the Connection Manager. |
SMSClearList Example: Clears the SMS list within the SMS Settings Tool. |
SMSSend(PhoneNumber,Message) Example: Sends an SMS with the message "Test" to the phone number "00492211306540". Setup your GSM modem in the SMS Settings Tool first to be able to receive and send SMS via the Widget Designer. |
SMSSendDisable Example: When this command is executed, no SMS will be send out. Use the script SMSSendEnable to enable this function again. Setup your GSM modem in the SMS Settings Tool first to be able to receive and send SMS via the Widget Designer. |
SMSSendEnable Example: Enables the SMSSend function after it was disabled. Setup your GSM modem in the SMS Settings Tool first to be able to receive and send SMS via the Widget Designer. |
SpareFromSpread(SiteID) Example: This activates the option "Spare from Spread" for Site ID 2 in Pandoras Box. The option can be found in the Device Inspector . |
StopClientSound Example: Stops any currently playing sound on the current client (depending on the script's context). |
StopSound Example: Stops the currently playing sound that was started via the command PlaySound,Filename. |
SystemLock Example: This locks the system. You will see the screen were Windows asks for your password to unlock the system again. |
SystemLogOff Example: Logs off the user of the local WD computer in a way that you do not have to confirm it. |
SystemReboot Example: Reboots the local WD computer in a way that you do not have to confirm it. |
SystemServiceStart(ServiceName) Example: Starts the stopped Service for Network Connections called "Netman". Please have a look into the Windows Task Manager to get the correct name of the stopped services you want to start. Please enter the Service Name exactly like it is listed under Taskmanager/Services/Name. |
SystemServiceStop(ServiceName) Example: Stops the running Service for Network Connections called "Netman". Please have a look into the Windows Task Manager to get the correct name of the running services you want to stop. Please enter the Service Name exactly like it is listed under Taskmanager/Services/Name. |
SystemShutdown Example: Shuts down the local WD computer in a way that you do not have to confirm it. |
SystemVolume(0-100) Example: Sets the System Volume to 50%. |
TCPClearBuffer(ID) Example: Clears the buffer from the TCP Connection with ID 1 from the Connection Manager |
TCPInject(ID,Message) Example: Injects the message "Play" directly into the stream of the TCP Connection with ID 1, without waiting for other messages or packages to be finished. The TCP 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. Example: 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]. |
TCPSend(ID,Message) Example: Sends the ASCII message "Play" via the TCP Connection with the ID 1 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. Use [d13] to enter a carriage return as a decimal value. 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]. |
TCPSendDec(ID,Message) Example: 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". |
TCPSendHex(ID,Message) Example: Sends the message "Hi!" in hexadecimal values via the TCP Connection with the ID 1 in the Connection Manager. For more information see the chapter "Syntax TCP-/UDP-/Serial Messages". |
TCPSendToIP(ID,IP,Message) Example: Sends the message "Play" via the TCP Connection with ID 1 from the Connection Manager to IP address 192.168.1.38. 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. Example: 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]. |
TCPStart(ID) Example: Starts the TCP Connection with the ID 1 in the Connection Manager. |
TCPStartAll Example: Starts all TCP Connections in the Connection Manager. |
TCPStop(ID) Example: Stops the TCP Connection with the ID 1 in the Connection Manager. |
TCPStopAll Example: Stops all TCP Connections in the Connection Manager. |
ToggleFullScreen(SiteID) Example: Switches the site 4 from windowed to fullscreen mode in Pandoras Box project. |
UDPClearBuffer(ID) Example: Clears the buffer from the UDP Connection with ID 1 from the Connection Manager |
UDPInject(ID,Message) Example: Injects the message "Play" directly into the stream of the UDP 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. Example: 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]. |
UDPSend(ID,Message) Example: Sends the message "Play" via the UDP Connection with the ID 1 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. Use [d13] to enter a carriage return as a decimal value. 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]. |
UDPSendDec(ID,Message) Example: 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". |
UDPSendHex(ID,Message) Example: Sends the message "Hi!" in hexadecimal values via the UDP Connection with the ID 1 in the Connection Manager. For more information see the chapter "Syntax TCP-/UDP-/Serial Messages". |
UDPSendToPort(Port,Message) Example: Sends the message "Play" to the port 10000 via an UDP Connection . 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. Example: 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]. |
UDPStart(ID) Example: Starts the UDP Connection with the ID 1 in the Connection Manager. |
UDPStartAll Example: Starts all UDP Connections in the Connection Manager. |
UDPStop(ID) Example: Stops the UDP Connection with the ID 1 in the Connection Manager. |
UDPStopAll Example: Stops all UDP Connections in the Connection Manager. |
VAdd(VarName,Value1,Value2) Example: Adds the variables "Counter1" and "Counter2" and assigns this result to the existing variable "varRes". You could of course also use integer or double values instead of the "Counter" variables. Example2: This example shows the faster and easier syntax "Variable += Value". It adds the value "20" to the current value of "varRes" and assigns the result to the same variable. Example3: The last example shows how to use the Math object for more complex mathematical functions. "Max" for example returns the larger of two specified numbers (or variables). To monitor all variables, their type and value, please refer to the Variable List. |
VArrayAppend(VarName,Value) Example: Adds 99 as an element at the end of the variable "var_List" that was defined beforehand with the List type. Note that the type of the sub element is automatically adjusted. |
VArrayGetFileNames(VarName,Folder) Example: Returns the names (including paths) of all files saved in the folder "Videos" to the variable "var_List" that was defined beforehand with the List type. Note that the amount and type of the sub elements are automatically adjusted. For example, the variable (with separator "|") could return: In case the specified folder is empty or includes only sub folders, the List is cleared. |
VArrayGetFilePathsFromFileDialog(VarName) Example: Opens an explorer dialog for the user to select multiple files. By clicking "Open" the file paths are written to the variable array "var_List" that was defined beforehand. |
VArrayGetFilePathsFromFileDialogWithPath(Path,VarName) Example: Opens an explorer dialog displaying the specified folder for the user to select multiple files. By clicking "Open" the file paths are written to the variable array "var_List" that was defined beforehand. |
VArrayGetListViewRow(Varname,ID,Row) Example: Imports all values from row 3 of ListView ID 2 to variable array "var_List" that was defined beforehand. |
VArrayGetNodeOutputValue(VarName,NodeID,ParamID) Example: Assigns the second output value of the node with ID 5 to the List variable "varList" that was defined beforehand. The second output is also the second entry in the drop-down list when choosing a value in a connected node. |
VArrayPrepend(VarName,Value) Example: Adds 99 as an element at the beginning of the variable "var_List" that was defined beforehand with the List type. Note that the type of the sub element is automatically adjusted. |
VArrayRemoveFirst(VarName) Example: Removes the first element of the variable array "var_List" that was defined beforehand with the List type. |
VArrayRemoveLast(VarName) Example: Removes the last element of the variable array "var_List" that was defined beforehand with the List type. |
VArrayResize(VarName,Size) Example: Resizes the variable array "var_List", that was defined beforehand with the List type, to 3 empty elements, i.e. already existing data is cleared. Use the command VArrayResizePreserve if you like to keep existing data. |
VArrayResizePreserve(VarName,Size) Example: Resizes the variable array "var_List", that was defined beforehand with the List type, to 3 elements and preserves the already existing data. If the original array is larger than the resized one, the redundant elements are deleted. If it is smaller, the missing elements are filled with empty spaces. |
VArrayReverse(VarName) Example: Reverses the order of elements of the variable array "var_List" that was defined beforehand with the List type. |
VArraySort(VarName) Example: Sorts the elements of the variable array "var_List" alphabetically, e.g. ,|.|1|9|a|A|z|Z |
VCreate(VarName,Value) Example: Creates a global variable called "varWeight" with the type Double and the value 73.3. The variable type (String, Integer, Double, Boolean, Date, List, Color, Json) is assigned automatically. In some cases so called members need to be used to specify the type, e.g. VCreate("varColor","#000FFF".ToColor), see more in the chapter Data Type Specific Members. The best practice is, to declare global variables in one script but use their values in separate scripts. The reason is, that scripts are compiled before they are executed and global variables cannot be declared and used in one compilation. This is when local variables should be used. For example: |
VDelete(Name) Example: Deletes the variable with the name "City". |
VDeleteAll Example: Deletes all existing variables inside WD. |
VDivide(VarName,Value1,Value2) Example: Divides the variable "Counter1" by the variable "Counter2" and assigns the result to the existing variable "varRes". You could of course also use integer or double values instead of the "Counter" variables. Example2: This example shows the faster and easier syntax "Variable /= Value". It divides the current value of "varRes" with 20 and assigns the result to the same variable. Example3: The last example shows how to use the Math object for more complex mathematical functions. "Max" for example returns the larger of two specified numbers (or variables). |
VExecuteAsScript(VarName) Example: Executes the content of the string-type variable "var_String" as a script. |
VFade(VarName,StartValue,EndValue,Time) Example: Sets the variable "var_test" to the value 25 and fades it to 196 within 10 seconds. The variable must be defined beforehand and with the type integer and double. Note: The fade itself is not completely linear, it starts slowly, maintains its speed in the middle and slows down again at the end! |
VFadeTo(VarName,Value,Time) Example: Fades variable "var_test" to the value 314 within 10 seconds. The variable must be defined beforehand and with the type integer and double. Note: The fade itself is not completely linear, it starts slowly, maintains its speed in the middle and slows down again at the end! |
VGetArraySize(VarName,ArrName) Example: Returns the absolute number of elements of the variable array "var_List" to the variable "var_Count" that was defined beforehand with the Integer type. E.g. "var_List" = [1,2,3] -> "var_Count" = 3. |
VGetArrayValue(VarName,Index,ArrName) Example: Returns the value of the 8th element from the variable array "var_List" to the variable "var_Value". Whilst "var_List" was defined with the List type, the type of "var_Value" needs to match the extracted array data (Integer, String, etc.). Note: The index starts with 0 -> Index 7 matches the 8th element. |
VGetAssetDurationHMSByID(VarName,FolderID,FileID) Example: Returns the duration (in timecode format hh:mm:ss) of the media file with the Folder and File ID [1,3] in the Pandoras Box Project Tab to the variable "var_String" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetDurationHMSByPath(VarName,ProjectPath) Example: Returns the duration (in timecode format hh:mm:ss) of the media file "blue_lines.m2v", located in the folder "files" in the Pandoras Box Project Tab, to the variable "var_String" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetDurationHMSFByID(VarName,FolderID,FileID) Example: Returns the duration (in timecode format hh:mm:ss:ff) of the media file with the Folder and File ID [1,2] in the Pandoras Box Project Tab to the variable "var_String" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetDurationHMSFByPath(VarName,ProjectPath) Example: Returns the duration (in timecode format hh:mm:ss:ff ) of the media file "blue_lines.m2v", located in the folder "files" in the Pandoras Box Project Tab, to the variable "var_String" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetDurationTotalFramesById(VarName,FolderID,FileID) Example: Returns the total number of frames of the media file with the Folder and File ID [1,5] in the Pandoras Box Project Tab to variable "var_Int" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetDurationTotalFramesByPath(VarName,ProjectPath) Example: Returns the total number of frames of the media file "yellow_lines.m2v", located in the folder "files" in the Pandoras Box Project Tab, to the variable "var_String" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetDurationTotalSecByID(VarName,FolderID,FileID) Example: Returns the duration (in seconds) of the media file with the Folder and File ID [1,3] in the Pandoras Box Project Tab to the variable "var_Value" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetDurationTotalSecByPath(VarName,ProjectPath) Example: Returns the duration (in seconds) of the media file "blue_lines.m2v", located in the folder "files" in the Pandoras Box Project Tab, to the variable "var_Value" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetMediaFileNameByID(VarName,FolderID,FileID) Example: Returns the name (string) of the media file with the Folder and File ID [1,5] in the Pandoras Box Project Tab to the variable "Var_Name" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetMediaHeightByID(VarName,FolderID,FileID) Example: Returns the height (in pixels) of the media file with the Folder and File ID [1,3] in the Pandoras Box Project Tab to the variable "var_Value" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetMediaHeightByName(VarName,AssetName) Example: Returns the height (in pixels) of the media file "blue_lines.m2v", located in the folder "files" in the Pandoras Box Project Tab, to the variable "var_Value" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetMediaProjectFileNameByID(VarName,FolderID,FileID) Example: Returns the Pandoras Box project path (string) of the media file with the Folder and File ID [1,3] in the Pandoras Box Project Tab to the variable "Var_ProjectPath" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetMediaProjectFolderByID(VarName,FolderID,FileID) Example: Returns the specific Folder Name & Media Name (string) as a path with the Folder and File ID [1,3] in the Pandoras Box Project Tab to the variable "Var_Folder" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetMediaWidthByID(VarName,FolderID,FileID) Example: Returns the width (in pixels) of the media file with the Folder and File ID [1,3] in the Pandoras Box Project Tab to the variable "var_Value" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetAssetMediaWidthByName(VarName,AssetName) Example: Returns the width (in pixels) of the media file "blue_lines.m2v", located in the folder "files" in the Pandoras Box Project Tab, to the variable "var_Value" that was defined beforehand. Note: All VGetAsset... commands access cached information that is stored (and updated) through the command PBProjectRefresh. Execute it once before running a VGetAsset command and any time the project has changed. |
VGetContainsText(VarName,SourceString,CompareString) Example: Checks if the compare string ("llo W") matches with any string inside the source string ("Hello World!") and returns "1" for a true argument and "0" for a false one through the string or integer variable "var_true" that was defined beforehand. Note: This function is case-sensitive and space characters count. |
VGetCSVFileColCount(VarName,Filename,Separator(optional)) Example: Returns the amount of columns of the specified CSV file to the variable "var_Count" that was defined beforehand. The separator is optional and can be any symbol. Most programs like Microsoft Excel use the semicolon ";" by default. |
VGetCSVFileRowCount(VarName,Filename) Example: Returns the amount of rows of the specified CSV file to the variable "var_Count" that was defined beforehand. |
VGetDeviceMediaFileID(VarName,SiteID,DeviceID) Example: Returns the File ID of the media file of Pandoras Box, Site 1, Layer 2 to variable "var_Number" that was defined beforehand with the Double or Integer type. |
VGetDeviceMediaFolderID(VarName,SiteID,DeviceID) Example: Returns the Folder ID of the media file of Pandoras Box, Site 1, Layer 2 to variable "var_Number" that was defined beforehand with the Double or Integer type. |
VGetDeviceMediaName(VarName,SiteID,DeviceID) Example: Returns the name of the media file of Pandoras Box, Site 1, Layer 2 to the string-type variable "var_String" that was defined beforehand. Note: The file name does not include the extension (.png / .avi / .wav ...) |
VGetDeviceMediaPath(VarName,SiteID,DeviceID) Example: Returns the path of the media file of Pandoras Box, Site 1, Layer 2 to the string-type variable "var_String" that was defined beforehand. |
VGetDeviceObjectFileID(VarName,SiteID,DeviceID) Example: Returns the File ID of the object file of Pandoras Box, Site 1, Layer 2 to variable "var_Number" that was defined beforehand with the Double or Integer type. |
VGetDeviceObjectFolderID(VarName,SiteID,DeviceID) Example: Returns the Folder ID of the object file of Pandoras Box, Site 1, Layer 2 to variable "var_Number" that was defined beforehand with the Double or Integer type. |
VGetDeviceObjectPath(VarName,SiteID,DeviceID) Example: Returns the path of the object file of Pandoras Box, Site 1, Layer 2 to the string-type variable "var_String" that was defined beforehand. |
VGetDeviceParam(VarName,SiteID,DeviceID,ParamName) Example: Returns the value of the parameter "Opacity" of Pandoras Box, Site 1, Layer 2 to variable "var_Number" that was defined beforehand with the Double or Integer type. Note: The parameter name is case sensitive! You can copy all names including the syntax for an Effect or Particle System from the chapter Parameter List. |
VGetEndsWithText(VarName,SourceString,CompareString) Example: Checks if the compare string ("orld!") matches with the end of the source string ("Hello World!") and returns "1" for a true argument and "0" for a false one through the string or integer variable "var_true" that was defined beforehand. Note: This function is case-sensitive and space characters count. |
VGetExcelCellValue(VarName,File,Table,Cell) Example: Assigns the value of cell C7 from Excel document "excel.xls", table "Sheet1" to the variable "var_Value" that was defined beforehand. Note: The document has to be an XLS file. |
VGetFaderVal(VarName,FaderID) Example: Applies the value of Fader 1 to the variable "Counter". |
VGetFileCount(VarName,Folder) Example: Returns the amount of files saved in the folder "Videos" to variable "var_Count" that was defined beforehand with the Integer or Double type. Note that sub folders are not counted, but system or hidden files are counted which includes for example a "thumbs.db" file. |
VGetFileNameFromPath(VarName,Path) Example: Writes the name of the file described by the path into the string-type variable "var_String" that was defined beforehand. |
VGetFilePathFromFileDialog(VarName) Example: Opens an explorer dialog for the user to select one file. By clicking "Open" the file path is written into the string-type variable "var_String" that was defined beforehand. |
VGetFilePathFromFileDialogWithPath(Path,VarName) Example: Opens an explorer dialog displaying the specified folder for the user to select one file. By clicking "Open" the file path is written into the string-type variable "var_String" that was defined beforehand. |
VGetFolderPathFromFileDialog(VarName) Example: Opens an explorer dialog for the user to select a folder. By clicking "Open" the folder path is written into the string-type variable "var_String" that was defined beforehand. |
VGetFunctionresult(VarName,FunctionName,FunctionArguments (optional)) Example: Executes the example function "FaderFunction" and passes 1 and 5 as input arguments. The return value of "FaderFunction" is applied to the variable "return". |
VGetInputboxText(VarName,ID) Example: Returns the text of the Inputbox 3 to the variable "var_String" that was defined beforehand. |
vGetJsonItem(ToVarName,JsonItem,FromVarName) Example: Loads the Json data from the Json variable "varJsonExample", searches for "products" and stores the related keys and values into the Json variable "varJson" which could be for example: |
VGetLabelText(VarName,LabelID) Example: Applies the text of Label 2 to the variable "City". |
VGetListViewAverageCol(VarName,ID,Col) Example: Calculates the arithmetic mean of all values located in column 2 in ListView 1 and assigns the result to the variable "var_Value" that was defined beforehand. Note: If the variable is an integer-type, the result is being rounded! |
VGetListViewAverageRow(VarName,ID,Row) Example: Calculates the arithmetic mean of all values located in row 2 in ListView 1 and assigns the result to the variable "var_Value" that was defined beforehand. Note: If the variable is an integer-type, the result is being rounded! |
VGetListViewCell(VarName,ID,Column,Row) Example: Searches for the cell located in column 2, row 3 in ListView 1. Its value is assigned to the variable "var_Value" that was defined beforehand. |
VGetListViewSearchCell(ID,Value,VarNameForColumn,VarNameForRow) Example: Searches for a cell with the value 3.142 in ListView 1 and assigns its position (number of column and number of row) to the variables "var_Col" and "var_Row" that were defined beforehand. Note: If there is no such value in the Listview, the command will return -1 / -1. |
VGetListViewSearchDown(VarName,ID,Value,Offset(optional)) Example: Searches for a cell with the value 13 in ListView 1 and looks for the cell three rows down (1 cell down + 2 cells offset). Its value is assigned to the variable "var_Value" that was defined beforehand. E.g, if Value 13 was found in (any column) row 1, the command returns the value of (same column) row 4. Example 2: |
VGetListViewSearchLeft(VarName,ID,Value,Offset(optional)) Example: Searches for a cell with the value 13 in ListView 1 and looks for the cell three columns to the left (1 cell to the left + 2 cells offset). Its value is assigned the variable "var_Value" that was defined beforehand. E.g, if Value 13 was found in column 4 (any row), the command returns the value of column 1 (same row) Example 2: |
VGetListViewSearchRight(VarName,ID,Value,Offset(optional)) Example: Searches for a cell with the value 13 in ListView 1 and looks for the cell three columns to the right (1 cell to the right + 2 cells offset). Its value is assigned the variable "var_Value" that was defined beforehand. E.g, if Value 13 was found in column 1 (any row), the command returns the value of column 4 (same row). Example 2: |
VGetListViewSearchUp(VarName,ID,Value,Offset(optional)) Example: Searches for a cell with the value 13 in ListView 1 and looks for the cell three rows up (1 cell up + 2 cells offset). Its value is assigned to the variable "var_Value" that was defined beforehand. E.g, if Value 13 was found in (any column) row 4, the command returns the value of (same column) row 1. Example 2: |
VGetListViewSelectedRow(VarName,ID) Example: Assigns the number of the currently selected row of ListView 1 to variable "var_Int" that was defined beforehand. |
VGetListViewSumCol(VarName,ID,Col) Example: Calculates the sum of all values located in column 2 in ListView 1 and assigns the result to the variable "var_Value" that was defined beforehand. Note: If the variable is an integer-type, the result is being rounded! |
VGetListViewSumRow(VarName,ID,Row) Example: Calculates the sum of all values located in row 2 in ListView 1 and assigns the result to the variable "var_Value" that was defined beforehand. Note: If the variable is an integer-type, the result is being rounded! |
VGetNodeOutputValue(Varname,NodeID,ParamID) Example: Assigns the second output value of the node with ID 1 to the variable "var_Value" that was defined beforehand. The second output is also the second entry in the drop-down list when choosing a value in a connected node. Note: Please use the correct type of variable matching the node output type. |
VGetNodeVal(VarName,NodeID,ParamID) Example: Applies the value of Node 10, Parameter 1 to the variable "Counter". |
VGetPBPlaylistItemCountByID(VarName,PlaylistFolderID,PlaylistFileID) Example: This returns the total count of items of the Pandoras Box playlist with the folder and file ID [2,1]. The (string or number) Variable "var1" in Widget Designer will be assigned with this number. |
VGetPBPlaylistItemCountByPath(VarName,PlaylistPath) Example: This returns the total count of items of the Pandoras Box playlist "Playlist 1" of the subfolder "Playlist Test" within the project folder. The (string or number) Variable "var1" in Widget Designer will be assigned with this number. |
VGetRSSUrlItemBody(VarName,UrlID,ItemID) Example: Assigns the body of RSS item 14 of the RSS feed with ID 1 to the string-type variable "var_String" that was defined beforehand. RSS news feeds can be accessed via the RSS Settings Tool. |
VGetRSSUrlItemCount(VarName,UrlID) Example: Counts the number of RSS items within the RSS feed with ID 1 and assigns the result to the variable "var_Count" that was defined beforehand. RSS news feeds can be accessed via the RSS Settings Tool. |
VGetRSSUrlItemFeed(VarName,UrlID,ItemID) Example: Assigns the title and body of RSS item 14 of the RSS feed with ID 1 to the string-type variable "var_String" that was defined beforehand. RSS news feeds can be accessed via the RSS Settings Tool. |
VGetRSSUrlItemTitle(VarName,UrlID,ItemID) Example: Assigns the title of RSS item 14 of the RSS feed with ID 1 to the string-type variable "var_String" that was defined beforehand. RSS news feeds can be accessed via the RSS Settings Tool. |
VGetSeqCueName(VarName,SeqID,CueID) Example: This applies the name of Cue 3 from the Sequence 1 in Pandoras Box to the variable in Widget Designer named "Counter". If the cue name includes letters, the Variable's type must be "String". To monitor all variables, their type and value, please refer to the Variable List. |
VGetSeqState(VarName,SeqID) Example: This applies the current playback state "Play", "Pause" or "Stop" of the Sequence 1 in Pandoras Box to the variable in Widget Designer which is named "Counter" . To monitor all variables, their type and value, please refer to the Variable List. |
VGetSeqTime(VarName,SeqID) Example: This applies the timecode (e.g. 00:01:12:23) of Sequence 1 in Pandoras Box to the variable in Widget Designer which is named "Counter" . The type of the variable must be "String". To monitor all variables, their type and value, please refer to the Variable List. |
VGetSiteConnectionBackup(VarName,SiteID) Example: Checks if Site 4 of Pandoras Box (Backup) is connected and returns "1" for a true argument and "0" for a false one through the variable "var_true" that was defined beforehand with the Integer or Double type. The IP address for the PB Backup connection can be entered in the dialog Pandoras Box Network Configuration. |
VGetSiteConnectionMaster(VarName,SiteID) Example: Checks if Site 4 of Pandoras Box (Master) is connected and returns "1" for a true argument and "0" for a false one through the variable "var_Number" that was defined beforehand with the Integer or Double type. The IP address for the PB Master connection can be entered in the dialog Pandoras Box Network Configuration. |
VGetStartsWithText(VarName,SourceString,CompareString) Example: Checks if the compare string ("Hell") matches with the beginning of the source string ("Hello World!") and returns "1" for a true argument and "0" for a false one through the string or integer variable "var_true" that was defined beforehand. Note: This function is case-sensitive and space characters count. |
VGetStringLength(VarName,String) Example: Counts the amount of characters of the source string "I like trains" (= 13) and writes the result into the variable "var_lenghth" that was defined beforehand. Space characters count as well. |
VGetStringReplace(VarName,String,OldString,NewString) Example: Sets the string-type variable to the string "Hello World!" and replaces the part "llo Wor" (if it exists) with "lium Go". New Value of var_String: "Helium Gold!". Space characters count as well. |
VGetSubString(VarName,String,StartIndex,Length) Example: Shortens the string "I like trains" and writes the result into the string-type variable "var_String" that was defined before. In the example, the sub string has the length of 8 characters and begins with the 4th letter of the source string ("ike trai"). The start index 0 would refer to the first character. |
VGetSubStringTrimStart(VarName,String,StartIndex) Example: Trims the first 7 characters (including spaces etc.) of the string "Hello World!". |
VGetTextboxText(VarName,TextboxID) Example: Applies the text of Textbox 1 to the variable "V_Test". To monitor all variables, their type and value, please refer to the Variable List. |
VLock(VarName) Example: Locks the variable "var_test" so that its value cannot be edited. |
VMultiply(VarName,Value1,Value2) Example: Multiplies the values of the variables "Counter1" and "Counter2" and passes the result to the existing variable "varRes". You could of course also use integer or double values instead of the "Counter" variables. Example2: This example shows the faster and easier syntax "Variable *= Value". It multiplies the current value of "varRes" with the value "20" and assigns the result to the same variable. Example3: The last example shows how to use the Math object for more complex mathematical functions. "Max" for example returns the larger of two specified numbers (or variables). To monitor all variables, their type and value, please refer to the Variable List. |
VPow(VarName,Value1,Value2) Example: Raises the variable "Counter1" to the power of "Counter2" and assigns the result to the existing variable "varRes". You could of course also use integer or double values instead of the "Counter" variables. Example2: This example shows how to use the Math object for the same approach; it also offers other more complex mathematical functions. To monitor all variables, their type and value, please refer to the Variable List. |
VReplaceAsciiNumberByHexCode(VarName,String,Delimter) Example: Replaces any ASCII number in the entered string by its corresponding HEX code and separates them with the separator character ":". Other characters simply remain in the string. The result (:31 :36:34 :32:35:36 hi :31:31) is returned to the variable "var_String" that was defined beforehand with the string type. |
VReplaceNumberByHexCode(VarName,String,Delimter,LeadingZeros) Example: Replaces any number in the entered string by its corresponding HEX code, adds up to 2 leading zeros and separates the result with the separator character ":". Other characters than numbers simply remain in the string. The result (:001 :040 :100 hi :00B) is returned to the variable "var_String" that was defined beforehand with the string type. |
VSetArrayFromSplitString(VarName,String,Separator) Example: Splits the specified string wherever the separator character ";" occurs. The resulting sub strings are returned as elements of the variable "var_List" that was defined beforehand with the List type. Note that the amount and type of the sub elements are automatically adjusted. The separator can be any single character including comma "," and space character " ". |
VSetArrayFromTextBox(VarName,TextBoxID) Example: Loads the content of Textbox 1 into the variable "var_List" that was defined beforehand with the List type. Please note that the defined separator is not recognized automatically! If you like to pass several sub elements to the list variable, you have two options: |
VSetArrayRNDUniqueInt('VarName',StartVal,EndVal) Example: Fills the variable array "var_List", that was defined beforehand with the List type, with random integer values from 1 to 100, no value appears twice. Note: The array's size must be larger than the number of possible (unique) values! |
VSetArrayValue(VarName,Index,Value) Example: Sets the value of the 8th element in the variable array "var_List", that was defined beforehand with the List type, to the value 444. The type of the sub element is automatically adjusted. Note: The index starts with 0 -> Index 7 matches the 8th element. |
VSetValueFromSplitString(VarName,String,Separator,Index) Example: Splits the specified string wherever the separator character ":" occurs. The resulting sub string with index 2 is returned to the variable "var_Value" that was defined beforehand with the type that matches the string data (Integer, String, etc.). As indexing starts with 0, var_Value = 30. |
VSqrt(VarName,Value) Example: Calculates the square root of the variable "Counter1" and assigns the result to the existing variable "varRes". You could of course also use an integer or double value instead of the "Counter" variable. Example2: This example shows how to use the Math object for the same approach; it also offers other more complex mathematical functions. To monitor all variables, their type and value, please refer to the Variable List. |
VSubtract(VarName,Value1,Value2) Example: Subtracts the variable "Counter2" from "Counter1" and assigns the result to the existing variable "varRes". You could of course also use integer or double values instead of the "Counter" variables. Example2: This example shows the faster and easier syntax "Variable -= Value". It subtracts the value "20" from the current value of "varRes" and assigns the result to the same variable. Example3: The last example shows how to use the Math object for more complex mathematical functions. "Max" for example returns the larger of two specified numbers (or variables). To monitor all variables, their type and value, please refer to the Variable List. |
VUnLock(VarName) Example: Unlocks the variable "var_test" so that its value can be edited. |
VValue(VarName,Value) Example: Applies the value "20" to the variable "varRes". Example2: The second example shows how to use the syntax "Variable = Value" for the same approach. |
VValueDate(VarName) Example: Returns the current date (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. Example2: The second example shows how to use the global variable "Now" for the same approach but in a different format. |
VValueDateAddDays(VarName,Days) Example: This adds five days to the current date and returns the result (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. Note: To subtract please use negative values. |
VValueDateAddDaysToDate(VarName,DD,MM,YYYY,Days) Example: This adds five days to the specified date and returns the result (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. When executing this example, the result would be: 30/01/2010 Note: To subtract please use negative values. If you prefer to enter your date in the dd/mm/yyyy format too, use the VValueDateAddDaysToDateF command. |
VValueDateAddDaysToDateF(VarName,DD/MM/YYYY,Days) Example: This adds five days to the specified date and returns the result (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. When executing this example, the result would be: 30/01/2010 Note: To subtract please use negative values. If you prefer to enter your date as separate values (i.e. dd,mm,yyyy), use the VValueDateAddDaysToDate command. |
VValueDateAddMonths(VarName,Months) Example: This adds five months to the current date and returns the result (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. Note: To subtract please use negative values. |
VValueDateAddMonthsToDate(VarName,DD,MM,YYYY,Months) Example: This adds five months to the specified date and returns the result (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. When executing this example, the result would be: 25/06/2010 Note: To subtract please use negative values. If you prefer to enter your date in the dd/mm/yyyy format too, use the VValueDateAddMonthsToDateF command. |
VValueDateAddMonthsToDateF(VarName,DD/MM/YYYY,Months) Example: This adds five months to the specified date and returns the result (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. When executing this example, the result would be: 25/06/2010 Note: To subtract please use negative values. If you prefer to enter your date as separate values (i.e. dd,mm,yyyy), use the VValueDateAddMonthsToDate command. |
VValueDateAddYears(VarName,Years) Example: This adds five years to the current date and returns the result (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. Note: To subtract please use negative values. |
VValueDateAddYearsToDate(VarName,DD,MM,YYYY,Years) Example: This adds five years to the specified date and returns the result (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. When executing this example, the result would be: 25/01/2015 Note: To subtract please use negative values. If you prefer to enter your date in the dd/mm/yyyy format too, use the VValueDateAddYearsToDateF command. |
VValueDateAddYearsToDateF(VarName,DD/MM/YYYY,Years) Example: This adds five years to the specified date and returns the result (in the format dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. When executing this example, the result would be: 25/01/2015 Note: To subtract please use negative values. If you prefer to enter your date as separate values (i.e. dd,mm,yyyy), use the VValueDateAddYearsToDate command. |
VValueDateF(VarName) Example: Returns the current date (format: dd-mm-yyyy) to the variable "var_String" that was defined beforehand with the string type. |
VValueDateTime(VarName) Example: Returns the current time and date (format: hh:mm:ss dd/mm/yyyy) to the variable "var_String" that was defined beforehand with the string type. |
VValueDateTimeF(VarName) Example: Returns the current time and date (format: hh-mm-ss_dd-mm-yyyy) to the variable "var_String" that was defined beforehand with the string type. |
VValueRandom(VarName) Example: Assigns a random value to the variable "var_Double" that was defined beforehand with the Integer or Double type. A double-type variable ranges between 0 and 1 and an integer-type variable between 0 and 100. |
VValueRandomMinMax(VarName,Min,Max) Example: Assigns a random value between 10 and 100 to the variable "var_Double" that was defined beforehand with the Integer or Double type. |
VValueRound(VarName,DecimalPlaces) Example: Rounds the double-type variable "var_Double" to two digits. E.g: 3.1415926 -> 3.14 |
VValueTime(VarName) Example: Returns the current time (format: hh:mm:ss) to the variable "var_String" that was defined beforehand with the string type. |
VValueTimeAddHours(VarName,Hour) Example: Returns the current time (format: hh:mm:ss) plus three hours to the variable "var_String" that was defined beforehand with the string type. Note: To subtract please use negative values. |
VValueTimeAddMinutes(VarName,Min) Example: Returns the current time (format: hh:mm:ss) plus three minutes to the variable "var_String" that was defined beforehand with the string type. Note: To subtract please use negative values. |
VValueTimeAddSeconds(VarName,Sec) Example: Returns the current time (format: hh:mm:ss) plus ten seconds to the variable "var_String" that was defined beforehand with the string type. Note: To subtract please use negative values. |
VValueTimeF(VarName) Example: Returns the current time (format: hh-mm-ss) to the variable "var_String" that was defined beforehand with the string type. |
WakeOnLan(MacAddress) Example: Turns on or wakes up the computer with the MacAddress 08-00-20-AE-FD-7E. Please note: |
WakeOnLanByAdapter(MacAddress,NicAdapterName) Example: Turns on or wakes up the computer with the MacAddress 08-00-20-AE-FD-7E. The command is sent out via NIC adapter "Lan1" of the local PC. Please note: |
WakeOnLanByPort(MacAddress,Port) Example: Turns on or wakes up the computer with the MacAddress 08-00-20-AE-FD-7E. In contrast to the "WakeOnLan" command, this one allows to specify the destination port which is usually 7 or 9. If you are using more than one ethernet adapter / connection, consider using the alternative command "WakeOnLanByAdapter". Please note: |
WDAirScanConnect(IP(optional)) Example: This connects to the AirScan with IP 2.0.0.50. Example 2: Use this to connect to the AirScan with the IP entered in the AirScan Tool dialog. |
WDAirScanDamping(Value) Example: Changes the value "Damping" inside the AirScan Tool to 0.5. |
WDAirScanDisableTouch Example: Disables the option inside the AirScan Tool to send touch points to other controls like the Multi-Touch Panel. Note that there is no check box for that option. |
WDAirScanDisconnect Example: This disconnects the currently connected AirScan. Use WDAirScanConnect(IP(optional)) to re-connect. |
WDAirScanEnableTouch Example: Enables the option inside the AirScan Tool to send touch points to other controls like the Multi-Touch Panel. Note that there is no check box for that option. |
WDAirScanGap(Value) Example: Changes the value "Gap" inside the AirScan Tool to 20. |
WDAirScanMaxDelta(Value) Example: Changes the value "Max Delta" inside the AirScan Tool to 50. |
WDAirScanMotion(Value) Example: Changes the value "Motion" (motion damping) inside the AirScan Tool to 0.5. |
WDAirScanMotionPredictionDisable Example: Disables the option "Motion Prediction" inside the AirScan Tool. |
WDAirScanMotionPredictionEnable Example: Enables the option "Motion Prediction" inside the AirScan Tool. |
WDAirScanMotionPredictionFactor(Value) Example: Changes the value "Motion Prediction" inside the AirScan Tool to 0.5. |
WDAirScanMouseClickDefault Example: This command defines when a mouse click (controlled via AirScan) should be executed. Please note: |
WDAirScanMouseClickDisabled Example: With this option the mouse cursor (controlled via the AirScan) does not generate clicks. |
WDAirScanMouseClickEnabled Example: With this option the mouse cursor (controlled via the AirScan) generates clicks. |
WDAirScanMouseClickOnEnter Example: This command defines when a mouse click (controlled via AirScan) should be executed. Please note: |
WDAirScanMouseClickOnLeave Example: This command defines when a mouse click (controlled via AirScan) should be executed. "OnLeave": the click is generated on mouse leave. Please note: |
WDAirScanMouseDisabled Example: Disables the AirScan to control the mouse. |
WDAirScanMouseDownOnMoveDisabled Example: If this option is disabled in the AirScan Tool, left mouse down on move is not active. |
WDAirScanMouseDownOnMoveEnabled Example: If this option is enabled in the AirScan Tool, left mouse down on move is always active. |
WDAirScanMouseEnabled Example: Enables the AirScan to control the mouse. |
WDAirScanMultiPointModeDisabled Example: Disables the MultiPointMode in the AirScan Tool, so that the 2-Point-Mode will be used. |
WDAirScanMultiPointModeEnabled Example: Enables the MultiPointMode in the AirScan Tool. |
WDAirScanPointCount(PointCount) Example: Changes the amount of detected touch points inside the AirScan Tool to 12. |
WDAirScanPointIDOffset(Value) Example: Changes the value "Point ID Offset" inside the AirScan Tool to 2. |
WDAirScanStart(Value) Example: Changes the value "Start" inside the AirScan Tool to 50. |
WDAirScanStop(Value) Example: Changes the value "Stop" inside the AirScan Tool to 250. |
WDAirScanTrim(Value) Example: Changes the value "Trim" inside the AirScan Tool to 25. |
WDAirScanTUIODisable Example: Disables the option "TUIO" inside the AirScan Tool. |
WDAirScanTUIOEnable Example: Changes the amount of detected touch points inside the AirScan Tool to 12. |
WDAirScanVCount(Value) Example: Changes the value "VCount" inside the AirScan Tool to 5. |
WDAirScanXOffset(Value) Example: Changes the value "X Offset" inside the AirScan Tool to 50. |
WDAirScanYOffset(Value) Example: Changes the value "Y Offset" inside the AirScan Tool to 50. |
WDAnalogClockCssStyleDisable(ID,StyleID) Example: Disables the CSS Style with ID 2 in the Item Properties of the AnalogClock with ID 5. |
WDAnalogClockCssStyleEdit(ID,StyleID,ParamName,Value) Example: Edits the CSS Style with ID 2 in the Item Properties of the AnalogClock with ID 5. The parameter "StartOpacity", e.g. from the Style "2D\FadeIn", is set to a value of 150. |
WDAnalogClockCssStyleEnable(ID,StyleID) Example: Enables the CSS Style with ID 2 in the Item Properties of the AnalogClock with ID 5. |
WDAnalogClockFix(ID) Example: This activates the option "Fix" in the Item Properties of the AnalogClock with ID 5. "Fix" influences whether the Widget is only visible on the Page it was created on, or on all Pages. |
WDAnalogClockGetCaptionFontFamily(ID) Example: This refers to the AnalogClock with ID 5 and returns the caption's current font family name as a string. The "Caption" is the optional text that appears in the center of the clock. You could also assign it directly to a Widget, e.g. another AnalogClock via a script like: WDAnalogClockSetCaptionFontFamily(5,WDAnalogClockGetCaptionFontFamily(1)) |
WDAnalogClockGetCaptionFontSize(ID) Example: This refers to the AnalogClock with ID 5 and returns the caption's current font size in "pt" as a double. The "Caption" is the optional text that appears in the center of the clock. You could also assign it directly to a Widget, e.g. another AnalogClock via a script like: WDAnalogClockSetCaptionFontSize(5,WDAnalogClockGetCaptionFontSize(1)) |
WDAnalogClockGetLabelFontFamily(ID) Example: This refers to the AnalogClock with ID 5 and returns the current font family name from the labels as a string. You could also assign it directly to a Widget, e.g. another AnalogClock via a script like: WDAnalogClockSetLabelFontFamily(5,WDAnalogClockGetLabelFontFamily(1)) |
WDAnalogClockGetLabelFontSize(ID) Example: This refers to the AnalogClock with ID 5 and returns the current font size from the labels in "pt" as a double. The labels refer only to the numbers 1-12, whilst "Caption" refers to the optional text appearing in the center of the clock. You could also assign it directly to a Widget, e.g. another AnalogClock via a script like: WDAnalogClockSetLabelFontSize(5,WDAnalogClockGetLabelFontSize(1)) |
WDAnalogClockGetLocationLeft(ID) Example: This refers to the AnalogClock with ID 5 and returns its current horizontal location on the Page. The value expresses the distance in pixels from the left border. The top left corner of the Page has the coordinates (0,0). You can assign the value directly to another Widget or first to a Variable, e.g. var0 = WDAnalogClockGetLocationLeft(1) |
WDAnalogClockGetLocationTop(ID) Example: This refers to the AnalogClock with ID 5 and returns its current vertical location on the Page. The value expresses the distance in pixels from the top border. The top left corner of the Page has the coordinates (0,0). You can assign the value directly to another Widget or first to a Variable, e.g. var0 = WDAnalogClockGetLocationTop(1) |
WDAnalogClockGetSizeHeight(ID) Example: This refers to the AnalogClock with ID 5 and returns its current height (i.e. vertical size) in pixels. You can assign the value directly to another Widget or first to a Variable, e.g. var0 = WDAnalogClockGetSizeHeight(1) |
WDAnalogClockGetSizeWidth(ID) Example: This refers to the AnalogClock with ID 5 and returns its current width (i.e. horizontal size) in pixels. You can assign the value directly to another Widget or first to a Variable, e.g. var0 = WDAnalogClockGetSizeWidth(1) |
WDAnalogClockLocation(ID,X,Y) Example: Sets the position of the AnalogClock with ID 5 to 100px horizontally and 200px vertically. 0,0 is the top left corner of the Page. |
WDAnalogClockLocationLeft(ID,X) Example: Sets the position of the AnalogClock with ID 5 to 100px horizontally but remains the current vertical position. 0,0 is the top left corner of the Page. |
WDAnalogClockLocationTop(ID,Y) Example: Sets the position of the AnalogClock with ID 5 to 200px vertically but remains the current horizontal position. 0,0 is the top left corner of the Page. |
WDAnalogClockSetCaptionFontFamily(ID,FontName) Example: This refers to the AnalogClock with ID 5 and sets the caption's font family to "Arial". The "Caption" is the optional text that appears in the center of the clock. |
WDAnalogClockSetCaptionFontSize(ID,FontSize) Example: This refers to the AnalogClock with ID 5 and sets the caption's font size to 20pt. The "Caption" is the optional text that appears in the center of the clock. |
WDAnalogClockSetLabelFontFamily(ID,FontName) Example: This refers to the AnalogClock with ID 5 and sets the font family for the labels to "Arial". The labels refer only to the numbers 1-12, whilst "Caption" refers to the optional text appearing in the center of the clock. |
WDAnalogClockSetLabelFontSize(ID,FontSize) Example: This refers to the AnalogClock with ID 5 and sets the font size for the labels to 20pt. The labels refer only to the numbers 1-12, whilst "Caption" refers to the optional text appearing in the center of the clock. |
WDAnalogClockSize(ID,Width,Height) Example: Sets the size of the AnalogClock with ID 5 to a width of 100px and a height of 40px. |
WDAnalogClockSizeHeight(ID,Height) Example: Sets the size of the AnalogClock with ID 5 to a height of 40px but remains the current width. |
WDAnalogClockSizeWidth(ID,Width) Example: Sets the size of the AnalogClock with ID 5 to a width of 100px but remains the current height. |
WDAnalogClockUnfix(ID) Example: This deactivates the option "Fix" in the Item Properties of the AnalogClock with ID 5. "Fix" influences whether the Widget is only visible on the Page it was created on, or on all Pages. |
WDArtNetRecorderAddTextFromLabel(ID,LabelID) Example: Adds the text from Label 3 to the current Label of the Art-Net Recorder button with ID 6. |
WDArtNetRecorderClick(ID) Example: Clicks the Art-Net Recorder button with ID 5. If you like to execute this command addressing many buttons, the chapter "For loop" and "Project and Context Member" show some interesting examples. |
WDArtnetRecorderClickImage(ID,File) Example: Changes the look of the Art-Net Recorder Button with ID 1 - it loads the image "buttonImage10.jpg" that was saved under "C:\Christie\content" and displays it when the Art-Net Recorder is in the mode "Click". |
WDArtNetRecorderClickImageResource(ID,ResourceName) Example: This sets the image for the clicked status of the Art-Net Recorder button with ID 5 to the image saved under the specified name in the "Image Resource Manager" which is also accessible through the "Res" button in the Item Properties dialog of the button. |
WDArtNetRecorderCssStyleDisable(ID,StyleID) Example: Disables the CSS Style with ID 2 in the Item Properties of the Art-Net Recorder button with ID 5. |
WDArtNetRecorderCssStyleEdit(ID,StyleID,ParamName,Value) Example: Edits the CSS Style with ID 2 in the Item Properties of the Art-Net Recorder button with ID 5. The parameter "StartOpacity", e.g. from the Style "2D\FadeIn", is set to a value of 150. |
WDArtNetRecorderCssStyleEnable(ID,StyleID) Example: Enables the CSS Style with ID 2 in the Item Properties of the Art-Net Recorder button with ID 5. |
WDArtNetRecorderFix(ID) Example: This activates the option "Fix" in the Item Properties of the Art-Net Recorder button with ID 5. "Fix" influences whether the Widget is only visible on the Page it was created on, or on all Pages. |
WDArtNetRecorderGetLocationLeft(ID) Example: This refers to the Art-Net Recorder button with ID 5 and returns its current horizontal location on the Page. The value expresses the distance in pixels from the left border. The top left corner of the Page has the coordinates (0,0). You can assign the value directly to another Widget or first to a Variable, e.g. var0 = WDArtNetRecorderGetLocationLeft(1) |
WDArtNetRecorderGetLocationTop(ID) Example: This refers to the Art-Net Recorder button with ID 5 and returns its current vertical location on the Page. The value expresses the distance in pixels from the top border. The top left corner of the Page has the coordinates (0,0). You can assign the value directly to another Widget or first to a Variable, e.g. var0 = WDArtNetRecorderGetLocationTop(1) |
WDArtNetRecorderGetSizeHeight(ID) Example: This refers to the Art-Net Recorder button with ID 5 and returns its current height (i.e. vertical size) in pixels. You can assign the value directly to another Widget or first to a Variable, e.g. var0 = WDArtNetRecorderGetSizeHeight(1) |
WDArtNetRecorderGetSizeWidth(ID) Example: This refers to the Art-Net Recorder button with ID 5 and returns its current width (i.e. horizontal size) in pixels. You can assign the value directly to another Widget or first to a Variable, e.g. var0 = WDArtNetRecorderGetSizeWidth(1) |
WDArtNetRecorderGotoFrame(ID,Frame) Example: Sets the Art-Net Recorder Button 1 to the frame 330 of the last recorded Art-Net Sequence. |
WDArtNetRecorderHighlightImage(ID,Existing file) Example: This sets the image for the highlighted status of the Art-Net Recorder button with ID 5 to the image saved under the specified path. |
WDArtNetRecorderHighlightImageResource(ID,Text) Example: This sets the image for the highlighted status of the Art-Net Recorder button with ID 5 to the image saved under the specified name in the "Image Resource Manager" which is also accessible through the "Res" button in the Item Properties dialog of the button. |
WDArtNetRecorderLabel(ID,Text) Example: Labels the Art-Net Recorder button with ID 5 with the word "Show". |
WDArtNetRecorderLabelColor(ID,R,G,B) Example: Changes the label color of the Art-Net Recorder button with ID 5 to orange (Red=255, Green=90, Blue=0). The values for R,G,B range from 0 to 255. |
WDArtNetRecorderLocation(ID,X,Y) Example: Sets the position of the Art-Net Recorder button with ID 5 to 100px horizontally and 200px vertically. 0,0 is the top left corner of the Page. |
WDArtNetRecorderLocationLeft(ID,X) Example: Sets the position of the Art-Net Recorder button with ID 5 to 100px horizontally but remains the current vertical position. 0,0 is the top left corner of the Page. |
WDArtNetRecorderLocationTop(ID,Y) Example: Sets the position of the Art-Net Recorder button with ID 5 to 200px vertically but remains the current horizontal position. 0,0 is the top left corner of the Page. |
WDArtNetRecorderLoop(ID) Example: Sets the playmode of the Art-Net sequence recorded with Art-Net Recorder Button 2 to Loop. |
WDArtNetRecorderPause(ID) Example: Pauses the playing Art-Net sequence recorded with Art-Net Recorder Button 2. |
WDArtNetRecorderPlay(ID) Example: Plays the Art-Net sequence recorded with Art-Net Recorder Button 2 from it's current time. |
WDArtNetRecorderPlayOnce(ID) Example: Sets the playmode of the Art-Net sequence recorded with Art-Net Recorder Button 2 to PlayOnce. |
WDArtNetRecorderReleaseImage(ID,Existing file) Example: This sets the image for the released status of the Art-Net Recorder button with ID 5 to the image saved under the specified path. |
WDArtNetRecorderReleaseImageResource(ID,Text) Example: This sets the image for the released status of the Art-Net Recorder button with ID 5 to the image saved under the specified name in the "Image Resource Manager" which is also accessible through the "Res" button in the Item Properties dialog of the button. |
WDArtNetRecorderRewind(ID) Example: Rewinds the Art-Net sequence recorded with Art-Net Recorder Button 2 to it's inpoint. When the sequence is currently playing, it won't be stopped but starts from it's beginning again. |
WDArtNetRecorderSize(ID,Width,Height) Example: Sets the size of the Art-Net Recorder button with ID 5 to a width of 100px and a height of 40px. |
WDArtNetRecorderSizeHeight(ID,Height) Example: Sets the size of the Art-Net Recorder button with ID 5 to a height of 40px but remains the current width. |
WDArtNetRecorderSizeWidth(ID,Width) Example: Sets the size of the Art-Net Recorder button with ID 5 to a width of 100px but remains the current height. |
WDArtNetRecorderStart(ID) Example: Starts the recording of Art-Net Recorder Button 1. |
WDArtNetRecorderStop(ID) Example: Stops the recording of Art-Net Recorder Button 1. |
Show/Hide hidden text
