Navigation
API > API/Plugins > API/Plugins/RemoteControlProtocolDMX
DMX protocol entity for remote control binding
| Name | FRemoteControlDMXProtocolEntity |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControlProtocolDMX/Source/RemoteControlProtocolDMX/Public/RemoteControlProtocolDMX.h |
| Include Path | #include "RemoteControlProtocolDMX.h" |
Syntax
USTRUCT ()
struct FRemoteControlDMXProtocolEntity : public FRemoteControlProtocolEntity
Inheritance Hierarchy
- FRemoteControlProtocolEntity → FRemoteControlDMXProtocolEntity
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ExtraSetting | FRemoteControlDMXProtocolEntityExtraSetting | Extra protocol settings | RemoteControlProtocolDMX.h |
|
| RangeInputTemplate | uint32 | DMX range input property template, used for binding. | RemoteControlProtocolDMX.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BindDMX() |
Binds this entity to DMX | RemoteControlProtocolDMX.h | |
uint8 GetNumDMXChannels() |
Returns the num DMX channels this setting spans | RemoteControlProtocolDMX.h | |
virtual const FString & GetRangePropertyMaxValue() |
RemoteControlProtocolDMX.h | ||
virtual FName GetRangePropertyName() |
RemoteControlProtocolDMX.h | ||
virtual uint8 GetRangePropertySize() |
RemoteControlProtocolDMX.h | ||
void Invalidate() |
Invalidates this entity. The entity will be updated on the next tick. | RemoteControlProtocolDMX.h | |
void PostSerialize
(
const FArchive& Ar |
Called after the struct is serialized | RemoteControlProtocolDMX.h | |
bool Serialize
(
FArchive& Ar |
Called when the struct is serialized | RemoteControlProtocolDMX.h | |
void SetAttributeName
(
const FName& AttributeName |
Sets the attribute name of the entity. | RemoteControlProtocolDMX.h | |
void UnbindDMX() |
Unbinds this entity from DMX | RemoteControlProtocolDMX.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TArray< TSharedRef< TStructOnScope< FRemoteControlProtocolEntity > > > FindEntitiesByProperty
(
const TSharedRef< FRemoteControlProperty >& Property |
Finds remote control protocol DMX entities used by the specified property | RemoteControlProtocolDMX.h | |
static TArray< TSharedRef< TStructOnScope< FRemoteControlProtocolEntity > > > GetAllDMXProtocolEntitiesInPreset
(
URemoteControlPreset* Preset |
Finds remote control protocol DMX entities used by the specified property | RemoteControlProtocolDMX.h | |
static URemoteControlDMXLibraryProxy * GetDMXLibraryProxy
(
URemoteControlPreset* Preset |
Gets or creates the DMX library proxy | RemoteControlProtocolDMX.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseDefaultInputPort_DEPRECATED | bool | RemoteControlProtocolDMX.h |
|
|
| bUseLSB_DEPRECATED | bool | RemoteControlProtocolDMX.h |
|
|
| DataType_DEPRECATED | EDMXFixtureSignalFormat | RemoteControlProtocolDMX.h |
|
|
| InputPortId_DEPRECATED | FGuid | RemoteControlProtocolDMX.h |
|
|
| Universe_DEPRECATED | int32 | DEPRECATED MEMBERS. | RemoteControlProtocolDMX.h |
|