1. Epic GamesDeveloper
  3. IPixelStreaming2Streamer

IPixelStreaming2Streamer

The [IPixelStreaming2Streamer](API\Plugins\PixelStreaming2Core\IPixelStreaming2Streamer) interface provides functionality for managing a Pixel Streaming session.

API > API/Plugins > API/Plugins/PixelStreaming2Core

The IPixelStreaming2Streamer interface provides functionality for managing a Pixel Streaming session. This class manages the core operations of streaming, such as setting the framerate, handling video input, and interacting with the signalling server. It also allows for control over connected players and sending data to them.

   
Name IPixelStreaming2Streamer
Type class
Header File /Engine/Plugins/Media/PixelStreaming2/Source/PixelStreaming2Core/Public/IPixelStreaming2Streamer.h
Include Path #include "IPixelStreaming2Streamer.h"

Syntax

class IPixelStreaming2Streamer

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IPixelStreaming2Streamer()

   IPixelStreaming2Streamer.h  

Classes

Name Remarks
FPreConnectionEvent Event fired just before the streamer begins connecting to signalling.
FStreamingStartedEvent Event fired when the streamer has connected to a signalling server and is ready for peers.
FStreamingStoppedEvent Event fired when the streamer has disconnected from a signalling server and has stopped streaming.

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ForceKeyFrame()

 Force a key frame to be sent. IPixelStreaming2Streamer.h  

void FreezeStream ( UTexture2D* Texture
)

 Freeze Pixel Streaming. IPixelStreaming2Streamer.h  

bool GetConfigOption ( const FName& OptionName,
FString& OutValue
)

 Get the Gonfigerartion value for a specific option. IPixelStreaming2Streamer.h  

TArray< FString > GetConnectedPlayers()

 Get the ids of the connected players. IPixelStreaming2Streamer.h  

FString GetConnectionURL()

 Get the URL this streamer will connect to. IPixelStreaming2Streamer.h  

FString GetId()

 Get this streamer's ID. IPixelStreaming2Streamer.h  

TWeakPtr< class IPixelStreaming2InputHandler > GetInputHandler()

 Get the streamer's input handler. IPixelStreaming2Streamer.h  

TWeakPtr< IPixelStreaming2AudioSink > GetPeerAudioSink ( FString PlayerId
)

 Get the audio sink associated with a specific peer/player. IPixelStreaming2Streamer.h  

TWeakPtr< IPixelStreaming2VideoSink > GetPeerVideoSink ( FString PlayerId
)

 Get the video sink associated with a specific peer/player. IPixelStreaming2Streamer.h  

virtual FString GetSignallingServerURL()

 Get the Signalling Server URL. IPixelStreaming2Streamer.h  

int32 GetStreamFPS()

 Get the Stream FPS. IPixelStreaming2Streamer.h  

TWeakPtr< IPixelStreaming2AudioSink > GetUnlistenedAudioSink()

 Get an audio sink that has no peers/players listening to it. IPixelStreaming2Streamer.h  

TWeakPtr< IPixelStreaming2VideoSink > GetUnwatchedVideoSink()

 Get a video sink that has no peers/players watching it. IPixelStreaming2Streamer.h  

TWeakPtr< IPixelStreaming2VideoProducer > GetVideoProducer()

 Get the Video Input object. IPixelStreaming2Streamer.h  

void Initialize ()

 Called just after streamer creation. IPixelStreaming2Streamer.h  

bool IsConnected()

 Check if this streamer is currently connected to the connection URL. IPixelStreaming2Streamer.h  

virtual bool IsSignallingConnected()

 Check if this streamer is currently connected to the signalling mechanism (e.g. websocket for signalling server). IPixelStreaming2Streamer.h  

bool IsStreaming()

 Get the current state of this streamer. IPixelStreaming2Streamer.h  

void KickPlayer ( FString PlayerId
)

 Kick a player by player id. IPixelStreaming2Streamer.h  

FPreConnectionEvent & OnPreConnection()

 A getter for the OnPreConnection event. Intent is for users to call IPixelStreaming2Module::Get().FindStreamer(ID)->OnPreConnection().AddXXX. IPixelStreaming2Streamer.h  

FStreamingStartedEvent & OnStreamingStarted()

 A getter for the OnStreamingStarted event. Intent is for users to call IPixelStreaming2Module::Get().FindStreamer(ID)->OnStreamingStarted().AddXXX. IPixelStreaming2Streamer.h  

FStreamingStoppedEvent & OnStreamingStopped()

 A getter for the OnStreamingStopped event. Intent is for users to call IPixelStreaming2Module::Get().FindStreamer(ID)->OnStreamingStopped().AddXXX. IPixelStreaming2Streamer.h  

void PlayerRequestsBitrate ( FString PlayerId,
int MinBitrate,
int MaxBitrate
)

 Set the minimum and maximum bitrate for the streamer. IPixelStreaming2Streamer.h  

void RefreshStreamBitrate()

 Refresh connection with minimum and maximum bitrate. IPixelStreaming2Streamer.h  

void SendAllPlayersMessage ( FString MessageType,
const FString& Descriptor
)

 Send all players connected to this streamer a message. IPixelStreaming2Streamer.h  

void SendFileData ( const TArray64< uint8 >& ByteData,
FString& MimeType,
FString& FileExtension
)

 Send a file to the browser where we are sending video. IPixelStreaming2Streamer.h  

void SendPlayerMessage ( FString PlayerId,
FString MessageType,
const FString& Descriptor
)

 Send all players connected to this streamer a message. IPixelStreaming2Streamer.h  

void SetConfigOption ( const FName& OptionName,
const FString& Value
)

 Allows sending arbitrary configuration options during initial connection. IPixelStreaming2Streamer.h  

void SetConnectionURL ( const FString& InConnectionURL
)

 Set the URL this streamer will connect to. IPixelStreaming2Streamer.h  

void SetCoupleFramerate ( bool bCouple
)

 Setting this to true will cause the streamer to ignore the FPS value and instead push out frames as they are submitted from the video input. IPixelStreaming2Streamer.h  

virtual void SetSignallingServerURL ( const FString& InSignallingServerURL
)

 Set the Signalling Server URL. IPixelStreaming2Streamer.h  

void SetStreamFPS ( int32 InFramesPerSecond
)

 Set the Stream FPS. IPixelStreaming2Streamer.h  

void SetVideoProducer ( TSharedPtr< IPixelStreaming2VideoProducer > Input
)

 Set the Video Input object. IPixelStreaming2Streamer.h  

void StartStreaming()

 Start streaming this streamer. IPixelStreaming2Streamer.h  

void StopStreaming()

 Stop this streamer from streaming. IPixelStreaming2Streamer.h  

void UnfreezeStream()

 Unfreeze Pixel Streaming. IPixelStreaming2Streamer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page