Navigation
API > API/Plugins > API/Plugins/RemoteControlProtocol
Inheritance Hierarchy
- TSharedFromThis
- IRemoteControlProtocol
- FRemoteControlProtocol
- FRemoteControlProtocolDMX
- FRemoteControlProtocolMIDI
References
| Module | RemoteControlProtocol |
| Header | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlProtocol/Public/IRemoteControlProtocol.h |
| Include | #include "IRemoteControlProtocol.h" |
Syntax
class IRemoteControlProtocol : public TSharedFromThis< IRemoteControlProtocol >
Remarks
Interface for remote control protocol
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Bind
(
FRemoteControlProtocolEntityPtr InEntityPtr |
Bind the protocol entity to the protocol |
  |
FRemoteControlProtocolEntityPtr | CreateNewProtocolEntity
(
FProperty* InProperty, |
Add the new protocol entity. That is created based on protocol specific script struct |
  |
UScriptStruct * | Get protocol specific Script Struct class | |
   |
FProperty * | Get range input template Property | |
  |
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. |
 |
void | Unbind
(
FRemoteControlProtocolEntityPtr InEntityPtr |
Unbind the protocol entity from the protocol |
 |
void | UnbindAll () |
Unbind all protocol entities from the protocol |