1. Epic GamesDeveloper
  3. PIXELSTREAMING2IPixelStreaming2InputHandler

PIXELSTREAMING2IPixelStreaming2InputHandler

The IPixelStreaming2InputHandler, used to handle input from a remote peer and pass it to UE accordingly.

API > API/Plugins > API/Plugins/PixelStreaming2Input

Inheritance Hierarchy

References

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

Syntax

class PIXELSTREAMING2IPixelStreaming2InputHandler : public IInputDevice

Remarks

The IPixelStreaming2InputHandler, 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 An event that is only fired internally of the InputHandler when it wants to send a message to all connected players.

Functions

  Type Name Description
Public function MessageHandlerFn

FindMessageHandler ( const FString& MessageType
)

 Find the function to be called whenever the specified message type is received.
Public function TSharedPtr< IPixelStreaming2DataProtocol >  
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 TSharedPtr< IPixelStreaming2DataProtocol >  
Public function bool

IsElevated ( const FString& Id
)

 Checks whether the given id has elevated priviledges.
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 ( FString SourceId,
TArray< uint8 > Buffer
)

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

RegisterMessageHandler ( const FString& MessageType,
const MessageHandlerFn& Handler
)

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

SetCommandHandler ( const FString& CommandName,
const CommandHandlerFn& 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

SetElevatedCheck ( const TFunction< bool(FString)>& CheckFn
)

 Some behaviours might want to be limited to a specific source or group of sources. This method sets a check function to test of a given source id is "elevated".
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.

Classes

  Type Name Description
Public class FOnSendMessage    

Typedefs

Name Description
CommandHandlerFn The callback signature for handling a command sent to the data channel.
MessageHandlerFn The callback signature for handling a command sent to the data channel.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page