Navigation
API > API/Plugins > API/Plugins/PixelStreaming2Editor
Inheritance Hierarchy
- IModuleInterface
- PIXELSTREAMING2IPixelStreaming2EditorModule
References
| Module | PixelStreaming2Editor |
| Header | /Engine/Plugins/Media/PixelStreaming2/Source/PixelStreaming2Editor/Public/IPixelStreaming2EditorModule.h |
| Include | #include "IPixelStreaming2EditorModule.h" |
Syntax
class PIXELSTREAMING2IPixelStreaming2EditorModule : public IModuleInterface
Remarks
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.
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
IPixelStreaming2EditorModule & | Get () |
Singleton-like access to this module's interface. |
 |
FString | Get the domain for the inbuilt c++ signalling server | |
 |
TSharedPtr< UE::PixelStreaming2Servers::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
(
EPixelStreaming2EditorStreamTypes InStreamType |
Starts the editor specific streamer. |
 |
void | Stop the inbuilt C++ signalling server | |
 |
void | Starts the editor specific streamer. |