Navigation
API > API/Plugins > API/Plugins/DMXProtocol > API/Plugins/DMXProtocol/IO
Inheritance Hierarchy
- FDMXPort
- FRunnable
- FSingleThreadRunnable
- FDMXOutputPort
References
| Module | DMXProtocol |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXOutputPort.h |
| Include | #include "IO/DMXOutputPort.h" |
Syntax
class FDMXOutputPort :
public FDMXPort ,
public FRunnable ,
public FSingleThreadRunnable
Remarks
Higher level abstraction of a DMX input hiding networking specific and protocol specific complexity. Ment to be constructed by DMXPortManger only.
Use SendDMX method to send DMX.
To loopback outputs, refer to DMXRawListener.
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | ClearBuffers () |
Clears all buffers |
  |
FDMXOutputPortSharedRef | CreateFromConfig
(
FDMXOutputPortConfig& OutputPortConfig |
Creates an output port tied to a specific config. |
 |
bool | GameThreadGetDMXSignal
(
int32 LocalUniverseID, |
Game-Thread only: Gets the last signal received in specified local universe. |
 |
bool | GameThreadGetDMXSignalFromRemoteUniverse
(
FDMXSignalSharedPtr& OutDMXSignal, |
DEPRECATED 4.27. Gets the DMX signal from an extern (remote) Universe ID. |
  |
double | Returns the output port's delay in seconds | |
  |
TArray< FString > | Returns the Destination Addresses | |
  |
FDMXOutputPortConfig | Creates a dmx output port config that corresponds to the port | |
 |
void | Called when the DMX send rate changed | |
 |
void | OnSetReceiveDMXEnabled
(
bool bEnabled |
Called to set if DMX should be enabled |
 |
void | OnSetSendDMXEnabled
(
bool bEnabled |
Called to set if DMX should be enabled |
 |
void | Updates the thread, sending DMX | |
 |
void | Sends DMX over the port | |
 |
void | SendDMXToRemoteUniverse
(
const TMap< int32, uint8 >& ChannelToValueMap, |
DEPRECATED 4.27. |
 |
void | UpdateFromConfig
(
FDMXOutputPortConfig& OutputPortConfig, |
Updates the Port to use the config of the OutputPortConfig. Makes the config valid if it's invalid. |
Overridden from FDMXPort
| Type | Name | Description | |
|---|---|---|---|
  |
void | AddRawListener
(
TSharedRef< FDMXRawListener > InRawListener |
Adds a Raw Listener that receives all raw signals received on this port. |
   |
const FGuid & | GetPortGuid () |
Returns the Guid of the Port |
   |
bool | IsRegistered () |
~Begin DMXPort Interface declaration |
  |
bool | Register () |
Registers the port with its protocol. Returns true if successfully registered |
  |
void | RemoveRawListener
(
TSharedRef< FDMXRawListener > InRawListener |
Removes the Raw Listener from the port. Should not be used directly, instead see DMXRawListener. |
  |
void | Unregister () |
Unregisteres the port if it was registered with its protocol |
Overridden from FRunnable
| Type | Name | Description | |
|---|---|---|---|
  |
void | Exit () |
Exits the runnable object. |
  |
FSingleThreadRunnable * | Gets single thread interface pointer used for ticking this runnable when multi-threading is disabled. | |
  |
bool | Init () |
Initializes the runnable object. |
  |
uint32 | Run () |
Runs the runnable object. |
  |
void | Stop () |
Stops the runnable object.This is called if a thread is requested to terminate early. |
Overridden from FSingleThreadRunnable
| Type | Name | Description | |
|---|---|---|---|
  |
void | Tick () |
Tick function. |