Skip to main content

Integrate using UDP

Configure your UDP integration in the Console and Desktop App

Written by Gabrielle Fanning

Configure UDP sync trigger messages in the Console

Each UDP sync message consists of three components:

  • Interactive ID: A unique identifier for the specific interactive content (e.g., DroneShow)

  • Content ID: A unique identifier for the audio or visual content (e.g., AudioClip1)

  • Play state: The action to be triggered, such as start, stop or elapsed time

See an example format below:

interactive:content:start # Start message
interactive:content:stop # Stop message
interactive:content:234545 # Elapsed time message

  1. Select UDP as your sync method.

  2. Input your Port number.
    The UDP sync trigger messages associated with each audio file in your playlist will be populated.
    In network communications, a port is a virtual endpoint that determines where data packets should be delivered. For the sync to work, both the system generating the events and the receiver (Event Sync) must be configured to use the same port number.

    1. Recommended port range: Use ports in the range of 1024 to 49151, which are designated as user or registered ports.

    2. Avoid reserved ports: Do not use ports 0 to 1023, which are reserved for system processes (e.g., port 80 for HTTP and port 443 for HTTPS) to prevent conflicts and maintain system stability.

  3. Copy the formatted messages back into your Show Control System.


Integrate with the Desktop App

  1. Configure the UDP message generator
    a. Set up the message generator to send UDP packets to the designated IP address and port where Event Sync is configured to listen.

    b. Use an Ethernet cable to connect the UDP message generator to your network switch or directly to the computer running Event Sync’s Desktop App.

  2. Check network and firewall settings
    a. Ensure that the firewall and network settings allow traffic through the configured port to prevent connectivity issues.

    b. If UDP messages aren't appearing, verify that the port number in the Event Sync Desktop App matches the system generating the events, and ensure they are broadcasting on the right network.

  1. Configure the Desktop App

    1. Start the Desktop App
      Log in using the credentials provided by Pladia.

    2. Check the connection status indicators
      The Connection status indicators on the Desktop App display the health of the three components required for Event Sync to operate correctly: all need to show green ticks for your event to work. Click here for troubleshooting guidelines.

    3. Select your Preview or Live environment
      Click here to read more about testing your event in Preview mode.

    4. Select the relevant playlist from the dropdown
      The Desktop App will show the sync method and port number configured, and number of tracks in this playlist.

      Verify these details details in the app to ensure the configuration is correct. To make any changes, return to your Event Sync Console and re-publish. If necessary, re-login to the Desktop App to reset the configuration.

    5. Activate your event
      Once you're ready to activate your event, use the Desktop App to manage your sync status.
      ​​

    6. Triggered and playing audio will be listed on the right-hand side of the Desktop App, creating an event log for visibility.

    7. Complete the show
      Once your show is complete, return the status to Inactive. This directs users back to the Landing screen and prevents further audio triggers.


Audio playback control with UDP messages

Automatic Completion

If you have multiple tracks, you can give each track a Start command. Once the audio file reaches its end, it will stop naturally. In this scenario, adding a manual "Stop" command is unnecessary.

Manual Stop Options

If your experience requires a track to end before its natural conclusion, use one of the following methods:

  • Elapsed Time Command: Set a specific timestamp to trigger a stop command automatically after a certain duration.

  • Stop Command: Use a formal Stop command to end the entire experience.

Note: Issuing a Stop command will immediately return users to the Landing screen. Only use this if the session is fully complete.

Did this answer your question?