Navigation
API > API/Plugins > API/Plugins/RemoteControlProtocol
A Remote Control Protocol module. That is base for all remote control protcols
| Name | IRemoteControlProtocolModule |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlProtocol/Public/IRemoteControlProtocolModule.h |
| Include Path | #include "IRemoteControlProtocolModule.h" |
Syntax
class IRemoteControlProtocolModule : public IModuleInterface
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddProtocol
(
FName InProtocolName, |
Register the protocol | IRemoteControlProtocolModule.h | |
void ApplyProtocolBindings
(
URemoteControlPreset* InPreset |
Applies all the protocol bindings found within the given preset | IRemoteControlProtocolModule.h | |
void EmptyProtocols() |
Unregister all protocols | IRemoteControlProtocolModule.h | |
TSharedPtr< IRemoteControlProtocol > GetProtocolByName
(
FName InProtocolName |
Get specific remote control protocol by given name | IRemoteControlProtocolModule.h | |
| Get array of all remote control protocol names | IRemoteControlProtocolModule.h | ||
int32 GetProtocolNum() |
Get number of remote control protocols | IRemoteControlProtocolModule.h | |
bool IsRCProtocolsDisable() |
Whether protocol disabled | IRemoteControlProtocolModule.h | |
void RemoveProtocol
(
FName InProtocolName, |
Unregister the protocol | IRemoteControlProtocolModule.h | |
void UnapplyProtocolBindings
(
URemoteControlPreset* InPreset |
Unapplies all the protocol bindings found within the given preset | IRemoteControlProtocolModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IRemoteControlProtocolModule & Get () |
Singleton-like access to this module's interface. | IRemoteControlProtocolModule.h |