Navigation
API > API/Plugins > API/Plugins/DMXProtocol
Helper to determine how DMX should be communicated (loopback, send)
| Name | FDMXOutputPortCommunicationDeterminator |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXOutputPort.h |
| Include Path | #include "IO/DMXOutputPort.h" |
Syntax
struct FDMXOutputPortCommunicationDeterminator
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDMXOutputPortCommunicationDeterminator() |
IO/DMXOutputPort.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasValidSender | TAtomic< bool > | IO/DMXOutputPort.h | ||
| bLoopbackToEngine | TAtomic< bool > | IO/DMXOutputPort.h | ||
| bReceiveEnabled | TAtomic< bool > | IO/DMXOutputPort.h | ||
| bSendEnabled | TAtomic< bool > | IO/DMXOutputPort.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsLoopbackToEngineEnabled() |
Returns true if loopback to engine is enabled (only true if loopback to engine is set enabled) | IO/DMXOutputPort.h | |
bool IsSendDMXEnabled() |
Determinates if send dmx is enabled | IO/DMXOutputPort.h | |
bool NeedsLoopbackToEngine() |
Determinates if loopback to engine is needed (may be true even is loopback to engine is not enabled) | IO/DMXOutputPort.h | |
bool NeedsSendDMX() |
Determinates if dmx needs to be sent (may be false even if send is enabled) | IO/DMXOutputPort.h | |
void SetHasValidSender
(
bool bInHasValidSender |
Sets if there is a valid sender obj | IO/DMXOutputPort.h | |
void SetLoopbackToEngine
(
bool bInLoopbackToEngine |
Set the variable from the port config in project settings | IO/DMXOutputPort.h | |
void SetReceiveEnabled
(
bool bInReceiveEnabled |
Sets if receive is enabled | IO/DMXOutputPort.h | |
void SetSendEnabled
(
bool bInSendEnabled |
Sets if send is enabled | IO/DMXOutputPort.h |