Navigation
API > API/Plugins > API/Plugins/PixelStreaming2RTC
The IPixelStreaming2RTCModule interface manages the core functionality of the Pixel Streaming system. This class provides access to streamers, video and audio producers, and handles starting and stopping the streaming process. It also allows interaction with the signalling server and manages the lifecycle of streamers within the Pixel Streaming system.
| Name | PIXELSTREAMING2IPixelStreaming2RTCModule |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming2/Source/PixelStreaming2RTC/Public/IPixelStreaming2RTCModule.h |
| Include Path | #include "IPixelStreaming2RTCModule.h" |
Syntax
class PIXELSTREAMING2IPixelStreaming2RTCModule : public IModuleInterface
Implements Interfaces
Classes
| Name | Remarks |
|---|---|
| FReadyEvent | Event fired when internal streamer is initialized and the methods on this module are ready for use. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsReady() |
Is the PixelStreaming2 module actually ready to use? Is the streamer created. | IPixelStreaming2RTCModule.h | |
FReadyEvent & OnReady () |
A getter for the OnReady event. | IPixelStreaming2RTCModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IPixelStreaming2RTCModule & Get () |
Singleton-like access to this module's interface. | IPixelStreaming2RTCModule.h | |
static bool IsAvailable() |
Checks to see if this module is loaded. | IPixelStreaming2RTCModule.h |