Navigation
API > API/Plugins > API/Plugins/PixelStreaming2Servers
Interface for all Pixel Streaming servers.
| Name | PIXELSTREAMING2IServer |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming2/Source/PixelStreaming2Servers/Public/PixelStreaming2Servers.h |
| Include Path | #include "PixelStreaming2Servers.h" |
Syntax
class PIXELSTREAMING2IServer
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnFailedToReady | TMulticastDelegate_NoParams< void > | PixelStreaming2Servers.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnFailedToReady | FOnFailedToReady | Can fire when the server is unable to be contacted or connecting to it timed out. | PixelStreaming2Servers.h | |
| OnReady | FOnReady | Delegate fired when the server is ready for connections, first parameter is a map of all supported endpoints and their urls. | PixelStreaming2Servers.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IServer() |
PixelStreaming2Servers.h | ||
void GetNumStreamers
(
TFunction< void(uint16)> OnNumStreamersReceived |
Asynchronously queries the numbers of streamers connected to the signalling server. | PixelStreaming2Servers.h | |
FString GetPathOnDisk() |
PixelStreaming2Servers.h | ||
bool HasLaunched() |
PixelStreaming2Servers.h | ||
bool IsReady() |
PixelStreaming2Servers.h | ||
bool IsTimedOut() |
PixelStreaming2Servers.h | ||
bool Launch
(
FLaunchArgs& InLaunchArgs |
Launch the server in a child process using the supplied launch arguments. | PixelStreaming2Servers.h | |
void Stop() |
Immediately stops the server. | PixelStreaming2Servers.h |