1. Epic GamesDeveloper
  3. IPixelStreaming2Streamer

IPixelStreaming2Streamer

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

API > API/Plugins > API/Plugins/PixelStreaming2

References

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

Syntax

class IPixelStreaming2Streamer

Remarks

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.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Force a key frame to be sent.
Public function void

FreezeStream ( UTexture2D* Texture
)

 Freeze Pixel Streaming.
Public function bool

GetConfigOption ( const FName& OptionName,
FString& OutValue
)

 Get the Gonfigerartion value for a specific option.
Public function TArray< FString > Get the ids of the connected players.
Public function FString

GetId ()

 Get this streamer's ID.
Public function TWeakPtr< IPixelStreaming2InputHandler > Get the streamer's input handler.
Public function IPixelStreaming2AudioSink *

GetPeerAudioSink ( FString PlayerId
)

 Get the audio sink associated with a specific peer/player.
Public function IPixelStreaming2VideoSink *

GetPeerVideoSink ( FString PlayerId
)

 Get the video sink associated with a specific peer/player.
Public function FString Get the Signalling Server URL.
Public function int32 Get the Stream FPS.
Public function IPixelStreaming2AudioSink * Get an audio sink that has no peers/players listening to it.
Public function IPixelStreaming2VideoSink * Get a video sink that has no peers/players watching it.
Public function TWeakPtr< IPixelStreaming2VideoProducer > Get the Video Input object.
Public function bool Check if this streamer is currently connected to the signalling mechanism (e.g. websocket for signalling server).
Public function Const bool Get the current state of this streamer.
Public function void

KickPlayer ( FString PlayerId
)

 Kick a player by player id.
Public function FPreConnectionEvent & A getter for the OnPreConnection event. Intent is for users to call IPixelStreaming2Module::Get().FindStreamer(ID)->OnPreConnection().AddXXX.
Public function FStreamingStartedEvent & A getter for the OnStreamingStarted event. Intent is for users to call IPixelStreaming2Module::Get().FindStreamer(ID)->OnStreamingStarted().AddXXX.
Public function FStreamingStoppedEvent & A getter for the OnStreamingStopped event. Intent is for users to call IPixelStreaming2Module::Get().FindStreamer(ID)->OnStreamingStopped().AddXXX.
Public function void

PlayerRequestsBitrate ( FString PlayerId,
int MinBitrate,
int MaxBitrate
)

 Set the minimum and maximum bitrate for the streamer.
Public function void Refresh connection with minimum and maximum bitrate.
Public function void

SendAllPlayersMessage ( FString MessageType,
const FString& Descriptor
)

 Send all players connected to this streamer a message.
Public function void

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

 Send a file to the browser where we are sending video.
Public function void

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

 Send all players connected to this streamer a message.
Public function void

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

 Allows sending arbitrary configuration options during initial connection.
Public function 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.
Public function void

SetSignallingServerURL ( const FString& InSignallingServerURL
)

 Set the Signalling Server URL.
Public function void

SetStreamFPS ( int32 InFramesPerSecond
)

 Set the Stream FPS.
Public function void Set the Video Input object.
Public function void Start streaming this streamer.
Public function void Stop this streamer from streaming.
Public function void Unfreeze Pixel Streaming.

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page