Navigation
API > API/Plugins > API/Plugins/PixelStreaming
This component may be attached to an actor to allow UI interactions to be handled as the delegate will be notified about the interaction and will be supplied with a generic descriptor string containing, for example, JSON data. Responses back to the source of the UI interactions may also be sent.
| Name | UPixelStreamingInput |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamingInputComponent.h |
| Include Path | #include "PixelStreamingInputComponent.h" |
Syntax
UCLASS (Blueprintable, ClassGroup=(PixelStreaming), Meta=(BlueprintSpawnableComponent))
class UPixelStreamingInput : public UActorComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UPixelStreamingInput
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPixelStreamingInput
(
const FObjectInitializer& ObjectInitializer |
PixelStreamingInputComponent.h |
Classes
| Name | Remarks |
|---|---|
| FOnInput | The delegate which will be notified about a UI interaction. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnInputEvent | FOnInput | PixelStreamingInputComponent.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PixelStreamingModule | IPixelStreamingModule * | For convenience we keep a reference to the Pixel Streaming plugin. | PixelStreamingInputComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddJsonStringValue
(
const FString& Descriptor, |
Helper function to add a string field to a JSON descriptor. | PixelStreamingInputComponent.h |
|
void GetJsonStringValue
(
FString Descriptor, |
Helper function to extract a string field from a JSON descriptor of a UI interaction given its field name. | PixelStreamingInputComponent.h |
|
void SendPixelStreamingResponse
(
const FString& Descriptor |
Send a response back to the source of the UI interactions. | PixelStreamingInputComponent.h |
|
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginPlay() |
PixelStreamingInputComponent.h | ||
virtual void EndPlay
(
const EEndPlayReason::Type EndPlayReason |
PixelStreamingInputComponent.h |