1. Epic GamesDeveloper
  3. URemoteControlSettings

URemoteControlSettings

Global remote control settings

API > API/Plugins > API/Plugins/RemoteControlCommon

Inheritance Hierarchy

References

   
Module RemoteControlCommon
Header /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlCommon/Public/RemoteControlSettings.h
Include #include "RemoteControlSettings.h"

Syntax

UCLASS&40;Config&61;RemoteControl&41;  
class URemoteControlSettings : public UDeveloperSettings

Remarks

Global remote control settings

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta Config FString AllowedOrigin Origin that can make requests to the remote control server.
Public variable UProperty Category, EditAnywhere, Meta Config displayname TSet< FRCNetworkAddressRange > AllowlistedClients List of IP Addresses that are allowed to access the Web API without authentication.
Public variable UProperty Category, EditAnywhere Config bool bAutoStartWebServer Whether web server is started automatically.
Public variable UProperty Category, EditAnywhere Config bool bAutoStartWebSocketServer Whether web socket server is started automatically.
Public variable UProperty Category, EditAnywhere Config displayname bool bDisplayInEditorOnlyWarnings Show a warning icon for exposed editor-only fields.
Public variable UProperty Category, EditAnywhere, Meta Config bool bEnableRemotePythonExecution Enable remote python execution, enabling this could open you open to vulnerabilities if an outside actor has access to your server.
Public variable UProperty Category, EditAnywhere, Meta Config bool bEnforcePassphraseForRemoteClients Controls whether a passphrase should be required when remote control is accessed by a client outside of localhost.
Public variable UProperty Category, EditAnywhere Config displayname bool bForceWebAppBuildAtStartup Should force a build of the WebApp at startup.
Public variable UProperty Category, EditAnywhere Config displayname bool bIgnoreGetterSetterCheck  
Public variable UProperty Category, EditAnywhere Config displayname bool bIgnoreProtectedCheck  
Public variable UProperty Category, EditAnywhere Config bool bIgnoreWarnings  
Public variable UProperty Category, EditAnywhere Config bool bProtocolsGenerateTransactions Should transactions be generated for events received through protocols (ie. MIDI, DMX etc.) Disabling transactions improves performance but will prevent events from being transacted to Multi-User unless using the Remote Control Interception feature.
Public variable UProperty Category, EditAnywhere Config bool bRestrictServerAccess Whether to restrict access to a list of hostname/IPs in the AllowedOrigins setting.
Public variable UProperty Category, EditAnywhere, Meta Config displayname bool bShowPassphraseDisabledWarning Whether the User should be warned that Passphrase usage is disabled or now. Initially activated
Public variable UProperty Config bool bUseRebindingContext  
Public variable UProperty Category, EditAnywhere Config displayname bool bWebAppLogRequestDuration Should WebApp log timing.
Public variable UProperty Category, EditAnywhere, Meta Config displayname TArray< FRCPassphrase > Passphrases List of passphrases used for accessing remote control outside of localhost.
Public variable UProperty Category, EditAnywhere Config displayname uint32 RemoteControlHttpServerPort The web remote control HTTP server's port.
Public variable UProperty Category, EditAnywhere Config displayname FString RemoteControlWebInterfaceBindAddress The remote control web app bind address.
Public variable UProperty Category, EditAnywhere Config displayname uint32 RemoteControlWebInterfacePort The remote control web app http port.
Public variable UProperty Category, EditAnywhere Config displayname FString RemoteControlWebsocketServerBindAddress The address to bind the websocket server to.
Public variable UProperty Category, EditAnywhere Config displayname uint32 RemoteControlWebSocketServerPort The web remote control WebSocket server's port.
Public variable UProperty Config float TreeBindingSplitRatio The split widget control ratio between entity tree and details/protocol binding list.

Functions

  Type Name Description
Public function Virtual void

AllowClient ( const FString& InClientAddressStr
)

  
Public function Virtual Const TArray< FString >  
Public function Virtual Const bool

IsClientAllowed ( const FString& InClientAddressStr
)

  

Overridden from UDeveloperSettings

  Type Name Description
Public function Virtual Const FName Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.
Public function Virtual Const FName Gets the settings container name for the settings, either Project or Editor
Public function Virtual Const FName The unique name for your section of settings, uses the class's FName.
Public function Virtual Const FText Gets the section text, uses the classes DisplayName by default.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page