IRemoteControlProtocolModule

A Remote Control Protocol module. That is base for all remote control protcols

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

IRemoteControlProtocolModule

References

Module

RemoteControlProtocol

Header

/Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlProtocol/Public/IRemoteControlProtocolModule.h

Include

#include "IRemoteControlProtocolModule.h"

Syntax

class IRemoteControlProtocolModule : public IModuleInterface

Remarks

A Remote Control Protocol module. That is base for all remote control protcols

Functions

Name Description

Public function

bool

 

AddProtocol

(
    FName InProtocolName,
    TSharedRef< IRemoteControlProtocol ...
)

Register the protocol

Public function

void

 

EmptyProtocols()

Unregister all protocols

Public function Static

IRemoteContr...

 

Get()

Singleton-like access to this module's interface.

Public function Const

TSharedPtr< ...

 

GetProtocolByName

(
    FName InProtocolName
)

Get specific remote control protocol by given name

Public function Const

TArray< FNam...

 

GetProtocolNames()

Get array of all remote control protocol names

Public function Const

int32

 

GetProtocolNum()

Get number of remote control protocols

Public function Const

bool

 

IsRCProtocolsDisable()

Whether protocol disabled

Public function

void

 

RemoveProtocol

(
    FName InProtocolName,
    TSharedRef< IRemoteControlProtocol ...
)

Unregister the protocol

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss