Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > PixelStreaming > UPixelStreamerInputComponent > UPixelStreamerInputComponent::GetJsonStringValue

Light Theme

Dark Theme

UPixelStreamerInputComponent::GetJsonStringValue

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

Windows

MacOS

Linux

References

Module	PixelStreaming
Header	/Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamerInputComponent.h
Include	#include "PixelStreamerInputComponent.h"
Source	/Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Private/PixelStreamerInputComponent.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="PixelStreamer Input")
void GetJsonStringValue
(
    FString Descriptor,
    FString FieldName,
    FString & StringValue,
    bool & Success
)

Remarks

Helper function to extract a string field from a JSON descriptor of a UI interaction given its field name. The field name may be hierarchical, delimited by a period. For example, to access the Width value of a Resolution command above you should use "Resolution.Width" to get the width value.

Parameters

Parameter	Description
Descriptor	The UI interaction JSON descriptor.
FieldName	The name of the field to look for in the JSON.
StringValue	The string value associated with the field name.
Success	True if the field exists in the JSON data.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss