Connect PHOTON and QLab Through UDP
Last updated
Was this helpful?
Last updated
Was this helpful?
PHOTON has the capacity to send and listen to messages written in the UDP protocol. This means that PHOTON can trigger or be triggered by other UDP compatible devices on a network.
This guide presents the steps involved into configuring QLab and PHOTON correctly so they can send basic commands to each other, such as pause and play.
The communicating computers first need to be set on the same network. For example, PHOTON’s IP address could be set at 172.17.1.11 and QLab’ IP address at 172.17.1.111, both having subnet mask set to 255.255.255.0.
Once the network settings are ok for both parties, go to the OSC tab of the preferences menu [CMD+,] in QLab.
In an empty patch slot, add PHOTON as a destination and correctly set the IP address and port.
The default communication port to send UDP commands to PHOTON is 55503.
Next, in PHOTON, configure the destination you want to send cues to. Open to the I\O manager [ALT+i] and click of the Network Protocol tab.
The cue must match QLab’s IP address and communication port.
The default port to send UDP to QLab is 53535.
The syntax QLab is using. If the user wishes to launch cue number1 the syntax should be as follow: /cue/{number}/start. The same applies for a stop except you use the Stop command; /cue/{number}/stop. It is important to add a space before the slash in the command line for QLab.
To send cues from Qlab to PHOTON, the user needs to drop an OSC cue in the cue list. Then, in the Settings tab, at the bottom of the workspace, the destination needs to be set to PHOTON. The message type should be changed to Raw UDP string (instead of OSC). Finally, the proper command shall be entered in the message box with the correct syntax.
This portion of the step-by-step shows how to use PHOTON to trigger an audio cue in QLab.
Create a new audio cue. Select {Cues > Audio} or press [Cmd+1].
Make sure the Basics tab is selected.
Enter a cue Number in the Number field.
Select an audio file as the cue Target.
Open the I/O Manager module. Select {System > I/O Manager} or press [Alt+I].
Select the Network Protocol tab.
Add a new message by clicking on the [+] button.
Select UDP as Message type.
Configure the IP address and port of the computer running QLab. The default communication port to send UDP commands to QLab is 53535.
Enter the message to trigger a cue in QLab. To start a cue : /cue/{number}/start
Press on the [Send] button
To create a Send UDP cue on the Timeline, open the Cue Editor module. Select {Show > Cue Editor} or press [Alt+Q].
To view the full cue list, select {View > View Full}.
Create a new cue by clicking on the [+] button.
Click on the [Record] button to record your action.
Navigate back to the I/O Manager module. Select {System > I/O Manager} or press [Alt+I].
Click on the [Send] button.
Navigate back to the Cue Editor module. Select {Show > Cue Editor} or press [Alt+Q].
Click on the [Record] button again to stop recording your action.
Open the Timeline module. Select {Show>Timeline} or press [Alt+T].
Create a new Cue Clip on the Timeline. Right-click on a layer track to open a contextual menu and select {Add Cue} or press [Ctrl+U].
Navigate to Cue Properties and select your Cue as its source.
Click-drag the Playhead to position it before the Cue Clip on the Timeline then press the [spacebar] to resume playback.
The Cue will be executed when the Playhead intersects the Cue Clip.
This portion of the step-by-step shows how to use QLab to send a UDP message to PHOTON.
Open the Settings menu. Click on the gear icon at the lower right corner of the window.
Select the Network tab.
Add a new network patch. Click on the [New Patch] button or press [CMD+N]
Add PHOTON as a destination and set its IP address and port. The default communication port to send UDP commands to PHOTON is 55503.
Add a new network cue. Select {Cues > Network} or press [CMD+8].
In the Settings tab, enter PHOTON’s IP address and port as the destination.
Select UDP message from the Type dropdown menu.
Entered the command in the message box with the correct syntax.
In this example, we will use QLab Network Cue to trigger Cue ID 1 set in Photon. Enter <photon> CUE_EXEC_ID 1 </photon> in the message box.
Open the Timeline module. Select {Show>Timeline} or press [Alt+T].
Locate Regions Editing in the Timeline window and click on the [+] button to create a new Region.
Set the In-point at 00:00:00:00.
Set Out-point at 00:02:00:00.
Open the Cue Editor module. Select {Show>Cue Editor} or press [Alt+Q].
To view the full cue list, select {View > View Full}.
Create a new cue. Click on the [+] button.
Set the Cue ID to 1.
Press the [Record] button.
Navigate back to the Timeline module. Select {Show>Timeline} or press [Alt+T].
Select region 1.
Navigate back to the Cue Editor module. Select {Show > Cue Editor} or press [Alt+Q].
Click on the [Record] button again to stop recording your action.
To make sure the communication between QLab and Photon is set up correctly, open the Logs module. Select {System > Tools > Monitoring > Logs} or press [Alt+L].
Select the network cue in your workspace.
Select the Settings tab.
Click on the [Send] button.
If the communication between computers and your UDP message string are set up correctly the Logs will display: SHOW CONTROL : {your UDP message}.