Navigation
API > API/Plugins > API/Plugins/PixelStreamingEditor
The public interface of the Pixel Streaming Editor module.
| Name | IPixelStreamingEditorModule |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreamingEditor/Public/IPixelStreamingEditorModule.h |
| Include Path | #include "IPixelStreamingEditorModule.h" |
Syntax
class IPixelStreamingEditorModule : public IModuleInterface
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetSignallingDomain() |
Get the domain for the inbuilt c++ signalling server | IPixelStreamingEditorModule.h | |
TSharedPtr< UE::PixelStreamingServers::IServer > GetSignallingServer() |
Get the inbuilt C++ signalling server | IPixelStreamingEditorModule.h | |
int32 GetStreamerPort() |
Get the port streamers connect to for the inbuilt c++ signalling server | IPixelStreamingEditorModule.h | |
int32 GetViewerPort() |
Get the port viewers connect to for the inbuilt c++ signalling server | IPixelStreamingEditorModule.h | |
void SetSignallingDomain
(
const FString& InSignallingDomain |
Set the domain for the inbuilt c++ signalling server | IPixelStreamingEditorModule.h | |
void SetStreamerPort
(
int32 InStreamerPort |
Set the port streamers connect to for the inbuilt c++ signalling server | IPixelStreamingEditorModule.h | |
void SetViewerPort
(
int32 InViewerPort |
Set the port viewers connect to for the inbuilt c++ signalling server | IPixelStreamingEditorModule.h | |
void StartSignalling() |
Start the inbuilt C++ signalling server | IPixelStreamingEditorModule.h | |
void StartStreaming
(
UE::EditorPixelStreaming::EStreamTypes InStreamType |
Starts the editor specific streamer. | IPixelStreamingEditorModule.h | |
void StopSignalling() |
Stop the inbuilt C++ signalling server | IPixelStreamingEditorModule.h | |
void StopStreaming() |
Starts the editor specific streamer. | IPixelStreamingEditorModule.h | |
bool UseExternalSignallingServer () |
Get if streamers should use an external signalling server or the inbuilt c++ signalling server. | IPixelStreamingEditorModule.h | |
void UseExternalSignallingServer
(
bool bUseExternalSignallingServer |
Set if streamers should use an external signalling server or the inbuilt c++ signalling server. | IPixelStreamingEditorModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IPixelStreamingEditorModule & Get () |
Singleton-like access to this module's interface. | IPixelStreamingEditorModule.h | |
static bool IsAvailable() |
Checks to see if this module is loaded. | IPixelStreamingEditorModule.h |