Contact Us
Contact Us

CATEGORIES

IN THIS ARTICLE

    PIXERA Hardware

    All essentials for PIXERA hardware—setup, specs, and integration

    PIXERA Software

    Your central hub for everything related to PIXERA—guides, tools, and workflows in one place

    PIXERA Control

    Everything about Pixera Control

    PIXERA Hub

    Knowledge about Pixera Hub

    Whoops…Nothing found

    Try other keywords in your search

    Back to home page   or   Open a ticket

    CATEGORIES

    IN THIS ARTICLE

      API Outputs

       4 Minutes

       0 Likes

       2 Views

      PIXERA offers four configurable Native API outputs for sending commands and data to external systems. Outputs can be triggered from timeline cues or used for DMX output.

      This guide explains the Out section in Settings > API, including the difference between TCP and UDP, how to configure an output, and how to send a command from a cue.

      API Output Setup

      Open Settings > API and expand Out. Select Output 1, Output 2, Output 3, or Output 4 and configure its protocol.

      Setting Description
      Protocol Defines how the output transports or processes data.
      Destination IP The receiving system's address for UDP output. This field is unavailable for TCP.
      Adapter Selects the local network adapter used by this output. Use Selected Default uses the Output Network Adapter setting.
      Port The local listening port for TCP, or the receiver's destination port for UDP. A network output with port 0 is disabled.
      Mute Stops data transmission from the network output. Clear this checkbox before testing.

      The adapter is the network interface on the PIXERA computer. The destination IP is the address of the receiving system. These settings have different purposes.

      Warning

      Planned Deprecation Local Javascript, Plain Binary/TCP, and Plain Binary/UDP are still available in the current version but are planned for deprecation and removal. Use PIXERA Control for workflows that rely on these options.

       

      Available Protocols

      Protocol Operation Typical use
      Plain String/TCP Sends text through established TCP client connections. Text commands to systems that connect to PIXERA.
      Plain String/UDP Sends text to a destination IP and port. Text commands to an external UDP receiver.
      Art-Net Sends DMX data over UDP. Default port: 6454. Patched timeline or layer output.
      sACN Sends DMX data over UDP. Default port: 5568. Patched timeline or layer output.

      Tip

      Selecting a protocol configures the output. Data is sent when a cue command or a configured output workflow uses it.

       

      TCP Output

      For Plain String/TCP, PIXERA listens for incoming TCP connections. The external system must connect to the selected adapter's IP address and the output's configured port.

      1. External system connects to PIXERA IP : Output Port
2. PIXERA sends output data over that connection

      Why Is Destination IP Unavailable?

      The API output operates as a TCP server. The remote client's connection determines where the data is sent, so no destination IP is configured in the output settings. The field may appear empty or disabled.

      If several clients are connected to the same output, a normal output send transmits the data to all of them. If no client is connected, there is no connected recipient for the command.

      Example: Plain String/TCP

      1. Set Output 1 to Plain String/TCP.
      2. Select the local Adapter that the receiving system can reach.
      3. Set Port to an unused local port, for example 15000.
      4. Clear Mute.
      5. Configure the receiving application as a TCP client and connect it to PIXERA, for example 192.168.10.10:15000.
      6. Send a cue command through Output 1.

      Here, 192.168.10.10 is the example PIXERA IP address. Replace it with the address of the selected adapter.

      UDP Output

      For Plain String/UDP, PIXERA sends data directly to the configured Destination IP and Port. The receiver does not need to establish a connection to PIXERA first.

      PIXERA Output Adapter --> Receiver Destination IP : Port

      Example: Plain String/UDP

      1. Set Output 1 to Plain String/UDP.
      2. Enter the receiving system's IP, for example 192.168.10.20.
      3. Select the local Adapter connected to that network.
      4. Enter the port on which the receiver listens, for example 15000.
      5. Clear Mute and send a cue command through Output 1.

      The address and port in this example must be replaced with the receiver's settings. UDP does not confirm that the receiver received or executed a command.

      Send a Command from a Cue

      1. Configure a Plain String/TCP or Plain String/UDP output in Settings > API > Out.
      2. Create or select a timeline cue.
      3. Open Network Command in the cue inspector.
      4. Set API Output to the configured output.
      5. Enter the command in Data.
      6. Apply the editor changes, using Apply where shown.
      7. Click Send Command to test the command immediately.

      By default, the command executes when the nowpointer enters the cue. For cue types that offer Apply on Leave, enabling that option changes execution to when the cue is left.

      Plain String Data

      Enter the text required by the receiving system, for example:

      Hello World

      This is an illustrative test payload. Use the command syntax required by your device.

      Plain String outputs send text without adding a PIXERA API header or an automatic command terminator. Cue Data is processed line by line: empty lines are skipped and the newline separating lines is not sent as part of the command. Pressing Enter in the editor therefore does not append a line-feed terminator to a command.

      If the receiver requires explicit terminator bytes or binary commands, use a suitable PIXERA Control module to format and send the data. TCP transports a byte stream, so the receiver must identify command boundaries using its own protocol.

      Art-Net and sACN Output

      Art-Net and sACN outputs transport DMX data generated by PIXERA's output patching.

      1. Select Art-Net or sACN for an API output.
      2. Configure the local adapter and destination address for the receiving system.
      3. Use port 6454 for Art-Net or 5568 for sACN, unless the receiving setup requires another value.
      4. Patch the required timeline or data-layer parameters to DMX channels and universes.
      5. Assign the configured API output to the corresponding timeline or layer output workflow.

      For Art-Net broadcast, use the broadcast address appropriate to the selected adapter's subnet. Configuring an output alone does not create a DMX patch.

      See Timeline Output Patching Artnet / sACN DMX for the patching workflow.

      Troubleshooting

      Issue What to check
      Destination IP is empty or cannot be edited For TCP outputs this is expected. Connect the receiver to PIXERA's IP and the output's listening port.
      TCP output sends no data Check that a client is connected before triggering the command. Confirm the local adapter, listening port, firewall settings, and Mute state.
      UDP output is not received Confirm the destination IP and receiver's listening port. Check the selected adapter, network routing, receiver, firewall settings, and Mute state.
      Output is disabled Set a nonzero port for a network protocol. Clear Mute.
      Command arrives but the device does not respond Check the device's command syntax, text format and required terminators.
      Cue does not send the expected command Confirm the selected API Output, saved Data, and Apply on Leave setting where available. Test with Send Command.
      Art-Net or sACN sends no expected values Check the output assignment, DMX patch, universe, channel addresses, and destination.

      Use Show Network Activity in the API settings to inspect traffic. Tx Bytes indicates sent data and Rx Bytes indicates received data. Traffic counters help identify activity; they do not confirm that an external device executed the command. See the API troubleshooting example.

      API Access, Heartbeat, and Cue Commands

      The API settings contain separate groups for different workflows:

      • In configures access for external applications controlling PIXERA.
      • Heartbeat configures periodic system announcements.
      • Out configures the four outputs described in this guide.

      The pixc option in a cue's API Output selector provides another workflow for invoking Control actions and supported API commands. See Cue Network Command (pixc).

      PIXERA 26.2  | 19. October 2026 | J.B.

      Was this article helpful?