Who is this article relevant to?
This article is for anyone who wants to learn about the UDP Trigger function inside Rokoko Studio
Which plans is this article relevant for?
Pro Enterprise
Introduction
Two-way UDP communication can be used to trigger the start or stop of recording from an external source or to send recording notifications from Rokoko Studio.
User Guide
To activate trigger messages in Studio from settings, follow these steps:
- Click on the "Studio Settings" button in the User account panel.
- Under the "Trigger Messages" section, check the box next to "Send Messages" or / and “Receive Messages.
Once you have completed these steps, trigger messages will be activated in Studio.
Trigger Message Settings
- Port: This is the port used to receive messages. To send messages, the port number +1 will be used.
- Send Messages: Define whether Studio should send recording notifications.
- Receive Messages: Define whether Studio should receive recording notifications.
Message Format
There are 2 possible notifications to send or receive - start and stop recording.
A notification has an XML based format
Start recording message
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<CaptureStart>
<Name VALUE="RemoteTriggerTest_take01"/>
<TimeCode VALUE="00:00:00:00"/>
<PacketID VALUE="0"/>
<ProcessID VALUE="optional process id" />
</CaptureStart>
Stop recording message
<?xml version="1.0" encoding="utf-8"?>
<CaptureStop>
<Name VALUE="TakeName" />
<TimeCode VALUE="00:00:00:00" />
<SetActiveClip VALUE="False"/>
<ProcessID VALUE="optional process id" />
</CaptureStop>
The following parameters are used:
- Name - Specifies the name of the new clip.
- TimeCode - In SMPTE format, this parameter provides values that can be used to align the start recording clip time and stop recording value for the entire clip. This includes the start time offset and duration. Use "00:00:00:00" to indicate that the timecode will not be used.
- SetActiveClip - Determines whether to enter isolation mode (clip editing mode) or continue in live mode.
- ProcessID - Used to verify the owner of the package to avoid reacting to self-broadcasted packages.
Integrations
Test Python Scripts
Test Python scripts to communicate with trigger messages.
Peel Capture
PeelCapture controls recording devices on a motion capture or virtual production shoot.
UE Switchboard
Switchboard is a Python application for controlling multiple remote devices
A Video can be found here
The Source code of the device can be found here