Navigation
API > API/Plugins > API/Plugins/WebRemoteControl
A Remote Control module that allows exposing objects and properties from the editor.
| Name | IWebRemoteControlModule |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/WebRemoteControl/Public/IWebRemoteControlModule.h |
| Include Path | #include "IWebRemoteControlModule.h" |
Syntax
class IWebRemoteControlModule : public IModuleInterface
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsHttpServerRunning() |
Returns whether the http server is currently running. | IWebRemoteControlModule.h | |
bool IsWebSocketServerRunning() |
Returns whether the websocket server is currently running. | IWebRemoteControlModule.h | |
FOnWebServerStarted & OnHttpServerStarted() |
Event triggered when the http server starts. | IWebRemoteControlModule.h | |
FSimpleMulticastDelegate & OnHttpServerStopped() |
Event triggered when the http server stops. | IWebRemoteControlModule.h | |
FOnWebSocketConnectionClosed & OnWebSocketConnectionClosed() |
Event triggered when a connection to the websocket server is closed. | IWebRemoteControlModule.h | |
FOnWebSocketConnectionOpened & OnWebSocketConnectionOpened() |
Event triggered when a connection to the websocket server is opened. | IWebRemoteControlModule.h | |
FOnWebServerStarted & OnWebSocketServerStarted() |
Event triggered when the websocket server starts. | IWebRemoteControlModule.h | |
FSimpleMulticastDelegate & OnWebSocketServerStopped() |
Event triggered when the websocket server stops. | IWebRemoteControlModule.h | |
FDelegateHandle RegisterRequestPreprocessor
(
FHttpRequestHandler RequestPreprocessor |
Register a request preprocessor. | IWebRemoteControlModule.h | |
void RegisterWebsocketRoute
(
const FRemoteControlWebsocketRoute& Route |
Register a websocket route. | IWebRemoteControlModule.h | |
| Send a message through the websocket server. | IWebRemoteControlModule.h | ||
void SetExternalRemoteWebSocketLoggerConnection
(
TSharedPtr< class INetworkingWebSocket > WebSocketLoggerConnection |
Set Remote Web Socket Logger | IWebRemoteControlModule.h | |
void UnregisterRequestPreprocessor
(
const FDelegateHandle& RequestPreprocessorHandle |
Unregister a request preprocessor. | IWebRemoteControlModule.h | |
void UnregisterWebsocketRoute
(
const FRemoteControlWebsocketRoute& Route |
Unregister a websocket route. | IWebRemoteControlModule.h |