Navigation
API > API/Plugins > API/Plugins/RemoteControlProtocolDMX
References
| Module | RemoteControlProtocolDMX |
| Header | /Engine/Plugins/VirtualProduction/RemoteControlProtocolDMX/Source/RemoteControlProtocolDMX/Public/RemoteControlProtocolDMX.h |
| Include | #include "RemoteControlProtocolDMX.h" |
Syntax
USTRUCT ()
struct FRemoteControlDMXProtocolEntityExtraSetting
Remarks
An inner struct holding DMX specific data. Useful to have type customization for the struct.
Variables
| Type | Name | Description | |
|---|---|---|---|
  |
FName | AttributeName | The attribute name of this binding |
  |
bool | bIsPrimaryPatch | If true, this entity defines the patch and its fixture type. |
   |
bool | bRequestClearPatch | If true clears the patch instead of generating one when the outer DMX entity is invalidated |
   |
bool | bUseLSB | Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number. |
   |
EDMXFixtureSignalFormat | DataType | Defines the used number of channels (bytes) |
  |
FDMXEntityFixturePatchRef | FixturePatchReference | Reference to the fixture patch this binding uses |
  |
int32 | FunctionIndex | The index of the DMX function to receive |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
PRAGMA_DISABLE_DEPRECATION_WARNINGS | Workaround for clang deprecation warnings for deprecated PackageGuid member in implicit constructors | |
 |
|||
 |
Operators
| Type | Name | Description | |
|---|---|---|---|
 |
FRemoteControlDMXProtocolEntityExtraSetting & | ||
 |
FRemoteControlDMXProtocolEntityExtraSetting & |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
  |
bool | bUseDefaultInputPort_DEPRECATED | If set to true, uses the default input port set in Remote Control Protocol project settings |
  |
FGuid | InputPortId_DEPRECATED | Reference of an input DMX port id |
  |
int32 | StartingChannel_DEPRECATED | The starting channel of this entity. -1 in auto patch mode. |
  |
int32 | Universe_DEPRECATED | The DMX universe of this entity. -1 in auto patch mode. |