1. Epic GamesDeveloper
  3. IPixelStreamingStreamer

IPixelStreamingStreamer

API > API/Plugins > API/Plugins/PixelStreaming

   
Name IPixelStreamingStreamer
Type class
Header File /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/IPixelStreamingStreamer.h
Include Path #include "IPixelStreamingStreamer.h"

Syntax

class IPixelStreamingStreamer

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IPixelStreamingStreamer()

   IPixelStreamingStreamer.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.

Typedefs

Name Type Remarks Include Path
FOnInputReceived TMulticastDelegate_ThreeParams< void, FPixelStreamingPlayerId, uint8, TArray< uint8 > > Broadcast when data comes in from the data channel. IPixelStreamingStreamer.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnInputReceived FOnInputReceived   IPixelStreamingStreamer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< IPixelStreamingAudioInput > CreateAudioInput()

 Create an audio input that can be used to push audio into the Pixel Streaming mix. Note: Requires launching with -PixelStreamingExperimentalAudioInput. IPixelStreamingStreamer.h  

void ForceKeyFrame()

 Force a key frame to be sent. IPixelStreamingStreamer.h  

void FreezeStream ( UTexture2D* Texture
)

 Freeze Pixel Streaming. IPixelStreamingStreamer.h  

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

   IPixelStreamingStreamer.h  

TArray< FPixelStreamingPlayerId > GetConnectedPlayers()

 Get the connected players. IPixelStreamingStreamer.h  

FString GetId()

 Get this streamer's ID. IPixelStreamingStreamer.h  

TWeakPtr< IPixelStreamingInputHandler > GetInputHandler()

 Get the streamer's input handler. IPixelStreamingStreamer.h  

IPixelStreamingAudioSink * GetPeerAudioSink ( FPixelStreamingPlayerId PlayerId
)

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

TWeakPtr< IPixelStreamingSignallingConnection > GetSignallingConnection()

 Get the connection to the signalling server. IPixelStreamingStreamer.h  

TWeakPtr< IPixelStreamingSignallingConnectionObserver > GetSignallingConnectionObserver()

 Get the Signalling Connection Observer object. IPixelStreamingStreamer.h  

FString GetSignallingServerURL()

 Get the Signalling Server URL. IPixelStreamingStreamer.h  

int32 GetStreamFPS()

 Get the Stream FPS. IPixelStreamingStreamer.h  

TWeakPtr< FIntRect > GetTargetScreenRect()

 Get the target screen rectangle for this streamer. IPixelStreamingStreamer.h  

TWeakPtr< SViewport > GetTargetViewport()

 Get the Target Viewport for this streamer. IPixelStreamingStreamer.h  

TWeakPtr< SWindow > GetTargetWindow()

 Get the target window for this streamer. IPixelStreamingStreamer.h  

IPixelStreamingAudioSink * GetUnlistenedAudioSink()

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

TWeakPtr< FPixelStreamingVideoInput > GetVideoInput()

 Get the Video Input object. IPixelStreamingStreamer.h  

bool IsSignallingConnected()

   IPixelStreamingStreamer.h  

bool IsStreaming()

 Get the current state of this streamer. IPixelStreamingStreamer.h  

void KickPlayer ( FPixelStreamingPlayerId PlayerId
)

 Kick a player by player id. IPixelStreamingStreamer.h  

FPreConnectionEvent & OnPreConnection()

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

FStreamingStartedEvent & OnStreamingStarted()

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

FStreamingStoppedEvent & OnStreamingStopped()

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

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

   IPixelStreamingStreamer.h  

void RefreshStreamBitrate()

   IPixelStreamingStreamer.h  

void RemoveAudioInput ( TSharedPtr< IPixelStreamingAudioInput > AudioInput
)

 Remove the audio input from the Pixel Streaming mix. IPixelStreamingStreamer.h  

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

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

void SendPlayerMessage ( uint8 Type,
const FString& Descriptor
)

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

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

 Allows sending arbitrary configuration options during initial connection. IPixelStreamingStreamer.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. IPixelStreamingStreamer.h  

void SetInputHandler ( TSharedPtr< IPixelStreamingInputHandler > InInputHandler
)

 Set the streamer's input handler. IPixelStreamingStreamer.h  

void SetInputHandlerType ( EPixelStreamingInputType InputType
)

 Set the type for this streamers input handler. This controls whether input is routed to widgets or windows. IPixelStreamingStreamer.h  

void SetPlayerLayerPreference ( FPixelStreamingPlayerId PlayerId,
int SpatialLayerId,
int TemporalLayerId
)

 Set the Layer Preference for a specific player. Only useful if using the SFU. IPixelStreamingStreamer.h  

void SetSignallingConnection ( TSharedPtr< IPixelStreamingSignallingConnection > InSignallingConnection
)

 Set the connection to the signalling server. IPixelStreamingStreamer.h  

void SetSignallingServerURL ( const FString& InSignallingServerURL
)

 Set the Signalling Server URL. IPixelStreamingStreamer.h  

void SetStreamFPS ( int32 InFramesPerSecond
)

 Set the Stream FPS. IPixelStreamingStreamer.h  

void SetTargetScreenRect ( TWeakPtr< FIntRect > InTargetScreenRect
)

 Set the target screen rectangle for this streamer. This is used to when the streamer doesn't have a singular target window / viewport and as such we just use the manual scale. IPixelStreamingStreamer.h  

void SetTargetViewport ( TWeakPtr< SViewport > InTargetViewport
)

 Set the Target Viewport for this streamer. This is used to ensure input between the browser and application scales correctly. IPixelStreamingStreamer.h  

void SetTargetWindow ( TWeakPtr< SWindow > InTargetWindow
)

 Set the target window for this streamer. This is used to ensure mouse events are directed to the correct window if multiple windows are tiled on top of one another as seen in the editor. IPixelStreamingStreamer.h  

void SetVideoInput ( TSharedPtr< FPixelStreamingVideoInput > Input
)

 Set the Video Input object. IPixelStreamingStreamer.h  

void StartStreaming()

 Start streaming this streamer. IPixelStreamingStreamer.h  

void StopStreaming()

 Stop this streamer from streaming. IPixelStreamingStreamer.h  

void UnfreezeStream()

 Unfreeze Pixel Streaming. IPixelStreamingStreamer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page