Navigation
API > API/Plugins > API/Plugins/PixelStreamingEditor
Inheritance Hierarchy
- IModuleInterface
- IPixelStreamingEditorModule
References
| Module | PixelStreamingEditor |
| Header | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreamingEditor/Public/IPixelStreamingEditorModule.h |
| Include | #include "IPixelStreamingEditorModule.h" |
Syntax
class IPixelStreamingEditorModule : public IModuleInterface
Remarks
The public interface of the Pixel Streaming Editor module.
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
IPixelStreamingEditorModule & | Get () |
Singleton-like access to this module's interface. |
 |
FString | Get the domain for the inbuilt c++ signalling server | |
 |
TSharedPtr< UE::PixelStreamingServers::IServer > | Get the inbuilt C++ signalling server | |
 |
int32 | Get the port streamers connect to for the inbuilt c++ signalling server | |
 |
int32 | Get the port viewers connect to for the inbuilt c++ signalling server | |
  |
bool | IsAvailable () |
Checks to see if this module is loaded. |
 |
void | SetSignallingDomain
(
const FString& InSignallingDomain |
Set the domain for the inbuilt c++ signalling server |
 |
void | SetStreamerPort
(
int32 InStreamerPort |
Set the port streamers connect to for the inbuilt c++ signalling server |
 |
void | SetViewerPort
(
int32 InViewerPort |
Set the port viewers connect to for the inbuilt c++ signalling server |
 |
void | Start the inbuilt C++ signalling server | |
 |
void | StartStreaming
(
UE::EditorPixelStreaming::EStreamTypes InStreamType |
Starts the editor specific streamer. |
 |
void | Stop the inbuilt C++ signalling server | |
 |
void | Starts the editor specific streamer. | |
 |
bool | Get if streamers should use an external signalling server or the inbuilt c++ signalling server. | |
 |
void | UseExternalSignallingServer
(
bool bUseExternalSignallingServer |
Set if streamers should use an external signalling server or the inbuilt c++ signalling server. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
 |
UE::EditorPixelStreaming::EStreamTypes | GetStreamType() has been deprecated. You can now instead find what is being streamed by doing Streamer->GetVideoInput()->ToString() | |
 |
void | SetStreamType
(
UE::EditorPixelStreaming::EStreamTypes InStreamType |
SetStreamType() has been deprecated. Stream types are configured by setting the appropriate video input on your streamer |