Navigation
API > API/Plugins > API/Plugins/RemoteControlProtocol
Interface for remote control protocol
| Name | IRemoteControlProtocol |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlProtocol/Public/IRemoteControlProtocol.h |
| Include Path | #include "IRemoteControlProtocol.h" |
Syntax
class IRemoteControlProtocol : public TSharedFromThis< IRemoteControlProtocol >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IRemoteControlProtocol
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IRemoteControlProtocol() |
Virtual destructor | IRemoteControlProtocol.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Bind
(
FRemoteControlProtocolEntityPtr InEntityPtr |
Bind the protocol entity to the protocol | IRemoteControlProtocol.h | |
| Add the new protocol entity. That is created based on protocol specific script struct | IRemoteControlProtocol.h | ||
UScriptStruct * GetProtocolScriptStruct() |
Get protocol specific Script Struct class | IRemoteControlProtocol.h | |
virtual FProperty * GetRangeInputTemplateProperty() |
Get range input template Property | IRemoteControlProtocol.h | |
FProtocolColumnPtr GetRegisteredColumn
(
const FName& ByColumnName |
Retrieves the column reference by its name. | IRemoteControlProtocol.h | |
void GetRegisteredColumns
(
TSet< FName >& OutColumns |
Retrieves the set of columns registered by this protocol. | IRemoteControlProtocol.h | |
void Init() |
Add custom initializing of the protocol | IRemoteControlProtocol.h | |
virtual void OnBeginFrame() |
Build to core engine delegated and called at the beginning of a frame | IRemoteControlProtocol.h | |
virtual void OnEndFrame() |
Build to core engine delegated and called at the end of a frame | IRemoteControlProtocol.h | |
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. | IRemoteControlProtocol.h | |
void Unbind
(
FRemoteControlProtocolEntityPtr InEntityPtr |
Unbind the protocol entity from the protocol | IRemoteControlProtocol.h | |
void UnbindAll() |
Unbind all protocol entities from the protocol | IRemoteControlProtocol.h |