1. Epic GamesDeveloper
  3. IPixelStreamingStreamer

IPixelStreamingStreamer

API > API/Plugins > API/Plugins/PixelStreaming

References

   
Module PixelStreaming
Header /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/IPixelStreamingStreamer.h
Include #include "IPixelStreamingStreamer.h"

Syntax

class IPixelStreamingStreamer

Variables

  Type Name Description
Public variable FOnInputReceived OnInputReceived  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TSharedPtr< IPixelStreamingAudioInput > Create an audio input that can be used to push audio into the Pixel Streaming mix. Note: Requires launching with -PixelStreamingExperimentalAudioInput.
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
)

  
Public function TArray< FPixelStreamingPlayerId > Get the connected players.
Public function FString

GetId ()

 Get this streamer's ID.
Public function TWeakPtr< IPixelStreamingInputHandler > Get the streamer's input handler.
Public function IPixelStreamingAudioSink * Get the audio sink associated with a specific peer/player.
Public function TWeakPtr< IPixelStreamingSignallingConnection > Get the connection to the signalling server.
Public function TWeakPtr< IPixelStreamingSignallingConnectionObserver > Get the Signalling Connection Observer object.
Public function FString Get the Signalling Server URL.
Public function int32 Get the Stream FPS.
Public function TWeakPtr< FIntRect > Get the target screen rectangle for this streamer.
Public function TWeakPtr< SViewport > Get the Target Viewport for this streamer.
Public function TWeakPtr< SWindow > Get the target window for this streamer.
Public function IPixelStreamingAudioSink * Get an audio sink that has no peers/players listening to it.
Public function TWeakPtr< FPixelStreamingVideoInput > Get the Video Input object.
Public function bool  
Public function Const bool Get the current state of this streamer.
Public function void Kick a player by player id.
Public function FStreamingStartedEvent & A getter for the OnStreamingStarted event. Intent is for users to call IPixelStreamingModule::Get().FindStreamer(ID)->OnStreamingStarted().AddXXX.
Public function FStreamingStoppedEvent & A getter for the OnStreamingStopped event. Intent is for users to call IPixelStreamingModule::Get().FindStreamer(ID)->OnStreamingStopped().AddXXX.
Public function void Remove the audio input from the Pixel Streaming mix.
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 ( uint8 Type,
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 Set the streamer's input handler.
Public function void Set the type for this streamers input handler. This controls whether input is routed to widgets or windows.
Public function void

SetPlayerLayerPreference ( FPixelStreamingPlayerId PlayerId,
int SpatialLayerId,
int TemporalLayerId
)

 Set the Layer Preference for a specific player. Only useful if using the SFU.
Public function void Set the connection to the signalling server.
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

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.
Public function 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.
Public function 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.
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 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.  

Typedefs

Name Description
FOnInputReceived Broadcast when data comes in from the data channel.

Deprecated Functions

  Type Name Description
Public function TWeakPtr< FIntPoint > GetTargetScreenSize() is deprecated. Please use GetTargetScreenRect() instead.
Public function void

SetTargetScreenSize ( TWeakPtr< FIntPoint > InTargetScreenSize
)

 SetTargetScreenSize() is deprecated. Please use SetTargetScreenRect() instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page