Navigation
API > API/Plugins > API/Plugins/PixelStreaming2Editor
Public interface that manages Pixel Streaming specific functionality within the Unreal Editor. Provides various features for controlling Pixel Streaming, such as starting and stopping the streamer.
| Name | IPixelStreaming2EditorModule |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming2/Source/PixelStreaming2Editor/Public/IPixelStreaming2EditorModule.h |
| Include Path | #include "IPixelStreaming2EditorModule.h" |
Syntax
class IPixelStreaming2EditorModule : public IModuleInterface
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetServeHttps() |
Get the bool indicating if frontend content is being served over HTTPS for the inbuilt c++ signalling server | IPixelStreaming2EditorModule.h | |
FString GetSignallingDomain() |
Get the domain for the inbuilt c++ signalling server | IPixelStreaming2EditorModule.h | |
TSharedPtr< UE::PixelStreaming2Servers::IServer > GetSignallingServer() |
Get the inbuilt C++ signalling server | IPixelStreaming2EditorModule.h | |
FString GetSSLCertificatePath() |
Get the path to file containing the SSL certificate. | IPixelStreaming2EditorModule.h | |
FString GetSSLPrivateKeyPath() |
Get the path to file containing the SSL private key. | IPixelStreaming2EditorModule.h | |
int32 GetStreamerPort() |
Get the port streamers connect to for the inbuilt c++ signalling server | IPixelStreaming2EditorModule.h | |
int32 GetViewerPort() |
Get the port viewers connect to for the inbuilt c++ signalling server | IPixelStreaming2EditorModule.h | |
void SetServeHttps
(
bool bServeHttps |
Set whether frontend content should be served of HTTPS for the inbuilt c++ signalling server | IPixelStreaming2EditorModule.h | |
void SetSignallingDomain
(
const FString& InSignallingDomain |
Set the domain for the inbuilt c++ signalling server | IPixelStreaming2EditorModule.h | |
void SetSSLCertificatePath
(
const FString& Path |
Set the path to file containing the SSL certificate. | IPixelStreaming2EditorModule.h | |
void SetSSLPrivateKeyPath
(
const FString& Path |
Set the path to file containing the SSL private key. | IPixelStreaming2EditorModule.h | |
void SetStreamerPort
(
int32 InStreamerPort |
Set the port streamers connect to for the inbuilt c++ signalling server | IPixelStreaming2EditorModule.h | |
void SetViewerPort
(
int32 InViewerPort |
Set the port viewers connect to for the inbuilt c++ signalling server | IPixelStreaming2EditorModule.h | |
void StartSignalling() |
Start the inbuilt C++ signalling server | IPixelStreaming2EditorModule.h | |
void StartStreaming
(
EPixelStreaming2EditorStreamTypes InStreamType |
Starts the editor specific streamer. | IPixelStreaming2EditorModule.h | |
void StopSignalling
(
bool bForce |
Stop the inbuilt C++ signalling server | IPixelStreaming2EditorModule.h | |
void StopStreaming() |
Starts the editor specific streamer. | IPixelStreaming2EditorModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IPixelStreaming2EditorModule & Get () |
Singleton-like access to this module's interface. | IPixelStreaming2EditorModule.h | |
static bool IsAvailable() |
Checks to see if this module is loaded. | IPixelStreaming2EditorModule.h |