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