Navigation
API > API/Plugins > API/Plugins/RemoteControlProtocol
Inheritance Hierarchy
- FSharedFromThisBase
- TSharedFromThis
- IRemoteControlProtocol
- FRemoteControlProtocol
- FRemoteControlProtocolDMX
- FRemoteControlProtocolMIDI
References
| Module | RemoteControlProtocol |
| Header | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlProtocol/Public/RemoteControlProtocol.h |
| Include | #include "RemoteControlProtocol.h" |
Syntax
class FRemoteControlProtocol : public IRemoteControlProtocol
Remarks
Base class implementation for remote control protocol
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FName | ProtocolName | Current Protocol Name |
 |
TSet< FProtocolColumnPtr > | RegisteredColumns | Holds a set of protocol specific columns. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FRemoteControlProtocol
(
FName InProtocolName |
Destructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
TFunction< bool(FRemoteControlProtocolEntityWeakPtr InProtocolEntityWeakPtr)> | CreateProtocolComparator
(
FGuid InPropertyId |
Helper function for comparing the Protocol Entity with given Property Id inside returned lambda |
  |
void | Populates protocol specific columns. |
Overridden from IRemoteControlProtocol
| Type | Name | Description | |
|---|---|---|---|
   |
FRemoteControlProtocolEntityPtr | CreateNewProtocolEntity
(
FProperty* InProperty, |
Add the new protocol entity. That is created based on protocol specific script struct |
   |
FProtocolColumnPtr | GetRegisteredColumn
(
const FName& ByColumnName |
Retrieves the column reference by its name. |
  |
void | GetRegisteredColumns
(
TSet< FName >& OutColumns |
Retrieves the set of columns registered by this protocol. |
  |
void | Init () |
Add custom initializing of the protocol |
  |
void | OnEndFrame () |
Build to core engine delegated and called at the end of a frame |
  |
void | QueueValue
(
const FRemoteControlProtocolEntityPtr InProtocolEntity, |
Queue protocol entity and value to apply for the protocol It stores only unique tick entities which should be apply next frame. |