1. Epic GamesDeveloper
  3. IPixelStreaming2Module

IPixelStreaming2Module

The [IPixelStreaming2Module](API\Plugins\PixelStreaming2\IPixelStreaming2Module) interface manages the core functionality of the Pixel Streaming system.

API > API/Plugins > API/Plugins/PixelStreaming2

Inheritance Hierarchy

References

   
Module PixelStreaming2
Header /Engine/Plugins/Media/PixelStreaming2/Source/PixelStreaming2/Public/IPixelStreaming2Module.h
Include #include "IPixelStreaming2Module.h"

Syntax

class IPixelStreaming2Module : public IModuleInterface

Remarks

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.

Functions

  Type Name Description
Public function TSharedPtr< IPixelStreaming2AudioProducer > Creates a new audio producer. Any audio you push in with `PushAudio_ will be mixed with other audio sources before being streamed.
Public function TSharedPtr< IPixelStreaming2Streamer >

CreateStreamer ( const FString& StreamerId
)

 Creates a new streamer.
Public function TSharedPtr< IPixelStreaming2VideoProducer > Creates a new video producer.
Public function TSharedPtr< IPixelStreaming2Streamer >

DeleteStreamer ( const FString& StreamerId
)

 Remove a streamer by an ID
Public function void Remove a streamer by its pointer
Public function TSharedPtr< IPixelStreaming2Streamer >

FindStreamer ( const FString& StreamerId
)

 Find a streamer by an ID.
Public function void A method for iterating through all of the streamers on the module.
Public function Static IPixelStreaming2Module &

Get ()

 Singleton-like access to this module's interface.
Public function FString Get the Default Signaling URL ("ws://127.0.0.1:8888").
Public function FString Get the Default Streamer ID.
Public function TArray< FString > Returns a TArray containing the keys to the currently held streamers.
Public function Static bool Checks to see if this module is loaded.
Public function bool

IsReady ()

 Is the PixelStreaming2 module actually ready to use? Is the streamer created.
Public function FReadyEvent &

OnReady ()

 A getter for the OnReady event.
Public function bool Starts streaming on all streamers.
Public function void Stops all streamers from streaming.

Classes

  Type Name Description
Public class FReadyEvent Event fired when internal streamer is initialized and the methods on this module are ready for use.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page