FDMXPortManager

Navigation

API > API/Plugins > API/Plugins/DMXProtocol > API/Plugins/DMXProtocol/IO

References

Syntax

class FDMXPortManager  
Copy full snippet

class FDMXPortManager

Remarks

Manager for all DMX ports. Exposes available input and output ports anywhere.

A) Overview of the IO System

1. Definition of Ports in Project Settings:

DMX Protocol Settings (the DMX Project Settings) holds two arrays of DMX Input Port Configs resp. DMX Output Port Configs. This is where ports are defined.

Port Manager automatically creates DMXInputPortS and DMXOutputPortS that match these settings. Generally this is self-contained and does not need any user code.

Note: Applications that want to offer dynamic ports should specify a fixed number of ports in project settings, e.g. 8, 16 ports and work with these at runtime. (While it is possible to mutate the protocol settings at runtime and create ports from that via FDMXPortManager.Get()::UpdateFromProtocolSettings(), ports created alike are not available in blueprints as port references, hence this approach is disfavored in most situations.)

1. Acquire a DMXInputPort or DMXOutputPort:

Get all input ports or all output ports available via the Port Manager's GetInputPorts and GetOutputPorts methods. Alternatively use the Editor-Only SDMXPortSelector widget to select a port from available ports.

1. Receive DMX in an object:

a) Latest (frame time relevant) data on the Game-Thread:

• Call the port's GameThreadGetDMXSignal method to get a DMX Signal of a local universe.

b) All data on any thread:

• Create an instance of DMXRawListener. Use its constructor to specify which port it should use.
• Use DequeueSignal to receive DMX.

Note: This applies for both input and output ports. This is to provide loopback functionality for outputs. Generally you want to listen to input and output ports, not just the inputs.

Note: GameThreadGetDMXSignal is the right method to use for almost any use-case. DMXRawListener is only useful where the latest data isn't sufficient, e.g. to record all incoming data in Sequencer. DMXRawListener is thread-safe, but may stall the engine when used in the game-thread due to the possibly infinite work load it leaves to the user.

1. Send DMX from your object:

Use the DMXOutputPort's SendDMX method to send DMX.

Variables

Constructors

Destructors

Functions

Operators

Constants