Navigation
API > API/Plugins > API/Plugins/PixelStreaming
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- UPixelStreamingInput
References
| Module | PixelStreaming |
| Header | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamingInputComponent.h |
| Include | #include "PixelStreamingInputComponent.h" |
Syntax
UCLASS (Blueprintable, ClassGroup=(PixelStreaming), Meta=(BlueprintSpawnableComponent))
class UPixelStreamingInput : public UActorComponent
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
FOnInput | OnInputEvent |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UPixelStreamingInput
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
void | AddJsonStringValue
(
const FString& Descriptor, |
Helper function to add a string field to a JSON descriptor. |
   |
void | GetJsonStringValue
(
FString Descriptor, |
Helper function to extract a string field from a JSON descriptor of a UI interaction given its field name. |
   |
void | SendPixelStreamingResponse
(
const FString& Descriptor |
Send a response back to the source of the UI interactions. |
Overridden from UActorComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginPlay () |
Begins Play for the component. |
  |
void | EndPlay
(
const EEndPlayReason::Type EndPlayReason |
Ends gameplay for this component. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FOnInput | The delegate which will be notified about a UI interaction. |