Scripting Commands Reference
Scripting Commands Reference
Scripting Commands
VuWall Technology, Inc.
181, Hymus Blvd, Suite 301
Pointe-Claire, QC H9R 5P4
Phone +1 514 505 4436
VuWall2 Scripting Commands
Table of Contents
GetLayoutNames .......................................................................................... 3
GetSources ................................................................................................... 3
GetSources SourceType: .............................................................................. 3
GetWindowNumbers Sublayout: Surface:...................................................... 3
GetSource Window: Sublayout: Surface: ....................................................... 4
Open Layout: Surface:................................................................................... 4
Open Window: Layout: Sublayout: Surface: .................................................. 5
Open Window: Source: Sublayout: Surface: .................................................. 5
CreateWindow Monitor: Surface: ................................................................... 6
CreateWindow Horizontal: Vertical: Surface: ................................................. 6
CloseWindows SourceType: Sublayout: Surface: .......................................... 7
Clear Window: Sublayout: Surface: ............................................................... 7
Move Window: Monitor: Surface: ................................................................... 8
Move Window: Horizontal: Vertical: Surface: ................................................. 8
Hide Window: Sublayout: Surface: ................................................................ 9
Show Window: Sublayout: Surface: ............................................................... 9
GetWindow Index: Sublayout: Surface: ....................................................... 10
Reorder Window: Index: Sublayout: Surface: .............................................. 10
Focus Window: Sublayout: Surface: ............................................................ 11
Close Window: Sublayout: Surface:............................................................. 11
Carousel Sublayout: Surface: ...................................................................... 11
SaveCurrentLayout Name: Overwrite: Sublayout: Surface: ......................... 12
Execute Script: ............................................................................................ 12
ExecuteProgram Path: Arguments: ............................................................. 13
StartTransition Name: Windows: Repeat: Surface: ...................................... 13
OpenScrollingText Name: Window: Surface: ............................................... 14
RegisterStream Provider: URI: .................................................................... 14
DeleteStream Provider: ............................................................................... 14
ActivateSchedule Name: ............................................................................. 15
SaveSchedules Name: Overwrite: ............................................................... 15
ClearSchedules ........................................................................................... 15
Connect IP: Port: ......................................................................................... 15
ConnectTelnet IP: Port: ............................................................................... 16
RequestHTTP Method: URL: Body: Username: Password: ......................... 16
Wait Duration:.............................................................................................. 17
SetNLSSChannel IP: Username: Password: ChannelNumber: ................... 17
SetNLSSSequence IP: Username: Password: SequenceName: ................. 17
SetNLSSView IP: Username: Password: ViewName: .................................. 18
GetLayoutNames
Use the GetLayoutNames command to read the names of the layouts that are currently
saved on the video wall controller.
Result : { Text }
A sequence containing all the names of the layouts.
Examples:
Names = GetLayoutNames;
# Names = { "Layout 1", "Layout 2" }
GetSources
Use the GetSources command to retrieve a list of the names of all sources that are
saved or detected on the video wall controller.
Result : { Text }
A sequence containing all the names of the sources.
Examples:
Sources = GetSources;
# Sources = { input("Input 1"), client("192.168.1.1") }
GetSources SourceType:
Use the GetSources command to retrieve a list of the names of all sources that are
saved or detected on the video wall controller.
Result : { Text }
A sequence containing all the names of the sources.
Examples:
Inputs = GetSources SourceType: inputs;
Apps = GetSources SourceType: applications;
Clients = GetSources SourceType: clients;
Text = GetSources SourceType: scrollingtexts;
Browsers = GetSources SourceType: browsers;
Devices = GetSources SourceType: devices;
# Devices = { "Camera 1", "Camera 2" }
Result : { Number }
A sequence containing all the numbers of the windows, in order from back
to front.
Examples:
Numbers = GetWindowNumbers Surface: main();
# Numbers = { 2, 0, 1 }
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Examples:
Source = GetSource Window: 3 Surface: named("Meeting Room");
# Source = input("Input 2")
Use the Open Layout command to open a layout across the whole video wall.
Layout : Text
The layout is identified by its name, as it appears in the Layouts list of
VuWall2.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Open Layout: "Scenario 1";
Open Layout: "Scenario 2" Surface: named("Control Room");
Note: sending VuWall2 scripts via the network API must end with a carriage return and line feed (0x0D0A).
Consult the main user's manual for connection details.
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Layout : Text
The layout opened in the window is identified by its name, as it appears in the
Layouts list of VuWall2.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Open Window: 1 Layout: "Layout 2";
Open Window: 2 Layout: "Layout 1";
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Source : < input : Text, client : Text, application : Text, browser : Text,
scrollingtext : Text, device : Text, website : Text, stream : Text >
The source opened in the window can be any of the sources types supported by
VuWall2, that is hardware inputs, remote clients connected to the video wall,
and local applications on the video wall controller.
The text used to identify an input is its name, as it appears in the Inputs
list of VuWall2.
The text used to identify a remote client is its name, as it appears in the
Clients list of VuWall2. That is, its given name or its IP address.
The text used to identify an application is the path of the executable on
the video wall controller.
The text used to identify a scrollingtext, browser or device is the its name
and grouping path as it appears in their respective list in VuWall2.
Text text used to identify website and stream sources is their URI, which
does not need to be saved in a list beforehand.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Open Window: 1 Source: input("Camera 1");
Open Window: 2 Source: client("192.168.1.27");
Open Window: 3 Source: application("C:/Program Files/Acme/Tool.exe");
Open Window: 1 Source: input("Camera 2") Surface: named("Hallway");
Monitor : { Number }
Two numbers which represent the position of the monitor to cover with the new
window. The first is the horizontal position and the second is the vertical
position.
Result : Number
The number assigned to the newly created window. It can be used in subsequent
commands to modify the content of the window.
Examples:
Number = CreateWindow Monitor: { 3, 2 };
Open Window: Number Source: layout("Morning Scenario");
Blank = CreateWindow Monitor: { 2, 1 } Surface: named("Conference Room");
Horizontal : { Number }
Two numbers which represent the horizontal extent covered by the new window.
The first is leftmost position (included) and the second is the rightmost
position (excluded).
Vertical : { Number }
Two numbers which represent the vertical extent covered by the new window. The
first is topmost position (included) and the second is the bottommost position
(excluded).
Result : Number
The number assigned to the newly created window. It can be used in subsequent
commands to modify the content of the window.
Examples:
Number = CreateWindow Horizontal: { 0, 1920 } Vertical: { 0, 1280 };
Open Window: Number Source: layout("Morning Scenario");
Blank = CreateWindow Horizontal: { 0, 1920 } Vertical: { 0, 1280 }
Surface: named("Conference Room");
Result : ()
The command is only used for its effect on the video wall.
Examples:
CloseWindows SourceType: all;
CloseWindows SourceType: inputs;
CloseWindows; # Same as CloseWindows SourceType: all;
CloseWindows Surface: named("Crisis Room");
Note: sending VuWall2 scripts via the network API must end with a carriage return and line feed (0x0D0A).
Consult the main user's manual for connection details.
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Clear Window: 3;
Clear Window: 3 Surface: named("Crisis Room");
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Monitor : { Number }
Two numbers which represent the position of the monitor to cover with the
window. The first is the horizontal position and the second is the vertical
position.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Move Window: 3 Monitor: { 3, 2 };
Move Window: 3 Monitor: { 3, 2 } Surface: named("Crisis Room");
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Horizontal : { Number }
Two numbers which represent the horizontal extent covered by the window. The
first is leftmost position (included) and the second is the rightmost position
(excluded).
Vertical : { Number }
Two numbers which represent the vertical extent covered by the window. The
first is topmost position (included) and the second is the bottommost position
(excluded).
Result : ()
The command is only used for its effect on the video wall.
Examples:
Move Window: 2 Horizontal: { 0, 1920 } Vertical: { 0, 1280 };
Move Window: 2 Horizontal: { 0, 1920 } Vertical: { 0, 1280 }
Surface: named("Crisis Room");
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Hide Window: 1;
Hide Window: 1 Surface: named("Crisis Room");
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Show Window: 2;
Show Window: 2 Surface: named("Crisis Room")
Index : Integer
The location at which to retrieve a window number. Window ordering starts at 0
from the back of the layout to the front. Negative indices are counted from the
front of the layout.
Result : Number
The number of the window at the given Z-order location.
Examples:
BackWindow = GetWindow Index: 0;
FrontWindow = GetWindow Index: -1;
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Index : Integer
The location that the window will occupy; the window will be in front of that
many other windows. Window ordering starts at 0 from the back of the layout to
the front. Negative indices are counted from the front of the layout.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Reorder Window: 2 Index: 3;
Reorder Window: 2 Index: 3 Surface: named("Crisis Room");
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Focus Window: 4;
Focus Window: 4 Surface: named("Crisis Room");
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Close Window: 2;
Close Window: 2 Surface: named("Crisis Room");
Result : ()
The command is only used for its effect on the video wall.
Examples:
Carousel;
Carousel Sublayout: { 2 };
Carousel Surface: named("Meeting Room");
Carousel Surface: named("Conrol Room") Sublayout: { 3 };
Name : Text
The name and path of the newly saved layout.
Result : ()
The command is only used for its effect on the video wall.
Examples:
SaveCurrentLayout Name: "Temporary/Switching" Overwrite: true;
SaveCurrentLayout Name: "Snapshot" Surface: named("Conference Room");
Execute Script:
Use the Execute command to run a script that has been saved on the video wall
controller.
Script : Text
The script is identified by its name, as it appears in the Scripts list of
VuWall2.
Result : ()
The command is only used for its effect on the video wall.
Examples:
Execute Script: "Script 1";
Path : Text
The path of the executable to launch on the video wall controller.
Arguments : Text
The arguments for the program to execute.
Result : ()
The command is only used for its effect on the video wall.
Examples:
ExecuteProgram Path: "C:/Program Files (x86)/Mozilla Firefox/firefox.exe";
ExecuteProgram
Path: "C:/Program Files (x86)/Mozilla Firefox/firefox.exe"
Arguments: "www.vuwall.com";
Name : Text
The name of the transition to start.
Windows : { Number }
A comma-delimited list of numbers corresponding to windows open on the
video wall.
Result : ()
The command is only used for its effect on the video wall.
Examples:
StartTransition Name: "Transition 1" Windows: {1, 3, 5}
Surface: named("Hallway");
StartTransition Name: "Transition 2" Windows: {2, 4} Repeat: true;
Name : Text
The name of the scrolling text to open.
Window : Number
The window is identified by its number, as seen on the VuWall2 interface.
Result : ()
The command is only used for its effect on the video wall.
Examples:
OpenScrollingText Name: "Company Banner" Window: 2;
OpenScrollingText Name: "Warnings/Bear Alarm 2" Window: 1;
OpenScrollingText Name: "Company Banner" Window: 2
Surface: named("Entrance");
Provider : Text
The name of the IP Devices section in which to register the stream. If no
provider is specified then the default name IP Device will be used. You can
register a stream within a group if group and name are separated by a forward
slash "/"
URI : Text
The full URI of the RTSP stream. It must contain the protocol name, username,
password, host name, port number and query string.
Result : ()
The command is only used for its effect on the list of IP devices.
Examples:
RegisterStream URI: "rtsp://192.168.1.155:443/live.sdp";
RegisterStream Provider: "Parking camera" URI: "rtsp://admin:[email protected]:443/hdv";
RegisterStream Provider: "Security/Parking camera" URI: "rtsp://192.168.1.157:443/live.sdp";
DeleteStream Provider:
Use the DeleteStream command delete an RTSP stream that was previously registered into
the list of IP devices, or a group of such devices.
Provider : Text
The name of the IP Devices section in which to register the stream. You can
register a stream within a group if group and name are separated by a forward
slash "/"
Result : ()
The command is only used for its effect on the list of IP devices.
Examples:
DeleteStream Provider: "Security/Parking camera;
ActivateSchedule Name:
Use the ActivateSchedule command to add the tasks of a saved schedule to the active
tasks, starting from the time of command execution for "On Demand" schedules.
Name : Text
The name of the saved schedule to activate.
Result : ()
The command is only used for its effect over time.
Examples:
ActivateSchedule Name: "Demo Schedule";
ActivateSchedule Name: "Weekend Schedule";
Name : Text
The name and path of the newly saved schedule.
Result : ()
The command is only used for its effect on scheduled tasks.
Examples:
SaveSchedules Name: "Temporary";
SaveSchedules Name: "Monday Schedule Overwrite: false;
ClearSchedules
Use the ClearSchedules command to deactivate all scheduled tasks.
Result : ()
The command is only used for its effect over time.
Examples:
ClearSchedules;
IP : Text
The IP address of the external service, in dotted quad notation.
Port : Number
The port of the external service.
Examples:
VuWallNCI = Connect IP: "127.0.0.1" Port: 50001;
VuWallNCI Send: "Clear Window: 2\n";
IP : Text
The IP address of the external service, in dotted quad notation.
Port : Number
The port of the external service.
Examples:
GraphicsCardAPI = ConnectTelnet IP: "127.0.0.1" Port: 23;
GraphicsCardAPI Send: "AddWindow \"Vuwall 2\" 100,100,2000,2000\r\n";
URL : Text
The URL of the remote HTTP service. Parameters can be included as a query
string.
Result : Text
Text body of the response from the remote service.
Examples:
RequestHTTP Method: post URL: "https://192.168.1.202/api/command/reboot"
Username: "admin" Password: "admin";
Wait Duration:
Use the Wait command to wait a specified amount of time before executing the following
commands. Can be used to synchronize with external operations.
Duration : Time
The amount of time to wait before continuing with the next commands.
Result : ()
The command is only used for its running time.
Examples:
Wait Duration: 5 seconds;
Wait Duration: 10 minutes;
Wait Duration: 1 hours;
Wait Duration: 2 days;
Wait Duration: 4 weeks;
IP: Text
The address of the Next Level Security System decoder.
Username : Text
The username to use as credentials to access the decoder.
Password : Text
The password associated with the given username to access to the decoder.
ChannelNumber: Number
The number associated with the desired channel, which must be already
configured on the decoder.
Examples:
SetNLSSChannel IP: "192.168.1.170"
Username: "admin" Password: "admin" ChannelNumber: 1;
IP: Text
The address of the Next Level Security System decoder.
Username : Text
The username to use as credentials to access the decoder.
Password : Text
The password associated with the given username to access to the decoder.
SequenceName: Text
The name associated with the desired sequence, which must be already
configured on the decoder.
Examples:
SetNLSSSequence IP: "192.168.1.170" Username: "admin"
Password: "admin" SequenceName: "Sequence 1";
IP: Text
The address of the Next Level Security System decoder.
Username : Text
The username to use as credentials to access the decoder.
Password : Text
The password associated with the given username to access to the decoder.
ViewName: Text
The name associated with the desired view, which must be already
configured on the decoder.
Examples:
SetNLSSView IP: "192.168.1.170" Username: "admin"
Password: "admin" ViewName: "View 1";