1. Epic GamesDeveloper
  3. IWebRemoteControlModule

IWebRemoteControlModule

A Remote Control module that allows exposing objects and properties from the editor.

API > API/Plugins > API/Plugins/WebRemoteControl

Inheritance Hierarchy

References

   
Module WebRemoteControl
Header /Engine/Plugins/VirtualProduction/RemoteControl/Source/WebRemoteControl/Public/IWebRemoteControlModule.h
Include #include "IWebRemoteControlModule.h"

Syntax

class IWebRemoteControlModule : public IModuleInterface

Remarks

A Remote Control module that allows exposing objects and properties from the editor.

Functions

  Type Name Description
Public function bool Returns whether the http server is currently running.
Public function bool Returns whether the websocket server is currently running.
Public function FOnWebServerStarted & Event triggered when the http server starts.
Public function FSimpleMulticastDelegate & Event triggered when the http server stops.
Public function FOnWebSocketConnectionClosed & Event triggered when a connection to the websocket server is closed.
Public function FOnWebSocketConnectionOpened & Event triggered when a connection to the websocket server is opened.
Public function FOnWebServerStarted & Event triggered when the websocket server starts.
Public function FSimpleMulticastDelegate & Event triggered when the websocket server stops.
Public function FDelegateHandle

RegisterRequestPreprocessor ( FHttpRequestHandler RequestPreprocessor
)

 Register a request preprocessor.
Public function void Register a websocket route.
Public function void

SendWebsocketMessage ( const FGuid& InTargetClientId,
const TArray< uint8 >& InUTF8Payload
)

 Send a message through the websocket server.
Public function void Set Remote Web Socket Logger
Public function void

UnregisterRequestPreprocessor ( const FDelegateHandle& RequestPreprocessorHandle
)

 Unregister a request preprocessor.
Public function void Unregister a websocket route.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page