Navigation
API > API/Plugins > API/Plugins/PixelStreaming2
The IPixelStreaming2Module 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 | IPixelStreaming2Module |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming2/Source/PixelStreaming2/Public/IPixelStreaming2Module.h |
| Include Path | #include "IPixelStreaming2Module.h" |
Syntax
class IPixelStreaming2Module : 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 |
|---|---|---|---|
TSharedPtr< IPixelStreaming2AudioProducer > CreateAudioProducer() |
Creates a new audio producer. Any audio you push in with `PushAudio_ will be mixed with other audio sources before being streamed. | IPixelStreaming2Module.h | |
TSharedPtr< IPixelStreaming2Streamer > CreateStreamer
(
const FString& StreamerId, |
Creates a new streamer. | IPixelStreaming2Module.h | |
TSharedPtr< IPixelStreaming2VideoProducer > CreateVideoProducer() |
Creates a new video producer. | IPixelStreaming2Module.h | |
TSharedPtr< IPixelStreaming2Streamer > DeleteStreamer
(
const FString& StreamerId |
Remove a streamer by an ID | IPixelStreaming2Module.h | |
void DeleteStreamer
(
TSharedPtr< IPixelStreaming2Streamer > ToBeDeleted |
Remove a streamer by its pointer | IPixelStreaming2Module.h | |
TSharedPtr< IPixelStreaming2Streamer > FindStreamer
(
const FString& StreamerId |
Find a streamer by an ID. | IPixelStreaming2Module.h | |
void ForEachStreamer
(
const TFunction< void(TSharedPtr< IPixelStreaming2Streamer >)>& Func |
A method for iterating through all of the streamers on the module. | IPixelStreaming2Module.h | |
FString GetDefaultConnectionURL() |
Get the Default Connection URL ("ws://127.0.0.1:8888"). | IPixelStreaming2Module.h | |
virtual FString GetDefaultSignallingURL() |
Get the Default Signaling URL ("ws://127.0.0.1:8888"). | IPixelStreaming2Module.h | |
FString GetDefaultStreamerID() |
Get the Default Streamer ID. | IPixelStreaming2Module.h | |
| Returns a TArray containing the keys to the currently held streamers. | IPixelStreaming2Module.h | ||
bool IsReady() |
Is the PixelStreaming2 module actually ready to use? Is the streamer created. | IPixelStreaming2Module.h | |
FReadyEvent & OnReady () |
A getter for the OnReady event. | IPixelStreaming2Module.h | |
bool StartStreaming() |
Starts streaming on all streamers. | IPixelStreaming2Module.h | |
void StopStreaming() |
Stops all streamers from streaming. | IPixelStreaming2Module.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IPixelStreaming2Module & Get () |
Singleton-like access to this module's interface. | IPixelStreaming2Module.h | |
static bool IsAvailable() |
Checks to see if this module is loaded. | IPixelStreaming2Module.h |