UPixelStreamerInputComponent

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.

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UPixelStreamerInputComponent

References

Module

PixelStreaming

Header

/Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamerInputComponent.h

Include

#include "PixelStreamerInputComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, ClassGroup=(PixelStreamer), Meta=(BlueprintSpawnableComponent))
class UPixelStreamerInputComponent : 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

Name Description

Public variable UProperty Category BlueprintAssignable

FOnInput

 

OnInputEvent

Constructors

Functions

Name Description

Public function UFunction BlueprintPure, Category

void

 

AddJsonStringValue

(
    const FString& Descriptor,
    FString FieldName,
    FString StringValue,
    FString& NewDescriptor,
    bool& Success
)

Helper function to add a string field to a JSON descriptor.

Public function UFunction BlueprintPure, Category

void

 

GetJsonStringValue

(
    FString Descriptor,
    FString FieldName,
    FString& StringValue,
    bool& Success
)

Helper function to extract a string field from a JSON descriptor of a UI interaction given its field name.

Public function

bool

 

OnCommand

(
    const FString& Descriptor
)

Run a built-in command.

Public function UFunction BlueprintCallable, Category

void

 

SendPixelStreamingResponse

(
    const FString& Descriptor
)

Send a response back to the source of the UI interactions.

Classes

Name

Description

Public class

FOnInput

The delegate which will be notified about a UI interaction.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss