1. Epic GamesDeveloper
  3. IPixelStreamingInputHandler

IPixelStreamingInputHandler

The [IPixelStreamingInputHandler](API\Plugins\PixelStreamingInput\IPixelStreamingInputHandler), used to handle input from a remote peer and pass it to UE accordingly.

API > API/Plugins > API/Plugins/PixelStreamingInput

Inheritance Hierarchy

References

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

Syntax

class IPixelStreamingInputHandler : public IInputDevice

Remarks

The IPixelStreamingInputHandler, used to handle input from a remote peer and pass it to UE accordingly. Setting the target viewport allows for scaling of input from browser to application, and setting the target window ensure that if windows are tiled (eg editor) that the streamed input only affect the target window.

Variables

  Type Name Description
Public variable FOnSendMessage OnSendMessage  

Functions

  Type Name Description
Public function TFunction< void(FMemoryReader)>

FindMessageHandler ( const FString& MessageType
)

 Find the function to be called whenever the specified message type is received.
Public function TWeakPtr< FIntRect > Get the target screen rectangle for this streamer.
Public function TWeakPtr< SViewport > Get the viewport this input device is associated with.
Public function TWeakPtr< SWindow > Get the viewport this input device is associated with.
Public function Const bool Set whether the input devices is faking touch events using keyboard and mouse this can be useful for debugging.
Public function void

OnMessage ( TArray< uint8 > Buffer
)

 Handle the message from the WebRTC data channel.
Public function void

RegisterMessageHandler ( const FString& MessageType,
const TFunction< void(FMemoryReader)>& Handler
)

 Register a function to be called whenever the specified message type is received.
Public function void

SetCommandHandler ( const FString& CommandName,
const TFunction< void(FString, FString)>& Handler
)

 Register a custom function to execute when command JSON is received over the data channel: "{ type: "Command", YourCommand: YourCommandValue }". Note: You can also override the default Pixel Streaming command handlers by setting handlers with the same name as those already used, e.g. "Stat.FPS".
Public function void Set the input handlers type. This controls whether input is routed to widgets or windows.
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 viewport this input device is associated with.
Public function void

SetTargetWindow ( TWeakPtr< SWindow > InTargetWindow
)

 Set the viewport this input device is associated with.

Typedefs

Name Description
FOnSendMessage  

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