Navigation
API > API/Plugins > API/Plugins/PixelStreamingInput
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.
| Name | IPixelStreamingInputHandler |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreamingInput/Public/IPixelStreamingInputHandler.h |
| Include Path | #include "IPixelStreamingInputHandler.h" |
Syntax
class IPixelStreamingInputHandler : public IInputDevice
Implements Interfaces
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CommandHandlerFn | TFunction< void(FString SourceId, FString Descriptor, FString CommandString)> | The callback signature for handling a command sent to the data channel. | IPixelStreamingInputHandler.h |
| FOnSendMessage | TMulticastDelegate_TwoParams< void, FString, FMemoryReader > | IPixelStreamingInputHandler.h | |
| MessageHandlerFn | TFunction< void(FString SourceId, FMemoryReader Message)> | The callback signature for handling a command sent to the data channel. | IPixelStreamingInputHandler.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnSendMessage | FOnSendMessage | IPixelStreamingInputHandler.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
MessageHandlerFn FindMessageHandler
(
const FString& MessageType |
Find the function to be called whenever the specified message type is received. | IPixelStreamingInputHandler.h | |
TWeakPtr< FIntRect > GetTargetScreenRect() |
Get the target screen rectangle for this streamer. | IPixelStreamingInputHandler.h | |
TWeakPtr< SViewport > GetTargetViewport() |
Get the viewport this input device is associated with. | IPixelStreamingInputHandler.h | |
TWeakPtr< SWindow > GetTargetWindow() |
Get the viewport this input device is associated with. | IPixelStreamingInputHandler.h | |
bool IsElevated
(
const FString& Id |
Checks whether the given id has elevated priviledges. | IPixelStreamingInputHandler.h | |
bool IsFakingTouchEvents() |
Set whether the input devices is faking touch events using keyboard and mouse this can be useful for debugging. | IPixelStreamingInputHandler.h | |
void OnMessage
(
FString SourceId, |
Handle the message from the WebRTC data channel. | IPixelStreamingInputHandler.h | |
void RegisterMessageHandler
(
const FString& MessageType, |
Register a function to be called whenever the specified message type is received. | IPixelStreamingInputHandler.h | |
void SetCommandHandler
(
const FString& CommandName, |
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". | IPixelStreamingInputHandler.h | |
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". | IPixelStreamingInputHandler.h | |
void SetInputType
(
EPixelStreamingInputType InputType |
Set the input handlers type. This controls whether input is routed to widgets or windows. | IPixelStreamingInputHandler.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. | IPixelStreamingInputHandler.h | |
void SetTargetViewport
(
TWeakPtr< SViewport > InTargetViewport |
Set the viewport this input device is associated with. | IPixelStreamingInputHandler.h | |
void SetTargetWindow
(
TWeakPtr< SWindow > InTargetWindow |
Set the viewport this input device is associated with. | IPixelStreamingInputHandler.h |