List of Commands

The table below shows the available commands. Some are explained in greater depth on the following pages.

authenticate
This command is required for the display software prior to issuing any other commands except the ping command. While this command is accepted by the production software, it is not required. See "Authentication" above for details.

load (production software version)
Loads a show by name. The name is specified as a quoted string containing the full path to the file. The use of backslash characters in Windows path names conflicts with the use of the backslash as an escape character in this protocol. Either double the backslash characters, or use forward slashes instead (as shown in this example):

load "C:/Samples/ExampleShow.watch"

NOTE: When using this load command, the production software will automatically go online after loading the show.

If desired, you can add a numeric parameter to override the conditional layer settings of the show being loaded. For example, to enable condition 1 and 2 only:

load "C:/Samples/ExampleShow.watch" 3

The number is a sum of the decimal numbers corresponding to each desired condition, as shown in the table below.

The last optional parameter is a boolean controlling whether the production software will go online or not, after loading the show (default value is true):

load "C:/Samples/ExampleShow.watch" 3 false

loads the specified show and sets its layer conditions, but remains offline.

load (display software version)
Load a complete show specification from a local file associated with the show name specified by the first parameter. Busy feedback may be sent to the host while loading, informing the host about the progress. If errors occur, "Error" feedback is sent. Finally, a Ready feedback message is sent, regardless of whether any error occurred.

load "Phantom" true true 3

NOTE: You can not specify a folder path to the show. The show must be present in the “Shows” folder, located in the same folder as the WATCHOUT display software.

online
This command applies to the production software only. It takes a single boolean parameter, specifying whether to go online (true) or offline (false). Note that the load command also goes online unless explicitly disabled by the optional parameter.

gotoTime
Jump to the specified time position along the timeline.

gotoTime 5000

gotoControlCue
Jump to the time of specified Control cue. If the optional “reverse only” boolean is set to true, it searches for the Control cue only back in time from the current time position. Otherwise it searches first forward then reverse.

The command does not change the run mode of the timeline. If the specified cue is not found, the timeline’s state will not change, and a runtime error message to this effect will be returned.

gotoControlCue "William" true

enableLayerCond
Change the set of enabled layer conditions. While the layer conditions can be specified as part of the load command, this separate command allows the layer conditions to be changed without loading another show. The command takes a single, mandatory <uint> parameter with the same interpretation as the conditional layers parameter of the load command.

setLogoString
This command applies to the display software only. Display its single string parameter next to the WATCHOUT logo, when shown on screen.

standBy
Enter/exit standby mode. In standby, the display and sound is muted, or media on standby layers – if

any – is performed . This mode can be entered/exited smoothly, by specifying a fade rate.

standBy true 1000

Fade out sound and image over one second and enter standby mode. If any standby layer is available, its media is performed instead.

getStatus
Get the current status of the WATCHOUT cluster conductor.

getStatusReply "WO2Launch" false 0 true true false 122 true

Responds with a Reply with the following parameters:

delay
Wait the number of milliseconds specified by the parameter before performing the next command in the file.

NOTE: Performed only when used in a command file. Applies to display software only.

wait
This command applies to the display software only. Wait for the display cluster to become fully established before proceeding with the next command in the file. Waits at most the number of milliseconds specified by the parameter.

NOTE: Performed only when used in a command file.

setInput
Sets the value of a named input (see “Inputs”).

setInput "uno" 0.5

The value is generally in the range 0 through 1, but may be extended to cover a wider range using the Limit setting of the Generic Input .

By prefixing the value with a plus or minus sign, you can adjust the value incrementally relative to its current setting. This example increases the value of the input by 0.1:

setInput "uno" +0.1

A third, optional parameter allows you to specify a transition rate, causing any property controlled by the input to change gradually to the specified target value. This parameter is specified in milliseconds.

NOTE: While you would typically use this command to set the value of a Generic Input, you may use it to set the value for any input. If data is also provided by a MIDI or DMX-512 source, the latest data will take precedence.

setInputs
This command is functionally equivalent to the setInput command above, but allows you to set multiple inputs with a single command. This is useful in the following cases:

• When it is important that several inputs are set simultaneously, because their values are used in an interdependent way. If you use two separate setInput commands, it is possible that the commands will not be executed on the same frame.
• When setting a large number of inputs, as it is more efficient to handle this with a single command than a number of separate commands, allowing you to set a larger number of values within a single frame.

The first parameter is the transition rate, in mS. Subsequent data must be provided in groups of two parameters:

setInputs 100 "Yo" 0.8 "Man" 0.5 "Stereo" 0 "Left" 0 "Top" 0.5

Ramps the named inputs to the specified values over 100 mS.

setInputs 0 "Yo" +0.1 "Man" -0.5

Instantly increase the Input named ”Yo” by the value 0.1 and decrease “Man” by 0.5.

serialPort
Applies to display software only. Opens or closes a serial port for protocol commands, setting its parameters.

serialPort true "COM1"

HINT: For serial-only control, put the serialPort command into a text file, and use the file based control feature to perform the commands in this file (see “File-based Control”).

timecodeMode
Applies to the display software only. (Use the Timecode options in the Preferences dialog box to use timecode with the production software.)

Controls the LT C timecode receiver of the display computer. The timecode receiver is initially off. When turned on, incoming timecode will control the presentation as if using the run, halt and goto-Time commands. Furthermore, while playing, the presentation will be synchronized to the timecode.

timecodeMode 2 "-1:00:00"

Avoid using the auto-detect mode whenever possible. Instead, specify the expected timecode format explicitly. Specifically, the SMPTE 30 (”B&W”) format can not be detected automatically.

Use the separate Timecode Tester application to verify proper timecode reception, and to choose the appropriate input connector to use for the timecode signal .

HINT: For stand-alone use of the timecode control feature, put this command into a text file, as described under "File-based Control".

NOTE: Timecode control of the display computer can’t be used while the production software is online. In this case, use the corresponding feature of the production software instead.

hitTest
Get information of the frontmost, visible and interactive media cue that intersects the 2D point given by the two parameters (in stage pixels).

hitTest 1200 250Reply true "Image01" 1154 212 0

To make a media cue interactive it needs an interaction name specified, which can be done under the advanced tab of the media cue dialog see (see “Advanced Cue Specifications”). The reply message contains, among other things, this interaction name, if an interactive media cue was hit.