IRemoteSessionModule | Unreal Engine 5.7 Documentation


Name	IRemoteSessionModule
Type	class
Header File	/Engine/Plugins/Experimental/RemoteSession/Source/RemoteSession/Public/RemoteSession.h
Include Path	#include "RemoteSession.h"

Syntax

class IRemoteSessionModule : public IModuleInterface

Name	Remarks
IRemoteSessionModule	End IModuleInterface implementation

Name	Remarks	Include Path
void AddChannelFactory ( const FStringView InChannelName, ERemoteSessionChannelMode InHostMode, TWeakPtr< IRemoteSessionChannelFactoryWorker > Worker )	Register a third party channel	RemoteSession.h
TSharedPtr< IRemoteSessionRole > CreateClient ( const TCHAR* RemoteAddress, bool bUsingPixelStreaming )	Client implementation Returns a reference to the client role (if any)	RemoteSession.h
TSharedPtr< IRemoteSessionUnmanagedRole > CreateHost ( TArray< FRemoteSessionChannelInfo > SupportedChannels, int32 Port ) const	Returns host that is not controlled by the module	RemoteSession.h
TSharedPtr< IRemoteSessionRole > GetHost()	Returns a reference to the server role (if any)	RemoteSession.h
void InitHost ( const int16 Port )	Server implementation Starts a RemoteSession server that listens for clients on the provided port	RemoteSession.h
bool IsHostConnected()	Returns true/false if a client is connected	RemoteSession.h
bool IsHostRunning()	Returns true/false based on the running state of the host server	RemoteSession.h
void RemoveChannelFactory ( TWeakPtr< IRemoteSessionChannelFactoryWorker > Worker )	Unregister a channel factory	RemoteSession.h
void StopClient ( TSharedPtr< IRemoteSessionRole > Client, const FString& InReason )	Stops the client. After this CreateClient() must be called if a new connection is desired	RemoteSession.h
void StopHost ( const FString& InReason )	Stops the server, after this InitHost() must be called if a new connection is desired	RemoteSession.h

Name	Remarks	Include Path	Unreal Specifiers
void ShutdownModule()		RemoteSession.h
void StartupModule()	IModuleInterface implementation	RemoteSession.h

Name	Remarks	Include Path	Unreal Specifiers
static FString GetLastSupportedVersion()		RemoteSession.h
static FString GetLocalVersion()		RemoteSession.h