Event Listener

Navigation:  Widget Designer > Devices >

Event Listener

prev main next

Navigation:  Widget Designer > Devices >

Event Listener

prev main next

Please wait. Due to its content this page might take a while to load...

The Configuration dialog also provides Event Listeners which offer a simple way of listening to triggers from the connected devices.
Very similar to the Action Script node, you are able to define a trigger for specific actions or events from the respective device. The number and type of events depend on the device and range from simple value changes to shutdown events.
Note that this is only available in the licensed Widget Designer edition, not the Free version.

The Event Listener shows only events from devices that were added to the Configuration dialog before. The following devices offer events:
Barco devices
Christie devices
Fader Extension Events
Jog/Shuttle Events
Lightware Events
Phidgets devices
PowerPoint Events
TCP Client Events
UDP Client Events
UDP Server&Client Events
 

How to Add an Event Listener

To add an Event Listener, open the Devices menu and select "Event Listener > Create Event Listener". This opens the Configuration dialog. Alternatively, you can add a new Event Listener in the Configuration dialog with the "+" button.

How to Configure an Event Listener

On the right side, you can enter the event's name, device, event and script. Click the "Apply" button to save any changes done in the Configuration dialog. You can also use the shortcut [Ctrl + Enter] to do so.

The Name is the unique identifier for this Event Listener. It helps to keep track what you have programmed where. The general rules for naming objects apply here as well (only letters, numbers and underscore are allowed, the first symbol must be a letter).

The "Enable" check box is ticked per default. Uncheck it to stop the Event Listener (temporarily). You can also program this, e.g. to a CustomScript button, as described further down.

The "Device" drop-down lists all devices that were added to the Configuration and offer events. Choose one and the "Event" drop-down will offer all events referring to that device.

The "Event" specifies the trigger, i.e. when to execute the following script. Select one from the drop-down list.

The scripting field can be filled with commands that should be executed when the event happens. You could for example write: Label1.Text = "yourMessage"

Some events offer "Parameters". When choosing the event "LayoutApplied" from the device Christie_Terra1 for example, you will see that it lists some parameter names on top of the scripting field, such as "layout (String)" and "displayArray (String)". This means that this specific event provides these values as local variables to be used in the script. For instance, you can write "Label1.Text = layout" and the Label will instantly show the name of the Layout which was just applied, whenever this occurs.

How to Use Event Listeners in Regular Scripting

Each Event Listener can also be addressed via scripting for en- and disabling the listener.

EventListener1.Enable
This enables the Event Listener with the name "EventListener1", i.e. the "Enable" check box in the Configuration dialog is checked.

EventListener1.Disable
This disables the Event Listener with the name "EventListener1", i.e. the "Enable" check box in the Configuration dialog is not checked.

DebugMessage(EventListener1.IsEnabled)
or
v_bool = EventListener1.IsEnabled
This returns "true" if the Event Listener with the name "EventListener1" is enabled, i.e. the "Enable" check box in the Configuration dialog is checked and "false" if it is not.